Skip to content
sdocs

Everything

Every block the language has, on one page — [NOTES] in all six types, a nested [TODO], [PROSE] before and after the components, a [COMPONENTS] strip carrying all six statuses plus one with none, and examples that carry their own blocks.

Being replaced by ActionButton in v4.

Re-renders every child on a `tone` change, snippets included.

Pair it with Field when it labels an input.

Ships in the 4.2 release.

A note with no type at all, which ranks above `tip` and `info`.

Todo 2/6

Prose before the components

This block renders before the tab strip because that is where it was written. It has everything a [DOC] body has — emphasis, code, links, lists, tables and fences:

StatusWaits on
reviewa person
experimentalreal use
<Meter value={64} max={100} label="Docs coverage" />

Note

GitHub-style alerts work here too.

Block description only — this component has no @component comment of its own.

Props

Name
Details
Default
Control
summary*
string
Default
Control
Heading shown in the toggle row
open
boolean
Default false
Control
Start expanded

Events

Name
Details
ontoggle
(open: boolean) => void
Called when the panel opens or closes

Snippets

Name
Details
marker
Snippet<[open: boolean]>
Custom marker; receives the open state
children
Snippet
Panel content

Terms

Words this page uses, defined once.

Stage
the isolated frame a preview renders in, carrying the project's own css.
Measure
the width of a line of text, counted in characters — capped at ~70 here.
Entity
one [SHOWCASE], [DOC], [PAGE] or [LAYOUT]; each is a route.
Flow
what an entity shows, in the order it was written.
Silhouette
the outline of a glyph, which is all that survives at 13px.

Abbreviations

a11y
accessibility — thirteen letters between the a and the y.
wip
work in progress.

Prose after the components

And this one renders after the strip, before the examples — source order, with the tab strip counting as a single item however many tabs it holds.


Examples

Carries its own blocks

Open this example on its own page to see them.

Todo 1/2

An example's prose is markdown only — no Svelte islands, since it is a caption on a stage rather than a page of its own.

  • notes
  • todo
  • prose

Plain example

Nothing but a description and a stage.