Alpha: Ships on npm at 7.0.0-alpha.07.0.0-alpha.0
steps
Copy beside a numbered list of three to five steps.
Carried by the api-product Template. Seen on pages/harbor/home.json, section 9.
Count
{
"kind": "section",
"shell": {
"inset": "contained",
"density": "section"
},
"block": {
"type": "steps",
"head": {
"eyebrow": "How it works",
"title": "From berth to window."
},
"steps": [
"Name the berth",
"Give the draft",
"Read the window",
"Set an alert before it closes"
]
}
}
{
"title": "steps",
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "steps"
},
"head": {
"type": "object",
"properties": {
"eyebrow": {
"type": "string",
"minLength": 1,
"maxLength": 28
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 72
},
"lede": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"max": {
"type": "string",
"pattern": "^(none|\\d+(\\.\\d+)?(em|ch|px))$"
},
"ledeMax": {
"type": "string",
"pattern": "^(none|\\d+(\\.\\d+)?(em|ch|px))$"
},
"balance": {
"type": "boolean"
},
"scale": {
"type": "string",
"enum": [
"compact",
"large"
]
},
"tag": {
"type": "string",
"minLength": 1,
"maxLength": 8
},
"layout": {
"type": "string",
"enum": [
"split"
]
}
},
"required": [
"eyebrow"
],
"additionalProperties": false
},
"more": {
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 96
}
},
"steps": {
"minItems": 3,
"maxItems": 5,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 56
}
},
"specimen": {
"type": "object",
"properties": {
"panel": {
"type": "string",
"enum": [
"none",
"field"
]
},
"blocks": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"$ref": "#"
}
}
},
"required": [
"blocks"
],
"additionalProperties": false
}
},
"required": [
"type",
"head",
"steps"
],
"additionalProperties": false
}{
"kind": "section",
"shell": { "inset": "contained", "density": "section" },
"block": {
"type": "steps",
"head": { "eyebrow": "How it works", "title": "From berth to window." },
"steps": ["Name the berth", "Give the draft", "Read the window", "Set an alert before it closes"]
}
}Smallest that parses
{
"type": "steps",
"head": { "eyebrow": "How it works", "title": "From berth to window." },
"steps": ["Name the berth", "Give the draft", "Read the window"]
}Props
From @mdxui/site@7.0.0-alpha.0. A count reads as min–max × item; a string bound is its maximum length in characters, and links its refusal.
| Prop | Type and bound | Required |
|---|---|---|
head | object | yes |
head.eyebrow | string ≤28 | yes |
head.title | string ≤72 | no |
head.lede | string ≤300 | no |
head.max | string (pattern) | no |
head.ledeMax | string (pattern) | no |
head.balance | boolean | no |
head.scale | "compact" | "large" | no |
head.tag | string ≤8 | no |
head.layout | "split" | no |
more | 0–2 × string ≤96 | no |
steps | 3–5 × string ≤56 | yes |
specimen | object | no |
specimen.panel | "none" | "field" | no |
specimen.blocks | 1–3 × Section type (nested) | yes |
Use instead
text-stack: paragraphs with no order