Общие компоненты

В NocoBase client v2 есть набор общих компонентов. При разработке страниц плагинов, страниц настроек или форм их можно использовать напрямую, повторно используя готовый UI и поведение NocoBase.

Этот раздел группирует компоненты по сценариям использования. Каждая страница описывает один компонент: когда он подходит, какие API используются чаще всего и можно ли посмотреть пример прямо в документации.

Быстрый указатель

Я хочу...Где посмотреть
Управлять низкоуровневым полноэкранным сканеромCodeScanner
Разместить стандартную форму в dialogDialogFormLayout
Разместить стандартную форму в drawerDrawerFormLayout
Разрешить только переменные окружения $envEnvVariableInput
Ввести размер файла и сохранить его в байтахFileSizeInput
Редактировать конфигурацию JSON / JSON5JsonTextArea
Ввести пароль с индикатором надежностиPasswordInput
Асинхронно загрузить опции Select из APIRemoteSelect
Добавить поддержку сканирования в поле вводаScanInput
Разрешить полю принимать и константы, и переменныеTypedVariableInput
Разрешить однострочному полю принимать переменные вроде {{ $env.X }} и {{ $user.name }}VariableInput
Вставлять переменные в конфигурацию JSON / JSON5VariableJsonTextArea
Разрешить многострочному тексту принимать переменныеVariableTextArea
Фильтровать Collection по нескольким условиямCollectionFilter
Встроить панель фильтра Collection в страницуCollectionFilterPanel
Настроить перетаскиваемую строку antd TableSortableRow
Настроить колонку ручки перетаскивания TableSortHandle
Показывать списки, выбирать строки и сортировать перетаскиванием на страницах настроекTable
Использовать иконки Ant Design или регистрировать свои иконкиIcon
Создать внутренний реестр для элементов расширения плагинаcreateFormRegistry

Использование

Импортируйте нужные компоненты в клиентском плагине и используйте их как обычные React-компоненты:

import { RemoteSelect, Table } from '@nocobase/client-v2';

function SettingsPage() {
  return (
    <>
      <RemoteSelect request={loadOptions} />
      <Table rowKey="id" columns={columns} dataSource={records} />
    </>
  );
}

Когда использовать

По умолчанию используйте React + Antd. Для типичных сценариев плагинов NocoBase сначала проверьте эти компоненты:

  • Открывать формы drawer или dialog на страницах настроек
  • Вставлять переменные, редактировать JSON, вводить размер файла или сканировать коды в полях формы
  • Использовать фильтры Collection или сортировку перетаскиванием в списках
  • Использовать единый вход для иконок NocoBase

Для обычных полей ввода, кнопок и сообщений компоненты Antd обычно понятнее.

Связанные ссылки