@k8ordo/ui

FileField

A file field, composed from a trigger, a dropzone and the list of chosen files.

Import

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

Usage

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>

Adding files by drop

Files dropped on FileField.Dropzone join the list and the submission just as picked ones do, and an input event tells the form. Left empty, it holds the built-in hint and a choose-files button, so it works by keyboard too. A dropped folder is not accepted. The browser checks accept only for files chosen in the picker, so FileField checks dropped files by the same rules and leaves out any that do not match.

Drop files here

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

Accepted types

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>

Multiple files

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>

Disabled

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

Invalid

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

Inherited attributes (except the ones set internally): 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

React libraries that use Baseline features without holding back.