FudaCardclass
<fuda-card>: a collectible card frame around a picture you give it (or a live 3D view), drawn with a true thickness, an edge, a back, foil or matte, a stack, wear and the three looks.
Every export of every entry point, each with its own page. This page keeps the addresses the old one-page reference had.
@johnmorrisdotca/fuda-cards/elementFudaCardclass<fuda-card>: a collectible card frame around a picture you give it (or a live 3D view), drawn with a true thickness, an edge, a back, foil or matte, a stack, wear and the three looks.
@johnmorrisdotca/fuda-cards/element/define@johnmorrisdotca/fuda-cards/live-3dAddOptionstypeWhat a card brings when it is added: the picture it already has.
createLiveCardsfunctionMake the live cards of a page.
LiveCardstypeThe live cards of a page: add a card, put one in focus, let go.
LiveCardsOptionstypeHow the live cards behave: the shared renderer's options (kazoku-ui's), and how long a turn takes, how long the pointer rests before a card goes live and how far ahead a still is made.
LiveItemtypeWhat a card shows in 3D: a key (items with the same key share their pictures) and a scene made from shared assets (assets.acquire).
LiveScenetypeA scene for a card: kazoku-ui's scene, with object, the thing that turns about its upright axis while the card is in focus.
@johnmorrisdotca/fuda-cards/collectionCollectionCardtypeOne item of a collection: an id, a name, the front's picture, optionally the back's, its kind and its metadata.
CollectionKindtypeWhat an item is.
collectionKindsconstantThe two kinds of item, card and object.
CollectionMetadatatypeWhat a collector writes about a card: its set, year, number, edition, condition, grade, quantity and notes.
CollectionViewtypeThe name of a display of <fuda-collection>: the view attribute's values.
collectionViewAliasesconstantDisplay names that earlier versions accepted and that now open another display, so a page that sets them keeps working.
collectionViewsconstantThe ten displays, in the order the buttons show them, each with the label on its button.
DeckLandingtypeHow a card taken off a pile lands on the pile at its side: still facing up, or turned over sideways (as a person turns a card, like a page) to show its back.
deckLandingsconstantThe two ways a card can land, with the label on each button: face-up (still facing up) and face-down (turned over sideways on the way).
fanLayoutfunctionWhere the cards of a fan lie: each card turns eleven degrees more than the one before, up to 110 degrees from the first to the last, centred on the pile.
FanPlacetypeWhere one card of a fan lies, first card on the left when open and on top when closed.
isCardfunctionWhether an item is a card: anything that does not say it is an object.
movePagefunctionThe first card of the page that is delta pages away, wrapping round at either end.
normalizeLandingfunctionThe landing a value means: face-down (also upside-down and turned-over) is turned over; anything else is still facing up.
parseCollectionfunctionCheck a collection and make it the shape the element draws: an array of cards, or an object with a cards array.
randomDrawIndexfunctionChoose a card whose name contains the filter, avoiding the current card when another match exists.
@johnmorrisdotca/fuda-cards/collection-elementCollectionLivetypeLive 3D in a collection's cards: the shared cards from createLiveCards and the 3D item of a card, if it has one.
FudaCollectionclass<fuda-collection>: a whole collection in one of ten displays (a deck, a rolodex, binder pages, a display case, a random draw, a story scroll, a gallery wall, a spotlight, a card table, a fan), with zoom, Fit and Centre, the choices kept in the page address and a card detail on a press.
@johnmorrisdotca/fuda-cardscardAttributesfunctionThe attributes of a <fuda-card> for these options, ready to set one by one (element.setAttribute(name, value)): names are the kebab-case of the option's, a true boolean is the empty string (the attribute is present) and a false one, like anything that is undefined or null, is left out.
CardFinishtypeA card's finish: foil catches the light and shows a rainbow in its frame, matte does not.
cardFinishesconstantThe two finishes, foil and matte.
cardMaterialfunctionThe material with this id.
CardMaterialtypeA card material: a stock or a metal with a thickness read from a maker or a standard, and the colour its edge is drawn in.
CardMaterialGrouptypeThe kind of stock a material is: plain paper card, plastic, a thick trading-card stock or metal.
cardMaterialsconstantEvery material the package knows, each with a thickness and the page it was read from.
CardMaterialSourcetypeWhere a number was read: the maker's or the standard's page, and what it says there.
CardOptionstypeEvery setting of <fuda-card> as an object.
CardVarianttypeA card's look: classic gold, silver sport or cosmic violet.
cardVariantsconstantThe three looks, in the order the studio offers them.
CornerKindtypeHow a corner is worn: sharp, softened, rounded, chipped or folded.
DEFAULT_CARD_THICKNESS_MMconstantThe thickness of a card that names no material or thickness: a playing card's black-core stock, 13 pt, 0.325 mm (Qin Printing, Black Core Paper 310 gsm, 0.325 mm).
mmPerPointconstantOne thousandth of an inch ("pt" in card and paper trade talk) in millimetres, 0.0254: a 13 pt card is 13 × 0.0254 mm.
stackHeightMmfunctionThe height of a stack of cards, in millimetres: the count times the thickness of one, to a thousandth of a millimetre.
stackLayoutfunctionWhere the cards of a stack lie, from neat to messy, the same every time for the same seed: the cards under the top one, bottom first, at most depth of them, as the top card is the live one and lies square.
StackLayoutOptionstypeHow a stack is laid out: how messy, from which seed and how many cards deep.
StackPlacetypeWhere one card of a stack lies, as the stack's layout says: how far it is nudged across and down, in card widths, and how far it is turned.
StackPresettypeA count of cards for a stack, with where the number comes from: a deck of 52, a Pokémon deck of 60, a booster pack of about 10.
stackPresetsconstantThe usual sizes of a stack of cards, each with where the number comes from.
VERSIONconstantThe version of this package, the same as package.json's (a test holds the two together).
WearCornertypeOne corner of a worn card: how it is worn and how far the damage reaches.
WearFeaturestypeEvery mark of a worn card: its corners, its centring, and the creases, scratches, specks and stain of each face.
wearLayoutfunctionWhere every mark of a card lies.
wearLevelsfunctionThe levels a card's wear asks for: the grade's or the number's, with any level named on its own laid over them.
WearLevelstypeHow much of each kind of wear, from 0 (none) to 1 (the worst the preset names).
WearOptionstypeWhat a card asks of its wear: a grade or a number, a seed, and any level on its own.
wearOutlinefunctionThe outline of a face as an SVG path in the 250 by 350 box, corners as worn.
wearOverlaySvgfunctionThe SVG laid over one face: whitening, folds, creases, scratches, specks, stain and toning.
wearPresetfunctionThe grade with this id.
WearPresettypeA grading term with the levels it stands for and what it means in a few words.
wearPresetsconstantThe seven grades, from perfect to damaged.