Components
Reveal
Reveal documentation for Honeydeck.
Reveal
Use <Reveal> when content should appear at the next timeline step.
import { Reveal } from '@honeydeck/honeydeck'
<Reveal>Start with Markdown</Reveal>
<Reveal>Enhance with React</Reveal>
<Reveal>Export to PDF</Reveal>Reveals are cumulative: once visible, they stay visible while you advance through the slide. Hidden reveal content reserves layout space, so the slide does not jump when the content appears.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
children | ReactNode | — | Content to reveal. |
name | string | — | Optional slide-local target for RevealWith target="...". Must be a literal non-empty string. |
className | string | — | Custom class for styling or transitions. |
at | number | injected | Timeline step. Honeydeck injects this during compilation; author-authored values are build errors. Use RevealWith to sync with an existing step. |
as | "div" | "span" | injected | Wrapper element. Honeydeck injects this to keep valid MDX/HTML around block or inline content. |
Behavior
- Reveals fade in.
- Hidden content uses
visibility: hiddenplusopacity: 0, notdisplay: none. - Nested reveals are supported.
- Inline reveals inside paragraphs render inline wrappers.
- Optional
name="..."creates a slide-local target forRevealWith.
See Steps and reveals for timeline ordering examples.