多选

PreviousNext
Tag NodeSelect Editor
Loading...

特性

与传统的基于输入的多选不同，该组件构建在 Plate editor 之上，提供：

  • 完整的历史记录支持（撤销/重做）
  • 标签之间和标签内的原生光标导航
  • 选择一个或多个标签
  • 复制/粘贴标签
  • 拖放重新排序标签
  • 只读模式
  • 防止重复标签
  • 使用不区分大小写的匹配创建新标签
  • 搜索文本清理和空白修剪
  • 由 cmdk 提供支持的模糊搜索

手动使用

安装

pnpm add @platejs/tag

添加插件

import { MultiSelectPlugin } from '@platejs/tag/react';
import { createPlateEditor } from 'platejs/react';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    MultiSelectPlugin, // 具有标签功能的多选编辑器
  ],
});

配置插件

import { MultiSelectPlugin } from '@platejs/tag/react';
import { createPlateEditor } from 'platejs/react';
import { TagElement } from '@/components/ui/tag-node';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    MultiSelectPlugin.withComponent(TagElement),
  ],
});
  • MultiSelectPlugin：扩展 TagPlugin 并将编辑器限制为仅包含标签元素
  • withComponent：分配 TagElement 来渲染标签组件

添加 SelectEditor

npx shadcn@latest add https://platejs.org/r/select-editor

基本示例

import { MultiSelectPlugin } from '@platejs/tag/react';
import { TagElement } from '@/components/ui/tag-node';
import {
  SelectEditor,
  SelectEditorContent,
  SelectEditorInput,
  SelectEditorCombobox,
  type SelectItem,
} from '@/components/ui/select-editor';
 
// 定义你的项目
const ITEMS: SelectItem[] = [
  { value: 'React' },
  { value: 'TypeScript' },
  { value: 'JavaScript' },
];
 
export default function MySelectEditor() {
  const [value, setValue] = React.useState<SelectItem[]>([ITEMS[0]]);
 
  return (
    <SelectEditor
      value={value}
      onValueChange={setValue}
      items={ITEMS}
    >
      <SelectEditorContent>
        <SelectEditorInput placeholder="选择项目..." />
        <SelectEditorCombobox />
      </SelectEditorContent>
    </SelectEditor>
  );
}

表单示例

插件

TagPlugin

用于单个标签功能的内联 void 元素插件。

MultiSelectPlugin

TagPlugin 的扩展，将编辑器限制为仅包含标签元素，启用多选行为，具有自动文本清理和重复预防功能。

API

tf.insert.tag

在当前选择处插入新的多选元素。

Parameters

  • props TTagProps

    多选元素的属性。

OptionsTTagProps

Collapse all

  • value string

    多选元素的唯一值。

getSelectedItems

获取编辑器中的所有标签项目。

ReturnsTTagProps[]

    编辑器中的标签项目数组。

isEqualTags

比较两组标签是否相等的工具函数，忽略顺序。

Parameters

Collapse all

  • newTags optional TTagProps[]

    要与当前编辑器标签比较的新标签。

Returnsboolean

    两组是否包含相同的值。

Hooks

useSelectedItems

获取编辑器中当前选中的标签项目的 Hook。

ReturnsTTagProps[]

    具有值和属性的选中标签项目数组。

useSelectableItems

获取可选择的可用项目的 Hook，通过搜索过滤并排除已选中的项目。

Optionsoptions

Collapse all

  • allowNew optional boolean

    是否允许创建新项目。

    • 默认值： true

  • filter optional (value: string, search: string) => boolean

    项目的自定义过滤函数。

  • items optional T[]

    可用项目数组。

  • newItemFilter optional (search: string) => boolean

    新项目的过滤函数。

  • newItemPosition optional 'end' | 'start'

    新项目在列表中的位置。

    • 默认值： 'end'

ReturnsT[]

    过滤后的可选项目数组。

useSelectEditorCombobox

处理编辑器中组合框行为的 Hook，包括文本清理和项目选择。

Optionsoptions

Collapse all

  • open boolean

    组合框是否打开。

  • selectFirstItem () => void

    选择第一个组合框项目的函数。

  • onValueChange optional (items: TTagProps[]) => void

    选中项目更改时的回调。

类型

TTagElement

type TTagElement = TElement & {
  value: string;
  [key: string]: unknown;
};

TTagProps

type TTagProps = {
  value: string;
  [key: string]: unknown;
};
FindMulti Select