API reference
components/field-guide
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/field-guide";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | KeycapProps | A visible keyboard key from a shortcut or instruction. |
| type alias | CartridgeLabelProps | Props accepted by CartridgeLabel. |
| type alias | SpecimenLabelProps | Props accepted by SpecimenLabel. |
| function | Keycap() | The shared field-guide treatment for a keyboard key. |
| function | CartridgeLabel() | A ruled, token-backed printed label for a physical game cartridge. |
| function | SpecimenLabel() | A caption, catalogue line, title, and note for a specimen illustration. |
KeycapPropstype alias
Section titled “KeycapProps”type KeycapProps = object & HTMLAttributes<HTMLElement>;A visible keyboard key from a shortcut or instruction.
Type Declaration
Section titled “Type Declaration”| Name | Type |
|---|---|
children |
ReactNode |
CartridgeLabelPropstype alias
Section titled “CartridgeLabelProps”type CartridgeLabelProps = object & HTMLAttributes<HTMLElement>;Props accepted by CartridgeLabel.
Type Declaration
Section titled “Type Declaration”| Name | Type |
|---|---|
title |
string |
subtitle? |
string |
mark? |
ReactNode |
SpecimenLabelPropstype alias
Section titled “SpecimenLabelProps”type SpecimenLabelProps = object & Omit<HTMLAttributes<HTMLElement>, "title">;Props accepted by SpecimenLabel.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
plate |
string |
- |
detail |
string |
- |
kind |
string |
- |
number |
string |
- |
title |
ReactNode |
- |
summary? |
ReactNode |
- |
sketch? |
boolean |
Mark the plate number for a pencil circle and the detail for a pencil underline. The ruled CSS marks remain until enhance/sketch draws them. |
Keycap()function
Section titled “Keycap()”function Keycap(__namedParameters): Element;The shared field-guide treatment for a keyboard key.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters |
KeycapProps |
Returns
Section titled “Returns”Element
CartridgeLabel()function
Section titled “CartridgeLabel()”function CartridgeLabel(__namedParameters): Element;A ruled, token-backed printed label for a physical game cartridge.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters |
CartridgeLabelProps |
Returns
Section titled “Returns”Element
SpecimenLabel()function
Section titled “SpecimenLabel()”function SpecimenLabel(__namedParameters): Element;A caption, catalogue line, title, and note for a specimen illustration.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
__namedParameters |
SpecimenLabelProps |
Returns
Section titled “Returns”Element