@fungi.computer/caps 0.0.0-stage → 0.0.1

package/docs/api/components/technonomicon.md

@@ -0,0 +1,773 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/caps**](../README.md)
+
+---
+
+[@fungi.computer/caps](../README.md) / components/technonomicon
+
+# components/technonomicon
+
+## Type Aliases
+
+### PlateProps
+
+```ts
+type PlateProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Plate.
+
+#### Type Declaration
+
+| Name      | Type        |
+| --------- | ----------- |
+| `caption` | `ReactNode` |
+| `image`   | `ReactNode` |
+| `label`   | `string`    |
+
+---
+
+### StagePlateProps
+
+```ts
+type StagePlateProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by StagePlate.
+
+#### Type Declaration
+
+| Name           | Type        | Description                                                              |
+| -------------- | ----------- | ------------------------------------------------------------------------ |
+| `caption`      | `ReactNode` | -                                                                        |
+| `children`     | `ReactNode` | The live drawing: an element with the `caps-stage-plate-viewport` class. |
+| `hint?`        | `ReactNode` | How to handle the drawing, shown under the caption.                      |
+| `hintId?`      | `string`    | Id for the hint, so the drawing can name it with aria-describedby.       |
+| `label`        | `string`    | -                                                                        |
+| `specimenKey?` | `ReactNode` | A numbered key to what the drawing shows.                                |
+
+---
+
+### CompactPlateProps
+
+```ts
+type CompactPlateProps = Omit<PlateProps, "className">;
+```
+
+Props accepted by CompactPlate.
+
+---
+
+### MarginNoteProps
+
+```ts
+type MarginNoteProps = object & HTMLAttributes<HTMLSpanElement>;
+```
+
+Props accepted by MarginNote.
+
+#### Type Declaration
+
+| Name       | Type        |
+| ---------- | ----------- |
+| `children` | `ReactNode` |
+
+---
+
+### CalloutKind
+
+```ts
+type CalloutKind = "lesson" | "status" | "plan" | "warning";
+```
+
+Supported editorial callout kinds.
+
+---
+
+### CalloutProps
+
+```ts
+type CalloutProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Callout.
+
+#### Type Declaration
+
+| Name       | Type                          |
+| ---------- | ----------------------------- |
+| `kind`     | [`CalloutKind`](#calloutkind) |
+| `title?`   | `ReactNode`                   |
+| `children` | `ReactNode`                   |
+
+---
+
+### GrowthStage
+
+```ts
+type GrowthStage = "spore" | "mycelium" | "fruiting";
+```
+
+Supported lifecycle stages.
+
+---
+
+### GrowthBadgeProps
+
+```ts
+type GrowthBadgeProps = object & HTMLAttributes<HTMLSpanElement>;
+```
+
+Props accepted by GrowthBadge.
+
+#### Type Declaration
+
+| Name    | Type                          |
+| ------- | ----------------------------- |
+| `stage` | [`GrowthStage`](#growthstage) |
+
+---
+
+### IssueMastheadProps
+
+```ts
+type IssueMastheadProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by IssueMasthead.
+
+#### Type Declaration
+
+| Name          | Type        | Description                                                  |
+| ------------- | ----------- | ------------------------------------------------------------ |
+| `date`        | `string`    | -                                                            |
+| `dek`         | `ReactNode` | -                                                            |
+| `number`      | `string`    | -                                                            |
+| `publication` | `string`    | The publication the Issue belongs to, printed in the kicker. |
+| `title`       | `string`    | -                                                            |
+
+---
+
+### MastheadSize
+
+```ts
+type MastheadSize = "front" | "running";
+```
+
+A newspaper nameplate: the front page's large head or a running head.
+
+---
+
+### MastheadProps
+
+```ts
+type MastheadProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Masthead.
+
+#### Type Declaration
+
+| Name        | Type                            | Description                                                            |
+| ----------- | ------------------------------- | ---------------------------------------------------------------------- |
+| `wordmark`  | `string`                        | The publication name, set large in the nameplate face.                 |
+| `href`      | `string`                        | Where the nameplate links, normally the front page.                    |
+| `mark?`     | `ReactNode`                     | A small printed mark beside the wordmark, such as a logo drawing.      |
+| `tagline?`  | `ReactNode`                     | One line under the wordmark in the publication's voice.                |
+| `edition?`  | readonly `ReactNode`[]          | The ruled edition line: date, issue, editor and similar items.         |
+| `startEar?` | `ReactNode`                     | The left ear box beside the nameplate, such as a weather note.         |
+| `endEar?`   | `ReactNode`                     | The right ear box beside the nameplate, such as the editor's portrait. |
+| `sections?` | `ReactNode`                     | The section bar under the edition line, normally a SectionBar.         |
+| `size?`     | [`MastheadSize`](#mastheadsize) | -                                                                      |
+
+---
+
+### SectionLink
+
+```ts
+type SectionLink = object;
+```
+
+One section of a publication.
+
+#### Properties
+
+##### href
+
+```ts
+href: string;
+```
+
+##### label
+
+```ts
+label: string;
+```
+
+##### marker?
+
+```ts
+optional marker?: string;
+```
+
+Printed before the label, such as a section letter.
+
+##### current?
+
+```ts
+optional current?: boolean;
+```
+
+##### shortcut?
+
+```ts
+optional shortcut?: string;
+```
+
+A keyboard shortcut announced through aria-keyshortcuts.
+
+---
+
+### SectionBarProps
+
+```ts
+type SectionBarProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by SectionBar.
+
+#### Type Declaration
+
+| Name       | Type                                     | Description                                                         |
+| ---------- | ---------------------------------------- | ------------------------------------------------------------------- |
+| `sections` | readonly [`SectionLink`](#sectionlink)[] | -                                                                   |
+| `tools?`   | `ReactNode`                              | Controls set at the end of the bar, such as theme and help buttons. |
+
+---
+
+### FolioProps
+
+```ts
+type FolioProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Folio.
+
+#### Type Declaration
+
+| Name    | Type                   | Description                                                   |
+| ------- | ---------------------- | ------------------------------------------------------------- |
+| `items` | readonly `ReactNode`[] | Running items, such as the publication, page number and date. |
+
+---
+
+### SpreadLayout
+
+```ts
+type SpreadLayout = "lead" | "columns" | "grid";
+```
+
+Supported editorial spread arrangements.
+
+---
+
+### SpreadProps
+
+```ts
+type SpreadProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by Spread.
+
+#### Type Declaration
+
+| Name       | Type                            |
+| ---------- | ------------------------------- |
+| `layout`   | [`SpreadLayout`](#spreadlayout) |
+| `children` | `ReactNode`                     |
+
+---
+
+### CardStat
+
+```ts
+type CardStat = object;
+```
+
+One supplied card measurement and its provenance. `null` means not measured.
+
+#### Properties
+
+##### key
+
+```ts
+key: string;
+```
+
+##### label
+
+```ts
+label: string;
+```
+
+##### value
+
+```ts
+value: string | number | null;
+```
+
+##### unit?
+
+```ts
+optional unit?: string;
+```
+
+##### source
+
+```ts
+source: string;
+```
+
+##### asOf
+
+```ts
+asOf: string;
+```
+
+---
+
+### CigaretteCardFinish
+
+```ts
+type CigaretteCardFinish = "standard" | "full-art";
+```
+
+Print finish: the rarer full-art card lets the drawing run under the text.
+
+---
+
+### CigaretteCardProps
+
+```ts
+type CigaretteCardProps = object;
+```
+
+Props accepted by CigaretteCard.
+
+#### Properties
+
+##### number
+
+```ts
+number: number;
+```
+
+##### seriesNumeral
+
+```ts
+seriesNumeral: string;
+```
+
+The series numeral printed on both faces and in the series mark, such as "I".
+
+##### series
+
+```ts
+series: string;
+```
+
+##### title
+
+```ts
+title: string;
+```
+
+##### typeLine?
+
+```ts
+optional typeLine?: string;
+```
+
+The type line beside the title, such as "Machine of the Burrow".
+
+##### image
+
+```ts
+image: ReactNode;
+```
+
+##### stats
+
+```ts
+stats: readonly CardStat[];
+```
+
+##### note
+
+```ts
+note: string;
+```
+
+##### finish?
+
+```ts
+optional finish?: CigaretteCardFinish;
+```
+
+##### setMark?
+
+```ts
+optional setMark?: ReactNode;
+```
+
+A small set symbol printed in the collector line.
+
+##### defaultFlipped?
+
+```ts
+optional defaultFlipped?: boolean;
+```
+
+##### href?
+
+```ts
+optional href?: string;
+```
+
+Makes the card a preview: a link to the card's own page showing its face,
+instead of a pressed button that turns over in place.
+
+##### size?
+
+```ts
+optional size?: "standard" | "large";
+```
+
+"large" prints the card bigger, for its own page.
+
+##### className?
+
+```ts
+optional className?: string;
+```
+
+##### style?
+
+```ts
+optional style?: CSSProperties;
+```
+
+Inline style on the card, such as a shared view-transition name.
+
+---
+
+### AlbumSlot
+
+```ts
+type AlbumSlot = object;
+```
+
+One numbered album position, optionally occupied by a card.
+
+#### Properties
+
+##### number
+
+```ts
+number: number;
+```
+
+##### card?
+
+```ts
+optional card?: CigaretteCardProps;
+```
+
+---
+
+### CardAlbumProps
+
+```ts
+type CardAlbumProps = object & HTMLAttributes<HTMLElement>;
+```
+
+Props accepted by CardAlbum.
+
+#### Type Declaration
+
+| Name    | Type                                 |
+| ------- | ------------------------------------ |
+| `title` | `string`                             |
+| `slots` | readonly [`AlbumSlot`](#albumslot)[] |
+
+## Functions
+
+### Plate()
+
+```ts
+function Plate(__namedParameters): Element;
+```
+
+A labelled graphite illustration plate.
+
+#### Parameters
+
+| Parameter           | Type                        |
+| ------------------- | --------------------------- |
+| `__namedParameters` | [`PlateProps`](#plateprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### StagePlate()
+
+```ts
+function StagePlate(__namedParameters): Element;
+```
+
+A plate whose illustration is a live pixel-art stage rather than an image. Its
+drawing reads `--specimen-ink`, `--specimen-paper` and `--specimen-accent`,
+which follow the theme.
+
+#### Parameters
+
+| Parameter           | Type                                  |
+| ------------------- | ------------------------------------- |
+| `__namedParameters` | [`StagePlateProps`](#stageplateprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### CompactPlate()
+
+```ts
+function CompactPlate(props): Element;
+```
+
+A compact plate for editorial teasers.
+
+#### Parameters
+
+| Parameter | Type                                      |
+| --------- | ----------------------------------------- |
+| `props`   | [`CompactPlateProps`](#compactplateprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### MarginNote()
+
+```ts
+function MarginNote(__namedParameters): Element;
+```
+
+An inline note styled for the page margin.
+
+#### Parameters
+
+| Parameter           | Type                                  |
+| ------------------- | ------------------------------------- |
+| `__namedParameters` | [`MarginNoteProps`](#marginnoteprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### Callout()
+
+```ts
+function Callout(__namedParameters): Element;
+```
+
+A labelled editorial aside.
+
+#### Parameters
+
+| Parameter           | Type                            |
+| ------------------- | ------------------------------- |
+| `__namedParameters` | [`CalloutProps`](#calloutprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### GrowthBadge()
+
+```ts
+function GrowthBadge(__namedParameters): Element;
+```
+
+An outlined Badge in the selected growth-stage color.
+
+#### Parameters
+
+| Parameter           | Type                                    |
+| ------------------- | --------------------------------------- |
+| `__namedParameters` | [`GrowthBadgeProps`](#growthbadgeprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### IssueMasthead()
+
+```ts
+function IssueMasthead(__namedParameters): Element;
+```
+
+The title, number, date, and dek for an Issue.
+
+#### Parameters
+
+| Parameter           | Type                                        |
+| ------------------- | ------------------------------------------- |
+| `__namedParameters` | [`IssueMastheadProps`](#issuemastheadprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### Masthead()
+
+```ts
+function Masthead(__namedParameters): Element;
+```
+
+A print masthead. Ears flank the nameplate on wide pages and sit under it on
+phones; the edition line runs between a thin and a heavy rule.
+
+#### Parameters
+
+| Parameter           | Type                              |
+| ------------------- | --------------------------------- |
+| `__namedParameters` | [`MastheadProps`](#mastheadprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### SectionBar()
+
+```ts
+function SectionBar(__namedParameters): Element;
+```
+
+A newspaper section bar: small capitals between hairline rules, the current
+section printed in reverse. It scrolls sideways on narrow pages instead of
+wrapping. Name it with aria-label.
+
+#### Parameters
+
+| Parameter           | Type                                  |
+| ------------------- | ------------------------------------- |
+| `__namedParameters` | [`SectionBarProps`](#sectionbarprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### Folio()
+
+```ts
+function Folio(__namedParameters): Element;
+```
+
+A running foot: the page's folio line between rules.
+
+#### Parameters
+
+| Parameter           | Type                        |
+| ------------------- | --------------------------- |
+| `__namedParameters` | [`FolioProps`](#folioprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### Spread()
+
+```ts
+function Spread(__namedParameters): Element;
+```
+
+A responsive editorial region with an explicit layout.
+
+#### Parameters
+
+| Parameter           | Type                          |
+| ------------------- | ----------------------------- |
+| `__namedParameters` | [`SpreadProps`](#spreadprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### CigaretteCard()
+
+```ts
+function CigaretteCard(__namedParameters): Element;
+```
+
+A two-sided collector card: a framed front with an inset drawing, a stat plate
+and a flavor line, and a ruled measurement ledger on the back. Both faces live
+inside one native pressed button, so the reverse stays in the DOM; the visible
+face names the button. Hydrated hosts flip through React state. Static hosts
+load the Caps `enhance/cigarette-card` module, which ignores clicks this
+component already handled. With `href` the card is a preview instead: a link to
+the card's own page that shows only its face.
+
+#### Parameters
+
+| Parameter           | Type                                        |
+| ------------------- | ------------------------------------------- |
+| `__namedParameters` | [`CigaretteCardProps`](#cigarettecardprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### CardAlbum()
+
+```ts
+function CardAlbum(__namedParameters): Element;
+```
+
+A numbered checklist of supplied cards and ruled spaces for missing ones.
+
+#### Parameters
+
+| Parameter           | Type                                |
+| ------------------- | ----------------------------------- |
+| `__namedParameters` | [`CardAlbumProps`](#cardalbumprops) |
+
+#### Returns
+
+`Element`