Button

Triggers an action or event, at the level of emphasis the action deserves.

Variants

Supported configurations for this component.

States

Interaction states covered by the API and the style contract.

Variants

6 examples
Default
sm
md
lg
Outline
sm
md
lg
Ghost
sm
md
lg
Destructive
sm
md
lg
With icon
sm
md
lg

States

6 examples
Hover
Rest
Hover
Focus visible
Rest
Focus visible
Disabled
Destructive focus
Rest
Destructive focus
Pressed (outline)
Rest
Pressed (outline)
Pressed (ghost)
Rest
Pressed (ghost)

Add to your project

One command adds this component to your project.

1

Run the following command. New project? Run npx shadcn@latest init first to set up Tailwind and path aliases.

npx shadcn@latest add @aicanvas/••••••••••••

Light and dark both come with the install and follow the dark class on <html>, the shadcn dark mode setup (next-themes with attribute="class").

Props

Every prop this component accepts. Any other prop is forwarded to the underlying element.

PropTypeDefaultDescription
variant'default'|'outline'|'ghost'|'destructive'|'link''default'One of: default, outline, ghost, destructive, link.
size'sm'|'md'|'lg''md'One of: sm, md, lg.
asChildbooleanfalseWhen true, renders the only child element with the button's props/styles.
iconReact.ComponentType<{ size?: number }>-Phosphor icon component rendered before children.
childrenReact.ReactNode-Content rendered inside the component.
classNamestring-Additional CSS classes applied to the root element.
styleReact.CSSProperties-Inline styles applied to the root element.
type'button'|'submit'|'reset''button'Native button type; defaults to 'button', so it does not submit an enclosing form unless set to 'submit'.
disabledboolean-When true, disables the control.
onClick(e: React.MouseEvent<HTMLButtonElement>) => void-Handler called when the element is clicked.

More Andromeda Pro components