Docyrus Icon

Docyrus Icon component with multiple variants and sizes.

Client Only

Installation

pnpm dlx @docyrus/cli add @docyrus/ui-docyrus-icon
Required Packages(1 package)
pnpm add react-inlinesvg

Usage

import {
  DocyrusIcon
} from "@docyrus/ui/components/docyrus-icon";

<DocyrusIcon
  size="xs"
  animation="none"
  icon="..."
  lib="..."
  group={...}
/>

Sizes

SizeDescription
xsExtra small — size-3
smSmall — size-4
defaultDefault — size-5
lgLarge — size-6
xlExtra large — size-8

Animation

AnimationDescription
noneDefault (no animation)
spinSpin — animate-spin
pulsePulse — animate-pulse
bounceBounce — animate-bounce
pingPing — animate-ping

API Reference

PropTypeDefault
size"xs" | "sm" | "default" | "lg" | "xl""default"
animation"none" | "spin" | "pulse" | "bounce" | "ping""default"
iconstring—
libstring—
groupstring | null—
classNamestring—

On this page