@k8ordo/ui

Button

クリックで操作を実行するボタンです。colorとvariantで見た目を選びます。

インポート

ts
import { Button } from '@k8ordo/ui';

使い方

tsx
<Button variant="solid" color="primary">
  Click me
</Button>

バリアント

tsx
<Button variant="solid">Solid</Button>
<Button variant="outline">Outline</Button>
<Button variant="skeleton">Skeleton</Button>

色

tsx
<Button color="primary">Primary</Button>
<Button color="secondary">Secondary</Button>
<Button color="base">Base</Button>

サイズ

tsx
<Button size="sm">Small</Button>
<Button size="md">Medium</Button>
<Button size="lg">Large</Button>

アイコン付き

tsx
import { MailIcon, ChevronIcon } from '@k8ordo/ui/icons';

<Button startIcon={<MailIcon size="sm" />}>
  Send Email
</Button>
<Button endIcon={<ChevronIcon direction="right" size="sm" />}>
  Next
</Button>

全幅

tsx
<Button fullWidth>Full Width Button</Button>

無効

tsx
<Button disabled>Disabled</Button>

リンクへの差し替え

tsx
<Button
  renderItem={({ children, disabled: _disabled, type: _type, ...props }) => (
    <a href="https://example.com" {...props}>
      {children}
    </a>
  )}
>
  Visit
</Button>

Props

children?
Type: ReactNode
Default: -
color?
Type: 'primary'|'secondary'|'base'
Default: 'primary'
endIcon?
Type: ReactNode
Default: -
fullWidth?
Type: boolean
Default: false
isActive?
Type: boolean
Default: false
onAction?
Type: () => void | Promise<void>
Default: -
renderItem?
Type: (props: ButtonRenderItemProps) => ReactNode
Default: -
size?
Type: 'sm'|'md'|'lg'
Default: 'md'
startIcon?
Type: ReactNode
Default: -
type?
Type: 'button'|'submit'
Default: 'button'
variant?
Type: 'solid'|'outline'|'skeleton'
Default: 'solid'
PropTypeDefault
children?ReactNode-
color?'primary'|'secondary'|'base''primary'
endIcon?ReactNode-
fullWidth?booleanfalse
isActive?booleanfalse
onAction?() => void | Promise<void>-
renderItem?(props: ButtonRenderItemProps) => ReactNode-
size?'sm'|'md'|'lg''md'
startIcon?ReactNode-
type?'button'|'submit''button'
variant?'solid'|'outline'|'skeleton''solid'

継承する属性(内部で固定するものを除く): ComponentPropsWithRef<'button'>

k8ordo

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