GitHub

action.start

Begins the main flow a page exists for: get started, sign up, try it

Component

<Action>

Renders

<a>

Profile

UI
View as Markdown

Action intents

Example

Preview
defaultdisabled
<Action intent="action.start" href="/somewhere">Start</Action>

Code that says start, signup, try, join, claim 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

  • Begins the main flow a page exists for: get started, sign up, try it

    action.start this page

  • Secondary links to other pages

    action.navigate

  • The main thing a page asks you to do

    rather than action.guide
    action.start this page

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.

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.start 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.primary

    Filled, highest emphasis

    rounded-full bg-primary font-medium text-primary-foreground
hover:bg-primary/90
  • action.start

    Begins the main flow a page exists for: get started, sign up, try it

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-primary font-medium
text-primary-foreground hover:bg-primary/90
Definition
TS
'action.start': {
  kind: 'semantic',
  description: 'Begins the main flow a page exists for: get started, sign up, try it',
  refs: ['control.primary'],
  keywords: ['start', 'signup', 'try', 'join', 'claim'],
  notFor: [
    {
      context: 'secondary links to other pages',
      instead: 'action.navigate',
    },
  ],
},