Interface: BaseUiElement

Expand

Базовый интерфейс, определяющий основные свойства всех пользовательских элементов UI.

Расширяется всеми другими интерфейсами элементов (Button, Input, TextBlock и т.д.).

Remarks

Содержит:

• id — уникальный идентификатор элемента

Требования:

• Каждый элемент UI должен иметь уникальный id
• id используется для обновления, удаления и ссылок на элемент
• id встроенных элементов генерируются редактором автоматически
• id пользовательских элементов надстроек создаёт саму надстройку

Соглашение об именовании:

• Рекомендуется использовать префикс надстройки: plugin:button:action
• Использовать только буквы, цифры, двоеточия, дефисы: [a-zA-Z0-9:_-]
• id должны быть уникальны в пределах сессии редактора

Extended by

• BaseControl
• CustomRibbonGroup
• CustomRibbonTabInfo
• CustomSidebarTabInfo
• CustomToast

Properties

id

readonly id: string

Уникальный идентификатор элемента пользовательского интерфейса.

Remarks

Требования:

• Должен быть уникален среди всех элементов UI редактора
• Не может быть пустой строкой
• Не может содержать спецсимволы (кроме :, -, _)
• Чувствителен к регистру (case-sensitive)

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

• Идентификация элемента при обновлении
• Идентификация элемента при событиях
• Ссылка на элемент в других местах кода

Соглашения:

'plugin:button:save'          // Кнопка надстройки
'plugin:input:username'       // Поле ввода
'plugin:panel:settings'       // Панель параметров
'plugin:group:formatting'     // Группа элементов

Example

// Создание элемента с уникальным id
{
  id: 'plugin:button:submit',
  title: 'Отправить',
  type: 'button'
}

// Использование id для обновления
editorApi.ui.updateUiNodes([
  {
    id: 'plugin:button:submit',
    updates: { disabled: false }
  }
]);

// Использование id для удаления
editorApi.ui.ribbon.removeTabs(['plugin:ribbon:tab']);