Skip to main content
NetScriptdocs Search docs ⌘K v0.0.9
Browse documentation

IconButton

Accessible icon-only action button built on the shared Button seam.

All components · Theme builder · Implementation source

Live preview

Open live icon-button preview

Install

Shell
netscript ui:add icon-button

Usage and examples

The preview runs this JSX with the installed components. Import any composed primitives from your UI directory.

TypeScript
import { useState } from 'preact/hooks';
import { IconButton } from '@app/components/ui/icon-button.tsx';

export function Example() {
  const [value, setValue] = useState('standard');
  const [open, setOpen] = useState(false);
  const [notice, report] = useState('');
  return (<><div><IconButton icon="+" label="Create order" onClick={() => report("Order created")} /></div><p role="status">{notice}</p></>);
}

Props

Generated from native deno doc --json --private over the shipped implementation. Compound component props retain their owning interface; native attributes pass through where declared.

OwnerPropTypeOptionalDescription
SharedIconButtonPropsclassstringYes
SharedIconButtonPropsdisabledbooleanYes
SharedIconButtonPropsiconRenderableNo
SharedIconButtonPropslabelstringNo
SharedIconButtonPropsloadingbooleanYes
SharedIconButtonPropsvariantButtonVariantYes
IconButtonAsButtonPropstypeIconButtonElementTypeYes
IconButtonAsButtonPropshrefneverYes
IconButtonAsButtonPropsclientNavneverYes
IconButtonAsLinkPropstype"link"No
IconButtonAsLinkPropshrefstringNo
IconButtonAsLinkPropsclientNavbooleanYes

Keyboard

KeyAction
EnterActivate
SpaceActivate button; links use native Enter

Tokens

Semantic contract roles: border/default, border/hover, border/width, destructive/default, destructive/fg, destructive/hover, primary/default, primary/fg, primary/hover, radius/control, secondary/border, secondary/default, secondary/fg, text/fg, text/muted.

CSS custom properties referenced directly: Composed primitives supply their own tokens.

Contract and compatibility

Accessibility pattern: WAI-ARIA guidance

  • Native DOM attributes pass through where the implementation accepts them.

Design contract values marked planned are not implementation props. The props above describe what ships today.

Search all documentation

Type a term to search the documentation.