blocks/spec-sheet
Type Aliases
Section titled “Type Aliases”SpecRulerProps
Section titled “SpecRulerProps”SpecRulerProps =
Omit<HTMLAttributes<HTMLDivElement>>,"children"> > &object
Props accepted by SpecRuler.
Type Declaration
Section titled “Type Declaration”label:
ReactNode
A short section label, such as 01 · Plans.
SpecFrameProps
Section titled “SpecFrameProps”SpecFrameProps =
Omit<HTMLAttributes<HTMLElement>>,"children"> > &object
Props accepted by SpecFrame.
Type Declaration
Section titled “Type Declaration”children
Section titled “children”children:
ReactNode
Caller-owned media, such as an img with its own alt text.
caption?
Section titled “caption?”
optionalcaption?:ReactNode
A short printed caption under the frame.
optionaltone?:"paper"|"ink"
ink seats dark media, such as a terminal readout, in the frame.
SpecFact
Section titled “SpecFact”SpecFact =
object
One fact in a SpecFacts strip.
Properties
Section titled “Properties”id:
string
value:
ReactNode
label:
ReactNode
SpecFactsProps
Section titled “SpecFactsProps”SpecFactsProps =
Omit<HTMLAttributes<HTMLDListElement>>,"children"> > &object
Props accepted by SpecFacts.
Type Declaration
Section titled “Type Declaration”facts: readonly
SpecFact[]
SpecStep
Section titled “SpecStep”SpecStep =
object
One step in a SpecSteps list.
Properties
Section titled “Properties”id:
string
title:
ReactNode
body:
ReactNode
SpecStepsProps
Section titled “SpecStepsProps”SpecStepsProps =
Omit<HTMLAttributes<HTMLOListElement>>,"children"> > &object
Props accepted by SpecSteps.
Type Declaration
Section titled “Type Declaration”steps: readonly
SpecStep[]
SpecFaqItem
Section titled “SpecFaqItem”SpecFaqItem =
object
One question in a SpecFaq list.
Properties
Section titled “Properties”id:
string
question
Section titled “question”question:
ReactNode
answer
Section titled “answer”answer:
ReactNode
Caller-reviewed answer content.
SpecFaqProps
Section titled “SpecFaqProps”SpecFaqProps =
Omit<HTMLAttributes<HTMLDivElement>>,"children"> > &object
Props accepted by SpecFaq.
Type Declaration
Section titled “Type Declaration”items: readonly
SpecFaqItem[]
defaultOpen?
Section titled “defaultOpen?”
optionaldefaultOpen?: readonlystring[]
Ids of the items that start open.
SpecDiagramMarker
Section titled “SpecDiagramMarker”SpecDiagramMarker =
object
One labelled part of a SpecDiagram, placed in percent of the art.
Properties
Section titled “Properties”id:
string
tag:
string
A short tag drawn on the art, such as A.
x:
number
Distance from the art’s left edge, 0 to 100.
y:
number
Distance from the art’s top edge, 0 to 100.
label:
ReactNode
optionalnote?:ReactNode
SpecDiagramProps
Section titled “SpecDiagramProps”SpecDiagramProps =
Omit<HTMLAttributes<HTMLElement>>,"children"> > &object
Props accepted by SpecDiagram.
Type Declaration
Section titled “Type Declaration”art:
ReactNode
Caller-owned art, such as an img with its own alt text.
markers
Section titled “markers”markers: readonly
SpecDiagramMarker[]
SpecPrintFilterProps
Section titled “SpecPrintFilterProps”SpecPrintFilterProps =
object
Props accepted by SpecPrintFilter.
Properties
Section titled “Properties”offset?
Section titled “offset?”
optionaloffset?:object
Misregistration of the second ink, in CSS pixels. Defaults to 2, 1.
x:
number
y:
number
Variables
Section titled “Variables”SpecRuler
Section titled “SpecRuler”
constSpecRuler:ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLDivElement>>,"children"> > &object&RefAttributes<HTMLDivElement>>>>
A tick-marked rule that separates sections, with crosshairs at both ends. It is decorative: the section heading carries the accessible name.
SpecFrame
Section titled “SpecFrame”
constSpecFrame:ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLElement>>,"children"> > &object&RefAttributes<HTMLElement>>>>
A figure seated in a hatched band, like a plate in a printed manual.
SpecFacts
Section titled “SpecFacts”
constSpecFacts:ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLDListElement>>,"children"> > &object&RefAttributes<HTMLDListElement>>>>
A ruled strip of short facts: a big value over a small label.
SpecSteps
Section titled “SpecSteps”
constSpecSteps:ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLOListElement>>,"children"> > &object&RefAttributes<HTMLOListElement>>>>
A numbered row of steps in ruled cells, numbered 01, 02 and on.
SpecFaq
Section titled “SpecFaq”
constSpecFaq:ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLDivElement>>,"children"> > &object&RefAttributes<HTMLDivElement>>>>
Questions and answers as native disclosures. It works without JavaScript, and every answer stays in the document for search and find-in-page.
SpecDiagram
Section titled “SpecDiagram”
constSpecDiagram:ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLElement>>,"children"> > &object&RefAttributes<HTMLElement>>>>
A manual-style parts diagram: tags drawn on the art and a legend that names each part. The legend is the accessible text; tags are decorative.
Functions
Section titled “Functions”SpecPrintFilter()
Section titled “SpecPrintFilter()”SpecPrintFilter(
__namedParameters):Element
The #caps-print SVG filter, rendered once per page. It turns 1-bit art (dark
ink on light paper) into the theme’s ink on a transparent ground, with a second
ink printed slightly off register underneath, like a two-drum risograph. Art
opts in through the theme’s --caps-print-filter; the inks come from
--caps-print-ink and --caps-print-offset.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Element