Yamada UIにスターをあげる

スター
Yamada UIYamada UIv1.5.1

MultiSelect

MultiSelectは、ユーザーがオプションのリストから複数の値を選択するために使用されるコンポーネントです。

ソース@yamada-ui/select

インポート

import { MultiSelect, OptionGroup, Option } from "@yamada-ui/react"
Copied!

使い方

編集可能な例

<MultiSelect placeholder="キャラクターを選択">
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

または、itemsを設定することでOptionを省略することができます。

編集可能な例

const items: SelectItem[] = [
  { label: "孫悟空", value: "孫悟空" },
  { label: "ベジータ", value: "ベジータ" },
  { label: "フリーザ", value: "フリーザ" },
]

return <MultiSelect placeholder="キャラクターを選択" items={items} />
Copied!

バリアントを変更する

編集可能な例

<VStack>
  <MultiSelect variant="outline" placeholder="outline" />
  <MultiSelect variant="filled" placeholder="filled" />
  <MultiSelect variant="flushed" placeholder="flushed" />
  <MultiSelect variant="unstyled" placeholder="unstyled" />
</VStack>
Copied!

サイズを変更する

編集可能な例

<VStack>
  <MultiSelect placeholder="extra small size" size="xs" />
  <MultiSelect placeholder="small size" size="sm" />
  <MultiSelect placeholder="medium size" size="md" />
  <MultiSelect placeholder="large size" size="lg" />
</VStack>
Copied!

デフォルトの値を設定する

デフォルトの値を設定する場合は、defaultValueに文字列を設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" defaultValue={["ベジータ"]}>
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

ドロップダウンにヘッダーを追加する

編集可能な例

<MultiSelect
  placeholder="キャラクターを選択"
  header={
    <Center pt="2" px="3">
      ここにヘッダーが追加されます
    </Center>
  }
>
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

ドロップダウンにフッターを追加する

編集可能な例

<MultiSelect
  placeholder="キャラクターを選択"
  footer={
    <Center pb="2" px="3">
      ここにフッターが追加されます
    </Center>
  }
>
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

グループ化する

グループ化する場合は、OptionGroupを使用します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択">
  <OptionGroup label="地球人">
    <Option value="孫悟空">孫悟空</Option>
    <Option value="孫悟飯">孫悟飯</Option>
    <Option value="クリリン">クリリン</Option>
  </OptionGroup>

  <OptionGroup label="フリーザ軍">
    <Option value="フリーザ">フリーザ</Option>
    <Option value="ギニュー">ギニュー</Option>
    <Option value="リクーム">リクーム</Option>
    <Option value="バータ">バータ</Option>
    <Option value="ジース">ジース</Option>
    <Option value="グルド">グルド</Option>
  </OptionGroup>
</MultiSelect>
Copied!

itemsの場合は、このように設定します。

編集可能な例

const items: SelectItem[] = [
  { label: "ベジータ", value: "ベジータ" },
  {
    label: "地球人",
    items: [
      { label: "孫悟空", value: "孫悟空" },
      { label: "孫悟飯", value: "孫悟飯" },
      { label: "クリリン", value: "クリリン" },
    ],
  },
  {
    label: "フリーザ軍",
    items: [
      { label: "フリーザ", value: "フリーザ" },
      { label: "ギニュー", value: "ギニュー" },
      { label: "リクーム", value: "リクーム" },
      { label: "バータ", value: "バータ" },
      { label: "ジース", value: "ジース" },
      { label: "グルド", value: "グルド" },
    ],
  },
]

return <MultiSelect placeholder="キャラクターを選択" items={items} />
Copied!

ボーダーのカラーを変更する

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

編集可能な例

<VStack>
  <MultiSelect focusBorderColor="green.500" placeholder="custom border color" />
  <MultiSelect
    isInvalid
    errorBorderColor="orange.500"
    placeholder="custom border color"
  />
</VStack>
Copied!

区切りをカスタマイズする

区切りをカスタマイズする場合は、separatorに文字列を設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" separator=";">
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

カスタムコンポーネントを使用する

カスタムコンポーネントを使用する場合は、componentにReactElementを設定します。componentは、value, label, index, onRemoveを提供します。

編集可能な例

<VStack>
  <MultiSelect
    placeholder="キャラクターを選択"
    component={({ label }) => <Tag>{label}</Tag>}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>

  <MultiSelect
    placeholder="キャラクターを選択"
    component={({ label, onRemove }) => <Tag onClose={onRemove}>{label}</Tag>}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>
</VStack>
Copied!

選択済みの値をリストから除外する

選択済みの値をリストから除外する場合は、omitSelectedValuesをtrueに設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" omitSelectedValues={true}>
  <OptionGroup label="地球人">
    <Option value="孫悟空">孫悟空</Option>
    <Option value="孫悟飯">孫悟飯</Option>
    <Option value="クリリン">クリリン</Option>
  </OptionGroup>

  <OptionGroup label="フリーザ軍">
    <Option value="フリーザ">フリーザ</Option>
    <Option value="ギニュー">ギニュー</Option>
    <Option value="リクーム">リクーム</Option>
    <Option value="バータ">バータ</Option>
    <Option value="ジース">ジース</Option>
    <Option value="グルド">グルド</Option>
  </OptionGroup>
</MultiSelect>
Copied!

選択可能な最大数を設定する

選択可能な最大数を設定する場合は、maxSelectValuesに数値を設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" maxSelectValues={3}>
  <OptionGroup label="地球人">
    <Option value="孫悟空">孫悟空</Option>
    <Option value="孫悟飯">孫悟飯</Option>
    <Option value="クリリン">クリリン</Option>
  </OptionGroup>

  <OptionGroup label="フリーザ軍">
    <Option value="フリーザ">フリーザ</Option>
    <Option value="ギニュー">ギニュー</Option>
    <Option value="リクーム">リクーム</Option>
    <Option value="バータ">バータ</Option>
    <Option value="ジース">ジース</Option>
    <Option value="グルド">グルド</Option>
  </OptionGroup>
</MultiSelect>
Copied!

選択時にドロップダウンリストを閉じる

選択時にドロップダウンリストを閉じる場合は、closeOnSelectをtrueに設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" closeOnSelect={true}>
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

クリアを無効化する

クリアを無効化する場合は、isClearableをfalseに設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" isClearable={false}>
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

表示位置を変更する

表示位置を変更するには、placementにtopやleft-startなどを設定します。デフォルトでは、bottomが設定されています。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" placement="right-start" maxW="xs">
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

所要時間を変更する

所要時間を変更する場合は、durationに数値(秒)を設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択" duration={0.4}>
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ">ベジータ</Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

オフセットを変更する

要素の大きさやシチュエーションによっては、ツールチップの位置を変更したい場合があります。その場合は、gutterまたはoffsetで位置を調整します。

gutterは、単純な要素との差を設定でき、offsetは、[横軸, 縦軸]を設定できます。

編集可能な例

<VStack>
  <MultiSelect placeholder="キャラクターを選択" gutter={32}>
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>

  <MultiSelect
    placeholder="キャラクターを選択"
    offset={[16, 16]}
    listProps={{ maxW: "xs" }}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>
</VStack>
Copied!

無効化する

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

編集可能な例

<VStack>
  <MultiSelect isDisabled variant="outline" placeholder="outline" />
  <MultiSelect isDisabled variant="filled" placeholder="filled" />
  <MultiSelect isDisabled variant="flushed" placeholder="flushed" />
  <MultiSelect isDisabled variant="unstyled" placeholder="unstyled" />

  <FormControl
    isDisabled
    label="Which notifications would you like to receive?"
  >
    <MultiSelect placeholder="Select notifications" />
  </FormControl>
</VStack>
Copied!

オプションを無効にする場合は、OptionにisDisabledをtrueに設定します。

編集可能な例

<MultiSelect placeholder="キャラクターを選択">
  <Option value="孫悟空">孫悟空</Option>
  <Option value="ベジータ" isDisabled>
    ベジータ
  </Option>
  <Option value="フリーザ">フリーザ</Option>
</MultiSelect>
Copied!

読み取り専用にする

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

編集可能な例

<VStack>
  <MultiSelect isReadOnly variant="outline" placeholder="outline" />
  <MultiSelect isReadOnly variant="filled" placeholder="filled" />
  <MultiSelect isReadOnly variant="flushed" placeholder="flushed" />
  <MultiSelect isReadOnly variant="unstyled" placeholder="unstyled" />

  <FormControl
    isReadOnly
    label="Which notifications would you like to receive?"
  >
    <MultiSelect placeholder="Select notifications" />
  </FormControl>
</VStack>
Copied!

無効な入力にする

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

編集可能な例

<VStack>
  <MultiSelect isInvalid variant="outline" placeholder="outline" />
  <MultiSelect isInvalid variant="filled" placeholder="filled" />
  <MultiSelect isInvalid variant="flushed" placeholder="flushed" />
  <MultiSelect isInvalid variant="unstyled" placeholder="unstyled" />

  <FormControl
    isInvalid
    label="Which notifications would you like to receive?"
    errorMessage="This is required."
  >
    <MultiSelect placeholder="Select notifications" />
  </FormControl>
</VStack>
Copied!

アイコンをカスタマイズする

アイコンをカスタマイズする場合は、iconPropsまたはclearIconPropsにpropsを設定します。

編集可能な例

<VStack>
  <MultiSelect
    placeholder="キャラクターを選択"
    iconProps={{ color: "primary" }}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>

  <MultiSelect
    placeholder="キャラクターを選択"
    iconProps={{ children: <ChevronsDown /> }}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>

  <MultiSelect
    placeholder="キャラクターを選択"
    clearIconProps={{ children: <Trash w="0.5em" /> }}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>
</VStack>
Copied!

オプションをカスタマイズする

オプションをカスタマイズする場合は、optionPropsにpropsを設定します。

編集可能な例

<VStack>
  <MultiSelect
    placeholder="キャラクターを選択"
    optionProps={{ color: "primary" }}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>

  <MultiSelect
    placeholder="キャラクターを選択"
    optionProps={{ icon: <Check color="green.500" /> }}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>
</VStack>
Copied!

制御する

編集可能な例

const [value, onChange] = useState<string[]>(["孫悟空"])

return (
  <MultiSelect
    placeholder="キャラクターを選択"
    value={value}
    onChange={onChange}
  >
    <Option value="孫悟空">孫悟空</Option>
    <Option value="ベジータ">ベジータ</Option>
    <Option value="フリーザ">フリーザ</Option>
  </MultiSelect>
)
Copied!

React Hook Formを使う

編集可能な例

type Data = { select: string[] }

const items: SelectItem[] = [
  { label: "ベジータ", value: "ベジータ" },
  {
    label: "地球人",
    items: [
      { label: "孫悟空", value: "孫悟空" },
      { label: "孫悟飯", value: "孫悟飯" },
      { label: "クリリン", value: "クリリン" },
    ],
  },
  {
    label: "フリーザ軍",
    items: [
      { label: "フリーザ", value: "フリーザ" },
      { label: "ギニュー", value: "ギニュー" },
      { label: "リクーム", value: "リクーム" },
      { label: "バータ", value: "バータ" },
      { label: "ジース", value: "ジース" },
      { label: "グルド", value: "グルド" },
    ],
  },
]

const {
  control,
  handleSubmit,
  watch,
  formState: { errors },
} = useForm<Data>()

const onSubmit: SubmitHandler<Data> = (data) => console.log("submit:", data)

console.log("watch:", watch())

return (
  <VStack as="form" onSubmit={handleSubmit(onSubmit)}>
    <FormControl
      isInvalid={!!errors.select}
      label="Who is your favorite character?"
      errorMessage={errors.select ? errors.select.message : undefined}
    >
      <Controller
        name="select"
        control={control}
        rules={{ required: { value: true, message: "This is required." } }}
        render={({ field }) => (
          <MultiSelect
            placeholder="キャラクターを選択"
            {...field}
            items={items}
          />
        )}
      />
    </FormControl>

    <Button type="submit" alignSelf="flex-end">
      Submit
    </Button>
  </VStack>
)
Copied!

GitHubでこのページを編集する

前Select次NativeSelect