• Русский

      • Иконка

      Введение

      В NocoBase иконка (Icon) используется для хранения идентификатора иконки.

      Поле иконки подходит для добавления визуальной идентификации категориям, меню, статусам и точкам входа. Оно хранит значение иконки, а при отображении на странице визуализируется компонентом иконки.

      Если нужно загрузить настоящее изображение, выберите вложение. Если нужно только сохранить описание иконки, выберите однострочный текст.

      Сценарии использования

      Иконки подходят для следующих бизнес-сценариев:

      • Иконки меню и функциональных точек входа
      • Иконки категорий и тегов
      • Иконки статусов и уровней
      • Визуальная идентификация на дашбордах или карточках

      Создание конфигурации

      На странице «Configure fields» таблицы данных нажмите «Add field» и выберите «Иконка», чтобы создать поле иконки.

      20240512180027

      КонфигурацияОписание
      Field interfaceТип интерфейса поля. Для иконки соответствует icon и определяет способ ввода и отображения на странице.
      Field display nameНазвание поля, отображаемое в интерфейсе, например «Иконка меню», «Иконка категории» или «Иконка статуса». Рекомендуется использовать название, понятное бизнес-пользователям.
      Field nameИдентификатор поля, используемый для внутренних ссылок в API, полях связей, правах доступа, рабочих процессах и других компонентах. После создания обычно не изменяется; допускаются только буквы, цифры и символы подчёркивания, при этом имя должно начинаться с буквы.
      Field typeТип поля на уровне данных. Для поля иконки по умолчанию используется string.
      Default valueЗначение по умолчанию. При создании записи оно автоматически подставляется, если пользователь не указал значение.
      Validation rulesПравила проверки. Обычно достаточно настроить обязательность заполнения.
      DescriptionОписание поля. Здесь удобно указать назначение поля, требования к заполнению, источник данных или ответственного за его поддержку.
      Внимание

      После создания имя поля будет использоваться блоками страниц, правами доступа, рабочими процессами и API. Перед созданием проверьте название, чтобы избежать дополнительных затрат на изменение конфигурации в дальнейшем.

      Свойства поля

      Поле иконки по умолчанию ведёт себя следующим образом:

      СвойствоОписание
      Интерфейс Field interface по умолчаниюicon.
      Тип Field type по умолчаниюstring.
      Доступный тип Field typestring.
      Компонент страницыВ режиме редактирования используется компонент выбора иконки.
      ФильтрацияОбычно не используется как основное условие фильтрации.
      СортировкаОбычно не используется для сортировки.
      ПроверкаПоддерживаются базовые проверки, включая обязательность заполнения.

      Редактирование конфигурации

      После создания нажмите «Edit» справа от поля, чтобы изменить конфигурацию поля иконки. Редактирование поля предназначено главным образом для настройки его отображения и использования в NocoBase, например изменения отображаемого названия, описания, значения по умолчанию, правил проверки или специальных настроек поля.

      Если поле поступает из таблицы, уже синхронизированной с основной базой данных, редактирование обычно выполняется в рамках сопоставления полей — поле базы данных сопоставляется с Field type и Field interface в NocoBase.

      КонфигурацияМожно редактироватьОписание
      Field display nameДаИзменение отображаемого в интерфейсе названия поля без изменения его идентификатора.
      Field nameНетИдентификатор поля обычно нельзя изменить в форме редактирования после создания.
      Field interfaceПри определённых условияхДля полей основной базы данных или синхронизированных полей его можно изменить при сопоставлении полей. После изменения способ ввода, отображения и проверки на страницах будет изменён.
      Field typeПри определённых условияхДля полей основной базы данных или синхронизированных полей его можно изменить при сопоставлении полей. Перед изменением необходимо убедиться, что существующие данные можно использовать с новым типом.
      Default valueДаИзменение значения по умолчанию для новых записей.
      Validation rulesДаИзменение правил проверки поля.
      DescriptionДаДополнение назначения поля, требований к заполнению, источника данных или сведений об ответственном.
      Внимание

      Переключение Field type или Field interface — это не простое изменение отображаемого названия. Оно влияет на способ хранения поля, компонент ввода, правила проверки, условия фильтрации и способ использования переменных в рабочих процессах. При большом объёме существующих данных сначала убедитесь, что формат данных соответствует новому типу.

      Удаление поля

      Нажмите «Delete» справа от поля, чтобы удалить поле иконки. В основной базе данных можно также выбрать несколько полей и удалить их одновременно.

      При удалении поля иконки, созданного в основной базе данных, обычно одновременно удаляются соответствующий физический столбец в базе данных и содержащиеся в нём данные. При удалении поля, синхронизированного с базой данных или сопоставленного с внешним источником данных, область воздействия зависит от соответствующего источника данных и происхождения поля.

      Предупреждение

      Удаление поля может повлиять на блоки страниц, формы, фильтрацию, права доступа, рабочие процессы, API, импорт и экспорт, а также существующие данные. Перед удалением убедитесь, что поле больше не используется в бизнес-конфигурациях.

      Использование в конфигурации страниц

      Поле иконки подходит для визуальной индикации в списках, карточках и подробной информации. 20260709225630

      СценарийНазначение
      Блок формыВыбор иконки.
      Блок подробной информацииОтображение иконки.
      Список или карточкаВизуальная идентификация категории, статуса или точки входа.
      Права доступа и рабочие процессыОбычно не используется как основное условное поле.

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

      • Поле — сведения о назначении, категориях и логике сопоставления полей
      • Обычная таблица — создание и управление полями в обычной таблице
      • Цвет — сохранение цветовой идентификации
      • Вложение — загрузка изображений или файлов