layout.toast

A short message that appears over the page and leaves on its own, sometimes with one action: saved, could not send, undo. Holds one feedback.* line and at most one action

Component

<Layout>

Renders

<div>

Role

status

Profile

Comes from

starter

View as Markdown

Example

Preview

Project archived.

<Layout intent="layout.toast">
  <Text intent="feedback.success">Project archived.</Text>
  <Action intent="action.command" verb="undo" onClick={undo}>Undo</Action>
</Layout>

Choosing between neighbours

Find the row that describes your element, and use the intent on the right.

If it is
Use
A short message that appears over the page and leaves on its own, sometimes with one action: saved, could not send, undo. Holds one feedback.* line and at most one action
layout.toast this page
A message that stays on the page until dismissed
layout.notice

Connections

Declared in the registry, both directions. Where an intent is used in your own code is something check and the gallery see; this site has no app code.

Built from
surface.panelarrange.row

For registry authors

Starter intents. These are the intents prongs add puts in your registry, shown in this site’s theme. Yours are your own registry.ts: rename, restyle and add to them, and see them with prongs add gallery.

What this intent is built from and its entry in components/prongs/registry.ts. You only need this to change how it looks or to add an intent like it.

How layout.toast resolves, and its definition

Each layer adds to the one before it; a later class wins over an earlier one that sets the same thing.

surface.panel
Bordered box, one level above what it sits in
```
surface rounded-lg border border-surface-border
```
arrange.row
Children in a wrapping row
```
flex flex-row flex-wrap items-center
```
layout.toast
A short message that appears over the page and leaves on its own, sometimes with one action: saved, could not send, undo. Holds one feedback.* line and at most one action
```
fixed bottom-4 right-4 z-50 flex-nowrap items-center gap-3 px-4
py-3 shadow-lg
```

Final classes

surface rounded-lg border border-surface-border flex flex-row
fixed bottom-4 right-4 z-50 flex-nowrap items-center gap-3 px-4
py-3 shadow-lg

Definition

'layout.toast': {
  kind: 'semantic',
  description: 'A short message that appears over the page and leaves on its own, sometimes with one action: saved, could not send, undo. Holds one feedback.* line and at most one action',
  refs: ['surface.panel', 'arrange.row'],
  binding: {
    ariaRole: 'status',
    classes: 'fixed bottom-4 right-4 z-50 flex-nowrap items-center gap-3 px-4 py-3 shadow-lg',
  },
  notFor: [
    {
      context: 'a message that stays on the page until dismissed',
      instead: 'layout.notice',
    },
  ],
},