Icon

SVG icon wrapper with currentColor styling.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Icon } from "@tavojs/ui/icon";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/icon.

When to use

Use it when

Use `Icon` as a simple SVG wrapper

Choose something else when

Avoid Icon when replacing interactive controls with content-only components.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Icon example

TSXCreate: src/components/examples/IconExample1.tsx

tsximport { Icon } from "@tavojs/ui/icon";

export function IconExample1() {
  return (
    <>
      <Icon viewBox="0 0 24 24" aria-hidden="true"><path d="M12 5v14M5 12h14" fill="none" stroke="currentColor" stroke-width="2" /></Icon>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`width`	`number`	—	Configures width for this component.
`height`	`number`	—	Configures height for this component.
`viewBox`	`string`	—	Configures viewBox for this component.
`component`	`Component<Record<string, unknown>>`	—	Configures component for this component.
`sx`	`Sx`	—	Configures sx for this component.

Complete TypeScript API

Import from @tavojs/ui/icon. Published exports: Icon, IconProps.

`IconProps`

Property	Type	Required	Description
`children`	`unknown`	No	Inherited children attribute accepted by Icon.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`component`	`Component<Record<string, unknown>>`	No	Configures component for this component.
`sx`	`Sx`	No	Configures sx for this component.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Icon.
`width`	`string \| number`	No	Configures width for this component.
`height`	`string \| number`	No	Configures height for this component.
`viewBox`	`string`	No	Configures viewBox for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Icon when replacing interactive controls with content-only components.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Add `aria-hidden` for decorative icons or a label for meaningful ones.

Add `aria-hidden` for decorative icons or a label for meaningful ones.

Component status

Contract	Current value
Maturity	stable
Category	content
Component import	`@tavojs/ui/icon`
Explicit CSS import	`@tavojs/ui/css/icon`
Preview	Interactive preview available on this page