@k8ordo/ui

FileField

ファイルを選ぶ入力欄です。選ぶボタンとドロップ領域、選んだファイルの一覧を組み合わせて作ります。

インポート

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

使い方

tsx
<FileField.Root accept="image/*" multiple={false}>
  <FileField.Trigger
    renderItem={({ disabled, onClick }) => (
      <Button disabled={disabled} onClick={onClick}>
        Select File
      </Button>
    )}
  />
  <FileField.ItemList clearable />
</FileField.Root>

ドロップでの追加

FileField.Dropzoneにドロップしたファイルは、選んだときと同じように一覧と送信に加わります。フォームにはinputイベントで伝わります。中身を渡さないと、組み込みの案内と「ファイルを選択」のボタンが入るので、キーボードでも選べます。フォルダーのドロップは受け付けません。ブラウザがacceptで確かめるのは、選択ダイアログで選んだファイルだけです。ドロップしたファイルはFileFieldが同じ規則で確かめ、合わないものは加えません。

ここにファイルをドロップ

tsx
<FileField.Root accept="image/*" multiple>
  <FileField.Dropzone />
  <FileField.ItemList clearable />
</FileField.Root>

受け入れる種類

tsx
{/* Accept only PDF and Word documents */}
<FileField.Root accept=".pdf,.doc,.docx" multiple={false}>
  <FileField.Trigger
    renderItem={({ disabled, onClick }) => (
      <Button disabled={disabled} onClick={onClick}>
        Select Document
      </Button>
    )}
  />
  <FileField.ItemList clearable />
</FileField.Root>

複数ファイル

tsx
<FileField.Root maxFiles={3} multiple>
  <FileField.Trigger
    renderItem={({ disabled, onClick }) => (
      <Button disabled={disabled} onClick={onClick}>
        Select Files (max 3)
      </Button>
    )}
  />
  <FileField.ItemList clearable />
</FileField.Root>

無効

tsx
<FileField.Root disabled multiple={false}>
  <FileField.Trigger
    renderItem={({ disabled, onClick }) => (
      <Button disabled={disabled} onClick={onClick}>
        Select File
      </Button>
    )}
  />
  <FileField.ItemList clearable />
</FileField.Root>

エラー

tsx
<FileField.Root invalid multiple={false}>
  <FileField.Trigger
    renderItem={({ disabled, onClick }) => (
      <Button disabled={disabled} onClick={onClick}>
        Select File
      </Button>
    )}
  />
  <FileField.ItemList clearable />
</FileField.Root>

Props

FileField.Root

children?
Type: ReactNode
Default: -
defaultValue?
Type: File[]|string
Default: -
invalid?
Type: boolean
Default: false
maxFiles?
Type: number
Default: -
onChange?
Type: (files: FileList | null, event?: ChangeEvent<HTMLInputElement>) => void
Default: -
ref?
Type: Ref<HTMLInputElement>
Default: -
webkitDirectory?
Type: boolean
Default: false
PropTypeDefault
children?ReactNode-
defaultValue?File[]|string-
invalid?booleanfalse
maxFiles?number-
onChange?(files: FileList | null, event?: ChangeEvent<HTMLInputElement>) => void-
ref?Ref<HTMLInputElement>-
webkitDirectory?booleanfalse

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

FileField.Trigger

renderItem
Type: (props: { onClick: () => void; disabled: boolean; invalid: boolean; }) => ReactElement
Default: -
PropTypeDefault
renderItem(props: { onClick: () => void; disabled: boolean; invalid: boolean; }) => ReactElement-

FileField.ItemList

clearable?
Type: boolean
Default: -
showWebkitRelativePath?
Type: boolean
Default: -
PropTypeDefault
clearable?boolean-
showWebkitRelativePath?boolean-
k8ordo

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