Dropzone

Dropzoneは、ファイルをドラッグアンドドロップでアップロードするために使用されるコンポーネントです。

Drag file here or click to select file

<Dropzone.Root>
  <Text>Drag file here or click to select file</Text>
</Dropzone.Root>

使い方

import { Dropzone } from "@yamada-ui/react"

import { Dropzone } from "@/components/ui"

import { Dropzone } from "@workspaces/ui"

<Dropzone.Root>
  <Dropzone.Title />
  <Dropzone.Description />
  <Dropzone.Accept>
    <Dropzone.Icon />
  </Dropzone.Accept>
  <Dropzone.Reject>
    <Dropzone.Icon />
  </Dropzone.Reject>
  <Dropzone.Idle>
    <Dropzone.Icon />
  </Dropzone.Idle>
</Dropzone.Root>

Dropzoneは、内部でreact-dropzoneを使用しています。

バリアントを変更する

Drag file here or click to select file

<VStack>
  <For each={["dashed", "solid", "panel"]}>
    {(variant, index) => (
      <Dropzone.Root key={index} variant={variant}>
        <Text>Drag file here or click to select file</Text>
      </Dropzone.Root>
    )}
  </For>
</VStack>

サイズを変更する

Drag file here or click to select file

<VStack>
  <For each={["xs", "sm", "md", "lg"]}>
    {(size, index) => (
      <Dropzone.Root key={index} size={size}>
        <Text>Drag file here or click to select file</Text>
      </Dropzone.Root>
    )}
  </For>
</VStack>

複数選択を許容する

複数選択を許容する場合は、multipleをtrueに設定します。

Drag files here or click to select files

<Dropzone.Root multiple>
  <Text>Drag files here or click to select files</Text>
</Dropzone.Root>

拡張子を指定する

拡張子を指定する場合は、acceptに文字列の配列または、オブジェクトを設定します。

また、acceptを簡単に指定できるIMAGE_ACCEPT_TYPEやPDF_ACCEPT_TYPEなどを提供しています。

Drag image here or click to select image

<VStack>
  <Dropzone.Root accept={Dropzone.IMAGE_ACCEPT_TYPE}>
    <Text>Drag image here or click to select image</Text>
  </Dropzone.Root>

  <Dropzone.Root accept={{ "image/*": [] }}>
    <Text>Drag image here or click to select image</Text>
  </Dropzone.Root>
</VStack>

ファイルサイズの最大値を指定する

ファイルサイズの最大値を指定する場合は、maxSizeに数値(バイト)を設定します。

Drag file here or click to select file

Attach as many files as you like, each file should not exceed 5mb

<Dropzone.Root maxSize={3 * 1024 ** 2}>
  <VStack alignItems="center" gap="xs">
    <Dropzone.Title>Drag file here or click to select file</Dropzone.Title>
    <Dropzone.Description>
      Attach as many files as you like, each file should not exceed 5mb
    </Dropzone.Description>
  </VStack>
</Dropzone.Root>

アップロード可能な最大数を指定する

アップロード可能な最大数を指定する場合は、maxFilesに数値を設定します。

Drag file here or click to select file

Attach as many files as you like, can upload up to 3 files

<Dropzone.Root maxFiles={3} multiple>
  <VStack alignItems="center" gap="xs">
    <Dropzone.Title>Drag file here or click to select file</Dropzone.Title>
    <Dropzone.Description>
      Attach as many files as you like, can upload up to 3 files
    </Dropzone.Description>
  </VStack>
</Dropzone.Root>

状態に応じた表示をする

ファイルを受け入れたか、拒否されたかの状態に応じて、表示を制御する場合は、DropzoneAccept, DropzoneReject, DropzoneIdleを使用します。

DropzoneAccept: ファイルが受け入れられたときに表示されるコンポーネントです。
DropzoneReject: ファイルが拒否されたときに表示されるコンポーネントです。
DropzoneIdle: アイドル状態のときに表示されるコンポーネントです。

Drag images here or click to select files

Attach as many files as you like, each file should not exceed 5mb

<Dropzone.Root accept={Dropzone.IMAGE_ACCEPT_TYPE} maxSize={3 * 1024 ** 2}>
  <HStack>
    <Dropzone.Accept>
      <Dropzone.Icon as={UploadIcon} />
    </Dropzone.Accept>

    <Dropzone.Reject>
      <Dropzone.Icon as={XIcon} />
    </Dropzone.Reject>

    <Dropzone.Idle>
      <Dropzone.Icon as={ImageIcon} />
    </Dropzone.Idle>

    <VStack gap="xs">
      <Dropzone.Title>Drag images here or click to select files</Dropzone.Title>
      <Dropzone.Description>
        Attach as many files as you like, each file should not exceed 5mb
      </Dropzone.Description>
    </VStack>
  </HStack>
</Dropzone.Root>

ドロップされたイベントをハンドルする

ドロップされたイベントをハンドルする場合は、onDropを使用します。

ドロップされたファイルが受け入れられたか拒否されたかに関係なく、常に呼び出されることに注意してください。

Drag images here or click to select files

Attach as many files as you like, each file should not exceed 5mb

<Dropzone.Root
  accept={Dropzone.IMAGE_ACCEPT_TYPE}
  maxSize={3 * 1024 ** 2}
  onDrop={(acceptedFiles, fileRejections) =>
    console.log("dropped", acceptedFiles, fileRejections)
  }
>
  <HStack>
    <Dropzone.Accept>
      <Dropzone.Icon as={UploadIcon} />
    </Dropzone.Accept>

    <Dropzone.Reject>
      <Dropzone.Icon as={XIcon} />
    </Dropzone.Reject>

    <Dropzone.Idle>
      <Dropzone.Icon as={ImageIcon} />
    </Dropzone.Idle>

    <VStack gap="xs">
      <Dropzone.Title>Drag images here or click to select files</Dropzone.Title>
      <Dropzone.Description>
        Attach as many files as you like, each file should not exceed 5mb
      </Dropzone.Description>
    </VStack>
  </HStack>
</Dropzone.Root>

受け入れられたファイルのみをハンドルする

受け入れられたファイルのみをハンドルする場合は、onDropAcceptedを使用します。

Drag images here or click to select files

Attach as many files as you like, each file should not exceed 5mb

<Dropzone.Root
  accept={Dropzone.IMAGE_ACCEPT_TYPE}
  maxSize={3 * 1024 ** 2}
  onDropAccepted={(files) => console.log("accepted", files)}
>
  <HStack>
    <Dropzone.Accept>
      <Dropzone.Icon as={UploadIcon} />
    </Dropzone.Accept>

    <Dropzone.Reject>
      <Dropzone.Icon as={XIcon} />
    </Dropzone.Reject>

    <Dropzone.Idle>
      <Dropzone.Icon as={ImageIcon} />
    </Dropzone.Idle>

    <VStack gap="xs">
      <Dropzone.Title>Drag images here or click to select files</Dropzone.Title>
      <Dropzone.Description>
        Attach as many files as you like, each file should not exceed 5mb
      </Dropzone.Description>
    </VStack>
  </HStack>
</Dropzone.Root>

拒否されたファイルのみをハンドルする

拒否されたファイルのみをハンドルする場合は、onDropRejectedを使用します。

Drag images here or click to select files

Attach as many files as you like, each file should not exceed 5mb

<Dropzone.Root
  accept={Dropzone.IMAGE_ACCEPT_TYPE}
  maxSize={3 * 1024 ** 2}
  onDropRejected={(files) => console.log("rejected", files)}
>
  <HStack>
    <Dropzone.Accept>
      <Dropzone.Icon as={UploadIcon} />
    </Dropzone.Accept>

    <Dropzone.Reject>
      <Dropzone.Icon as={XIcon} />
    </Dropzone.Reject>

    <Dropzone.Idle>
      <Dropzone.Icon as={ImageIcon} />
    </Dropzone.Idle>

    <VStack gap="xs">
      <Dropzone.Title>Drag images here or click to select files</Dropzone.Title>
      <Dropzone.Description>
        Attach as many files as you like, each file should not exceed 5mb
      </Dropzone.Description>
    </VStack>
  </HStack>
</Dropzone.Root>

ボーダーの色を変更する

ボーダーの色を変更する場合は、focusBorderColorまたはerrorBorderColorに値を設定します。

Drag file here or click to select file

<VStack>
  <Dropzone.Root focusBorderColor="green.500">
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>

  <Dropzone.Root errorBorderColor="orange.500" invalid>
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>
</VStack>

無効にする

無効にする場合は、disabledをtrueに設定します。

Drag file here or click to select file

Upload file

Drag file here or click to select file

<VStack>
  <Dropzone.Root disabled>
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>

  <Field.Root disabled label="Upload file">
    <Dropzone.Root>
      <Text>Drag file here or click to select file</Text>
    </Dropzone.Root>
  </Field.Root>
</VStack>

読み取り専用にする

読み取り専用にする場合は、readOnlyをtrueに設定します。

Drag file here or click to select file

Upload file

Drag file here or click to select file

<VStack>
  <Dropzone.Root readOnly>
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>

  <Field.Root label="Upload file" readOnly>
    <Dropzone.Root>
      <Text>Drag file here or click to select file</Text>
    </Dropzone.Root>
  </Field.Root>
</VStack>

無効な入力にする

無効な入力にする場合は、invalidをtrueに設定します。

Drag file here or click to select file

Upload file

Drag file here or click to select file

File is required.

<VStack>
  <Dropzone.Root invalid>
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>

  <Field.Root errorMessage="File is required." invalid label="Upload file">
    <Dropzone.Root>
      <Text>Drag file here or click to select file</Text>
    </Dropzone.Root>
  </Field.Root>
</VStack>

ローディングアニメーションを使う

ローディングアニメーションを使う場合は、loadingをtrueにします。

Drag file here or click to select file

<VStack>
  <Dropzone.Root loading>
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>

  <Dropzone.Root loading loadingScheme="grid">
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>

  <Dropzone.Root loading loadingProps={{ color: "blue" }}>
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>
</VStack>

制御する

Drag file here or click to select file

const openRef = useRef<() => void>(noop)

return (
  <VStack>
    <Button onClick={() => openRef.current()}>Select file</Button>

    <Dropzone.Root openRef={openRef}>
      <Text>Drag file here or click to select file</Text>
    </Dropzone.Root>
  </VStack>
)

Props

Dropzone.Root

Prop	デフォルト	型 / 説明
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.
`size`	`"sm"`	`"full" \| "lg" \| "md" \| "sm" \| "xs"` The size of the component.
`variant`	`"dashed"`	`"dashed" \| "panel" \| "plain" \| "solid"` The variant of the component.
`accept`	-	`Accept \| string[]` Set accepted file types.
`autoFocus`	`false`	`boolean` Set to true to focus the root element on render.
`disabled`	`false`	`boolean` If `true`, the field will be disabled.
`errorBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is invalid.
`focusBorderColor`	-	`"-moz-initial" \| "AccentColor" \| "AccentColorText" \| "ActiveBorder" \| "ActiveCaption" \| "ActiveText" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" ...` The border color when the input is focused.
`getFilesFromEvent`	-	`DropzoneOptions["getFilesFromEvent"]` Use this to provide a custom file aggregator.
`inputProps`	-	`HTMLStyledProps<"input">` Props for dropzone input element.
`invalid`	`false`	`boolean` If `true`, the field will be invalid.
`loading`	`false`	`boolean` If `true`, display the dropzone loading icon.
`loadingProps`	-	`DropzoneLoadingProps` Props for dropzone loading icon element.
`loadingScheme`	`"oval"`	`LoadingScheme` The loading scheme.
`maxFiles`	`0`	`number` Maximum accepted number of files. The default value is 0 which means there is no limitation to how many files are accepted.
`maxSize`	`Infinity`	`number` Maximum file size (in bytes).
`minSize`	`0`	`number` Minimum file size (in bytes).
`multiple`	`false`	`boolean` Allow drag and drop (or selection from the file dialog) of multiple files.
`name`	-	`string` The HTML `name` attribute used for forms.
`noClick`	`false`	`boolean` If true, disables click to open the native file selection dialog.
`noDrag`	`false`	`boolean` If true, disables drag and drop.
`noDragEventsBubbling`	`false`	`boolean` If true, stops drag event propagation to parents.
`noKeyboard`	`false`	`boolean` If true, disables `space` and `enter` to open the native file selection dialog. Note that it also stops tracking the focus state.
`onDragEnter`	-	`DropzoneOptions["onDragEnter"]` Callback for when the dragenter event occurs.
`onDragLeave`	-	`DropzoneOptions["onDragLeave"]` Callback for when the dragleave event occurs.
`onDragOver`	-	`DropzoneOptions["onDragOver"]` Callback for when the dragover event occurs.
`onDrop`	-	`DropzoneOptions["onDrop"]` Callback for when the drop event occurs. Note that this callback is invoked after the `getFilesFromEvent` callback is done.
`onDropAccepted`	-	`DropzoneOptions["onDropAccepted"]` Callback for when the drop event occurs. Note that if no files are accepted, this callback is not invoked.
`onDropRejected`	-	`DropzoneOptions["onDropRejected"]` Callback for when the drop event occurs. Note that if no files are rejected, this callback is not invoked.
`onError`	-	`DropzoneOptions["onError"]` Callback for when there's some error from any of the promises.
`onFileDialogCancel`	-	`DropzoneOptions["onFileDialogCancel"]` Callback for when closing the file dialog with no selection.
`onFileDialogOpen`	-	`DropzoneOptions["onFileDialogOpen"]` Callback for when opening the file dialog.
`openRef`	-	`RefObject<() => void>` Ref to a open function.
`overlayProps`	-	`DropzoneOverlayProps` Props for dropzone overlay element.
`preventDropOnDocument`	`true`	`boolean` If false, allow dropped items to take over the current browser window.
`readOnly`	`false`	`boolean` If `true`, the field will be readonly.
`required`	`false`	`boolean` If `true`, the field will be required.
`useFsAccessApi`	`false`	`boolean` If true, use the File System API to read files.
`validator`	-	`DropzoneOptions["validator"]` Custom validation function. It must return null if there's no errors.

Dropzone.Description

Prop	デフォルト	型 / 説明
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

Dropzone.Icon

Prop	デフォルト	型 / 説明
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

Dropzone.Title

Prop	デフォルト	型 / 説明
`as`	-	`As` The HTML element to render.
`asChild`	-	`boolean` Merges its props onto its immediate child.
`css`	-	`CSSObject \| CSSObject[]` The CSS object.
`colorScheme`	-	`"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` Set color scheme variables.

アクセシビリティ

Field.Rootを使用しない場合は、Dropzone.Rootにaria-labelまたはaria-labelledbyを設定します。

<Dropzone.Root aria-label="Upload file">
  <Text>Drag file here or click to select file</Text>
</Dropzone.Root>

<VStack gap="sm">
  <Text as="h3" id="label">
    Upload file
  </Text>

  <Dropzone.Root aria-labelledby="label">
    <Text>Drag file here or click to select file</Text>
  </Dropzone.Root>
</VStack>

キー	説明	状態
`Space`, `Enter`	ファイル選択ダイアログを開きます。	-

ARIAロールと属性

コンポーネント	ロールと属性	使い方
`Dropzone.Root`	`role="presentation"`	プレゼンテーションであることを示します。
	`aria-disabled`	`disabled`、`readOnly`、または`loading`が設定されている場合は`"true"`を設定します。
`input`	`aria-labelledby`	関連した`Dropzone.Root`の`id`を設定します。
	`aria-disabled`	`disabled`が設定されている場合は`"true"`を設定します。
	`aria-invalid`	`invalid`が設定されている場合は`"true"`を設定します。
	`aria-readonly`	`readOnly`が設定されている場合は`"true"`を設定します。
	`aria-required`	`required`が設定されている場合は`"true"`を設定します。
	`aria-describedby`	`Dropzone.Root`が`Field.Root`内にあり、`Field.Root`に`errorMessage`または`helperMessage`、もしくは`Field.ErrorMessage`または`Field.HelperMessage`が設定されている場合は、その`id`を設定します。

類似のコンポーネント

FileInputは、ユーザーがファイルを選択するために使用されるコンポーネントです。

FileButtonは、ユーザーがファイルを選択するために使用されるボタンのコンポーネントです。

Textareaは、複数行のテキスト入力を取得するために使用されるコンポーネントです。

Switchは、オンとオフの状態を切り替えるために使用されるコンポーネントです。

Sliderは、ユーザーが値の範囲から選択するために使用されるコンポーネントです。

SegmentedControlは、ユーザーが複数の選択肢の中から1つを選択するために使用されるコンポーネントです。

Radioは、ユーザーが複数の選択肢の中から1つの値を選択するために使用されるコンポーネントです。

Ratingは、ユーザーが評価を行うために使用させるコンポーネントです。

使用しているコンポーネント・フック

Fadeは、要素を次第に表示または非表示にするコンポーネントです。

Inputは、ユーザーからのテキスト入力を取得するために使用されるコンポーネントです。

Loadingは、データの読み込み中などの待機時間に表示するコンポーネントです。

Portalは、現在のDOM階層の外側に要素をレンダリングするコンポーネントです。

Fieldは、フォーム要素に、ラベル、ヘルパーメッセージ、エラーメッセージなどをグループ化するために使用されるコンポーネントです。