@k8ordo/ui

Icons

@k8ordo/ui/iconsのアイコンの一覧です。どれもaria-hiddenの<svg>で、名前は周りのボタンなどが持ちます。名前は用途でなく、描いてある形から付けています。

インポート

ts
import { CheckIcon, XIcon } from '@k8ordo/ui/icons';

サイズ

xs

sm

md

lg

xl

2xl

3xl

tsx
<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 */}

使い方

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

自分のアイコン

ロゴはここにありません。ロゴや、ここに無い絵はBaseIconの上に描きます。sizeの刻みとaria-hiddenが、ほかのアイコンと同じになります。

tsx
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

アイコンは共通でsizeを受け取ります。向きを持つChevronIconと、ステータスを表すAlertIconには追加のpropsがあります。BaseIconはrenderItemに渡した<svg>へ、大きさのクラスとaria-hiddenを渡します。

size?
Type: 'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl'
Default: 'md'
PropTypeDefault
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'
PropTypeDefault
directionDirection-
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'
PropTypeDefault
statusStatus-
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: -
PropTypeDefault
renderItem(arg: IconRenderProps) => ReactNode-
size'xs'|'sm'|'md'|'lg'|'xl'|'2xl'|'3xl'-
k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。