Skip to content
GaudiGaudi Design System home

Search documentation

Search every page, heading and paragraph.

Icon

Static and interactive artwork from Gaudi’s centralized icon registry.

CoreBasics@gaudi/design-system/core/IconView in StorybookSource

AnimatedIcon adds opt-in motion with shared size and color tokens, a searchable catalogue, and host-controlled activation.

Installation

pnpm add github:ahmadassaf/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import Icon from '@gaudi/design-system/core/Icon';

Copy an example into your project with the shadcn CLI: npx shadcn@latest add https://design.gaudi.site/r/icon-stack-in-context.json.

Usage

import { Icon } from '@gaudi/design-system';
<Icon name='Info' label='More information' color='primary' size='lg' />

Examples

In an empty state and list row

Storybook

Sizes, colors and badge

Storybook

In a card, list row and empty state

Storybook

Tones

Storybook

Variants, sizes and shapes

Storybook

API

10 props

Accessibility

Decorative icons are hidden from assistive technology. Informative or icon-only links need a readable label.