action.guide

The quieter call to action beside the main one, opening the guide to it: get started, read the docs

Component

<Action>

Renders

<button>

Profile

View as Markdown

Action intents

Example

Preview

defaultpresseddisabled

<Action intent="action.guide" onClick={guideItem}>Guide</Action>

Code that says guide, docs, tutorial points here. prongs check warns when an element with this intent has a handler or label that points somewhere else.

Choosing between neighbours

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

If it is
Use
The quieter call to action beside the main one, opening the guide to it: get started, read the docs
action.guide this page
The main thing a page asks you to do
action.start
A link inside text
action.navigate

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
control.secondary

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 action.guide 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.

control.base

Shape and behaviour shared by every button

inline-flex shrink-0 items-center justify-center gap-2
whitespace-nowrap rounded-md px-4 py-2 text-sm transition-colors
focus-visible:outline-none focus-visible:ring-2
focus-visible:ring-ring focus-visible:ring-offset-2
ring-offset-surface disabled:pointer-events-none
disabled:opacity-50 aria-disabled:pointer-events-none
aria-disabled:opacity-50

control.secondary

Filled, lower emphasis; shows a pressed state

rounded-full bg-secondary font-medium text-secondary-foreground
hover:bg-secondary/80 aria-pressed:bg-foreground
aria-pressed:text-background

action.guide
The quieter call to action beside the main one, opening the guide to it: get started, read the docs

Final classes

inline-flex shrink-0 items-center justify-center gap-2
whitespace-nowrap px-4 py-2 text-sm transition-colors
focus-visible:outline-none focus-visible:ring-2
focus-visible:ring-ring focus-visible:ring-offset-2
ring-offset-surface disabled:pointer-events-none
disabled:opacity-50 aria-disabled:pointer-events-none
aria-disabled:opacity-50 rounded-full bg-secondary font-medium
text-secondary-foreground hover:bg-secondary/80
aria-pressed:bg-foreground aria-pressed:text-background

Definition

'action.guide': {
  kind: 'semantic',
  description: 'The quieter call to action beside the main one, opening the guide to it: get started, read the docs',
  refs: ['control.secondary'],
  keywords: ['guide', 'docs', 'tutorial'],
  notFor: [
    {
      context: 'the main thing a page asks you to do',
      instead: 'action.start',
    },
    { context: 'a link inside text', instead: 'action.navigate' },
  ],
},