Steps. An ordered sequence of titled instructions.
- Article structure
- Static
- Stability · Initial
- ::postkit-steps
Install
Add the React package.Provide
Connect Postkit to your Chakra system.Publish
Render the same content wherever it belongs.
Usage.
<Steps
items='[{"title":"Install","description":"Add the React package."},{"title":"Provide","description":"Connect Postkit to your Chakra system."},{"title":"Publish","description":"Render the same content wherever it belongs."}]'
/>Props. Always in step with the code.
| Prop | Type | Default | Description |
|---|---|---|---|
| itemsRequired | JSON string | None | A JSON array of step titles and descriptions. |
| Appearance | |||
| size | "sm" | "md" | "lg" | "md" | The component density and type scale. |
| variant | "outline" | "subtle" | "plain" | "subtle" | The component visual treatment. |
Every component also takes unstyled and the part-styling props. Change a default for your whole site with defaults in createPostkit. Part styles
Anatomy. Every part is yours to restyle.
Every part
- root
- item
- marker
- content
- title
- description
Renderers. One component, everywhere you publish.
- Headless @postkit/reactSupported
- Chakra @postkit/chakraSupported
- Email @postkit/emailSupported
- Astro @postkit/astroStatic
- Web components @postkit/elementsPlanned