Icons
The icons in @k8ordo/ui/icons. Each is an aria-hidden <svg>, and the control around it carries the name. An icon is named for the shape it draws, not for a use.
Import
import { CheckIcon, XIcon } from '@k8ordo/ui/icons';Sizes
xs
sm
md
lg
xl
2xl
3xl
<CheckIcon size="xs" /> {/* 12px */}
<CheckIcon size="sm" /> {/* 16px */}
<CheckIcon size="md" /> {/* 24px (default) */}
<CheckIcon size="lg" /> {/* 32px */}
<CheckIcon size="xl" /> {/* 40px */}
<CheckIcon size="2xl" /> {/* 48px */}
<CheckIcon size="3xl" /> {/* 56px */}Usage
ArrowDownIcon
ArrowLeftIcon
ArrowRightIcon
ArrowUpIcon
BellIcon
BlendIcon
BookTextIcon
BookmarkIcon
BotIcon
BotMessageIcon
CalendarIcon
CheckIcon
ChevronDownIcon
ChevronLeftIcon
ChevronRightIcon
ChevronUpIcon
ChevronsUpDownIcon
CircleAlertIcon
CircleCheckIcon
CircleHelpIcon
CircleXIcon
ClipboardCheckIcon
ClockIcon
CodeIcon
ColorScaleIcon
ContrastIcon
CopyIcon
DownloadIcon
EllipsisIcon
EllipsisVerticalIcon
ExternalLinkIcon
EyeClosedIcon
EyeIcon
FileIcon
FileTextIcon
FilterIcon
FlaskIcon
FolderIcon
FolderOpenIcon
GitForkIcon
GitPullRequestIcon
GlobeIcon
GridIcon
GripVerticalIcon
HeartIcon
HistoryIcon
HomeIcon
ImageIcon
InfoIcon
LightbulbIcon
LinkIcon
ListIcon
LockIcon
LockOpenIcon
LogInIcon
LogOutIcon
MailIcon
MapPinIcon
MaximizeIcon
MenuIcon
MessageCircleIcon
MinimizeIcon
MinusIcon
MonitorIcon
MoonIcon
PackageIcon
PaintBucketIcon
PaletteIcon
PanelLeftIcon
PaperclipIcon
PauseIcon
PencilIcon
PinIcon
PlayIcon
PlusIcon
PresentationIcon
RedoIcon
RefreshIcon
RocketIcon
RssIcon
SearchIcon
SendIcon
SettingsIcon
ShareIcon
ShieldCheckIcon
SmileIcon
SparklesIcon
SquareIcon
SquircleIcon
StarIcon
SunIcon
TableIcon
TagIcon
TextHorizontalIcon
TextVerticalIcon
ThumbsDownIcon
ThumbsUpIcon
TrashIcon
TriangleAlertIcon
UndoIcon
UploadIcon
UserIcon
UsersIcon
XIcon
Your own icons
There are no logos here. Draw a logo, or any shape this set lacks, on BaseIcon. It gets the same size steps and the same aria-hidden as the other icons.
import { BaseIcon } from '@k8ordo/ui/icons';
import type { BaseIconProps } from '@k8ordo/ui/icons';
export const DotIcon = ({ size = 'md' }: Partial<BaseIconProps>) => (
<BaseIcon
renderItem={(props) => (
<svg {...props} fill="currentColor" viewBox="0 0 16 16">
<circle cx="8" cy="8" r="5" />
</svg>
)}
size={size}
/>
);Props
Icons share a size prop. ChevronIcon (direction) and AlertIcon (status) take additional props. BaseIcon hands the size class and aria-hidden to the <svg> you return from renderItem.
size?- Type:
'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' - Default:
'md'
| Prop | Type | Default |
|---|---|---|
size? | 'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' | 'md' |
ChevronIcon
direction- Type:
Direction - Default: -
size?- Type:
'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' - Default:
'md'
| Prop | Type | Default |
|---|---|---|
direction | Direction | - |
size? | 'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' | 'md' |
AlertIcon
status- Type:
Status - Default: -
size?- Type:
'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' - Default:
'md'
| Prop | Type | Default |
|---|---|---|
status | Status | - |
size? | 'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' | 'md' |
BaseIcon
renderItem- Type:
(arg: IconRenderProps) => ReactNode - Default: -
size- Type:
'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' - Default: -
| Prop | Type | Default |
|---|---|---|
renderItem | (arg: IconRenderProps) => ReactNode | - |
size | 'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl' | - |