components/field-guide
Type Aliases
Section titled “Type Aliases”KeycapProps
Section titled “KeycapProps”KeycapProps =
object&HTMLAttributes<HTMLElement>>
A visible keyboard key from a shortcut or instruction.
Type Declaration
Section titled “Type Declaration”children
Section titled “children”children:
ReactNode
StatusLedTone
Section titled “StatusLedTone”StatusLedTone =
"spore"|"mycelium"|"fruiting"
Semantic accent pigments for the static status light.
StatusLedProps
Section titled “StatusLedProps”StatusLedProps =
object&Omit<HTMLAttributes<HTMLSpanElement>>,"children">>
Props accepted by StatusLed.
Type Declaration
Section titled “Type Declaration”active
Section titled “active”active:
boolean
label:
string
optionaltone?:StatusLedTone
CartridgeLabelProps
Section titled “CartridgeLabelProps”CartridgeLabelProps =
object&HTMLAttributes<HTMLElement>>
Props accepted by CartridgeLabel.
Type Declaration
Section titled “Type Declaration”title:
string
subtitle?
Section titled “subtitle?”
optionalsubtitle?:string
optionalmark?:ReactNode
SpecimenLabelProps
Section titled “SpecimenLabelProps”SpecimenLabelProps =
object&Omit<HTMLAttributes<HTMLElement>>,"title">>
Props accepted by SpecimenLabel.
Type Declaration
Section titled “Type Declaration”plate:
string
detail
Section titled “detail”detail:
string
kind:
string
number
Section titled “number”number:
string
title:
ReactNode
summary?
Section titled “summary?”
optionalsummary?:ReactNode
sketch?
Section titled “sketch?”
optionalsketch?: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.
Functions
Section titled “Functions”Keycap()
Section titled “Keycap()”Keycap(
__namedParameters):Element
The shared field-guide treatment for a keyboard key.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element
StatusLed()
Section titled “StatusLed()”StatusLed(
__namedParameters):Element
A static, labelled indicator using the current field-guide pigment tokens.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element
CartridgeLabel()
Section titled “CartridgeLabel()”CartridgeLabel(
__namedParameters):Element
A ruled, token-backed printed label for a physical game cartridge.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element
SpecimenLabel()
Section titled “SpecimenLabel()”SpecimenLabel(
__namedParameters):Element
A caption, catalogue line, title, and note for a specimen illustration.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element