Перейти к основному содержимому
Версия: Next

Type Alias: CustomSidebarControls

CustomSidebarControls = object

Секция с элементами управления на вкладке боковой панели.

Группирует кнопки, поля ввода, текстовые блоки и другие элементы. Элементы могут располагаться горизонтально или вертикально.

Все элементы секции передаются в одном объекте: тип, ориентация и список элементов находятся в одном месте.

Remarks

Структура:

  • type — маркер типа ('controls')
  • orientation — расположение элементов (horizontal/vertical)
  • dockTo — выравнивание (start/end)
  • items — массив элементов управления

Элементы располагаются:

  • Горизонтально (row) — рядом друг за другом
  • Вертикально (column) — один под другим

Properties

dockTo?

optional dockTo: "start" | "end"

Позиция выравнивания элементов в секции.

Аналог CSS FlexBox justify-content:

  • 'start' — элементы прижимаются к началу (слева для горизонтальной, сверху для вертикальной)
  • 'end' — элементы прижимаются к концу (справа для горизонтальной, снизу для вертикальной)

Default

'start'

Example

Элементы в конце контейнера

{
type: 'controls',
orientation: 'horizontal',
dockTo: 'end', // Кнопки справа
items: [...]
}

items

items: SidebarControl[]

Массив элементов управления в этой секции.

Элементы располагаются в соответствии с ориентацией и выравниванием.

Remarks

Поддерживаемые типы:

  • Button — кнопка
  • Input — текстовое поле для ввода
  • TextBlock — текстовый блок для отображения информации

Порядок:

  • Элементы отображаются в порядке их появления в массиве

Example

Смешанные элементы

items: [
{
id: 'plugin:text',
type: 'textblock',
content: 'Параметры'
},
{
id: 'plugin:input',
type: 'input',
title: 'Значение'
},
{
id: 'plugin:button',
type: 'button',
title: 'Применить'
}
]

See

  • Button — кнопка
  • Input — текстовое поле
  • TextBlock — текстовый блок

orientation?

optional orientation: "horizontal" | "vertical"

Ориентация расположения элементов в секции.

Аналог CSS FlexBox flex-direction:

  • 'horizontal' — элементы выстраиваются в строку (слева направо)
  • 'vertical' — элементы выстраиваются в столбец (сверху вниз)

Default

'horizontal'

Example

Вертикальное расположение (форма)

{
type: 'controls',
orientation: 'vertical',
items: [
{ id: 'field1', type: 'input', ... },
{ id: 'field2', type: 'input', ... },
{ id: 'button', type: 'button', ... }
]
}

Горизонтальное расположение (кнопки)

{
type: 'controls',
orientation: 'horizontal',
items: [
{ id: 'ok', type: 'button', title: 'OK', ... },
{ id: 'cancel', type: 'button', title: 'Cancel', ... }
]
}

type

type: "controls"

Маркер типа элемента.

Указывает что это секция с элементами управления.

Default

'controls'