Form

Отображает html-форму

Объединяет несколько компонентов Платформы, например, Input и Select. Позволяет валидировать данные перед отправкой на сервер.

<Form OnSubmit={()=>{/* проверка и отправка данных*/}}>
    <Input 
        Mode='Text'
        Tooltip='Input'
        Text='Input text...'
        Label='Input'
        Model-var='Form.Input'
    />
    <RadioButton
        Label="foo"
        Model-var="foo"
        State={[
          {
            key: 1,
            title: '1',
            value: 'Шла',
          },
          {
            key: 2,
            title: '2',
            value: 'Маша',
          }
        ]}
        TitleField="value"
        KeyField="key"
        ValueField="value"
        CSS={['mb-8']}
  />
</Form>

Свойства

AutoMargin

Размер внешнего отступа (в пикселях) для дочерних компонентов компонента Form

Тип: number

Badge

Количественная информация в компонентах Menu, Accordion, Link, Text.

В качестве значения может использоваться объект с полями: counter (число), position ("post" или "pre"), color (цвет)

Тип: any

CSS

Массив строк-классов CSS-стилей, описанных в файле CSS.css DevTools-проекта или встроенных CSS-стилей Платформы. Пример: // CSS-стиль, определяющий внешние (m) и внутренние (p) отступы для компонента. Число после символа "-" (в этом примере - 4) должно быть кратно величине, указанной в параметре, определяющем кратность отступов, в файле Style.mdtheme DevTools-проекта CSS={["m-4", "p-4"]}

Тип: array

CombineConfig

Служебное свойство, используемое в визуальном режиме Редактора Форм, для присваивания значений свойствам компонента в виде генерируемых фрагментов кода. Запрещено изменять значение

Тип: object

FormChanged

Признак изменения дочерних компонентов компонента Form

Тип: boolean

Hidden

Признак состояния компонента Скрыт

Тип: boolean

Hint

Текст, отображаемый при наведении указателя мыши на компонент. Текст отображается на белом фоне

Тип: any

Id

Идентификатор компонента для навигации к нему на HTML-странице. Подробнее см. HTML id Attribute или ID

Тип: string

OnChange

Обработчик события изменения свойства Value любого дочернего компонента. Не имеет параметров. Пример: OnChange={() => { // Вывод сообщения в консоль console.log("Дочерний компонент изменен"); }

Тип: undefined

OnClick

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

В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример:

OnClick={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnKeyDown

Обработчик события нажатия любой клавиши клавиатуры. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа KeyboardEvent. Пример: OnKeyDown={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnKeyUp

Обработчик события отпускания любой клавиши клавиатуры. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа KeyboardEvent. Пример: OnKeyUp={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseDown

Обработчик события нажатия любой кнопки мыши, когда указатель мыши находится на компоненте. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseDown={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseEnter

Обработчик события перемещения указателя мыши на компонент. Событие срабатывает только в случае, если указатель мыши находится за пределами компонента и пользователь перемещает указатель мыши внутрь компонента. Если указатель мыши в текущий момент находится внутри компонента, для срабатывания события пользователь должен переместить указатель мыши за пределы компонента, а затем обратно внутрь компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseEnter={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseLeave

Обработчик события перемещения указателя мыши за пределы компонента. Событие срабатывает, только если указатель мыши находится внутри компонента, а пользователь перемещает указатель мыши за пределы компонента. Если указатель мыши в текущий момент находится за пределами компонента, для срабатывания события пользователь должен переместить указатель мыши внутрь компонента, а затем обратно за пределы компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseLeave={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseMove

Обработчик события наведения указателя мыши на компонент. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseMove={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseOut

Обработчик события перемещения указателя мыши за пределы компонента. Когда пользователь наводит указатель мыши на компонент, происходит одно событие MouseOver, за которым следует одно или несколько событий MouseMove, когда пользователь перемещает указатель мыши внутри компонента. Одно событие MouseOut возникает, когда пользователь выводит указатель мыши за пределы компонента. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseOut={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseOver

Обработчик события перемещения указателя мыши на компонент. Событие возникает, когда пользователь наводит указатель мыши на компонент, и не повторяется до тех пор, пока пользователь не выведет указатель мыши за пределы компонента и затем не вернет его обратно. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseOver={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnMouseUp

Обработчик события отпускания кнопки мыши, когда указатель мыши находится на компоненте. В качестве параметра принимает объект типа объект события компонента экранной формы с дополнительными полями типа MouseEvent. Пример: OnMouseUp={() => { // Получение параметра события const event = getEvent(); // Вывод параметра события в консоль console.log(event); }

Тип: undefined

OnSubmit

Обработчик события об отправке данных, введенных в дочерние компоненты компонента Form, в модель данных. Не имеет параметров. Пример: // Валидация данных формы перед отправкой на сервер OnSubmit={() => { // Получение значения переменной состояния, содержащей признак допустимости значений, введенных в дочерних компонентах компонента Form const form = getValue("Form"); // Проверка допустимости значений, введенных в дочерних компонентах компонента Form if (validate(form)) { // Получение значения переменной состояния, содержащей все введенные пользователем данные const model = getValue("UserModel"); // Отправка допустимых данных на сервер executeAction("SubmitForm", model); } }}

Тип: undefined

OnUnmount

Обработчик события размонтирования согласно жизненному циклу экранной формы. Не имеет параметров. Пример:

OnUnmount={() => { // Отмена выполнения периодического действия при размонтировании экранной формы return clearInterval(getValue("pleerInterval")) } }

Тип: undefined

Slot

Именованное пространство во фрагменте экранной формы.

Тип: string

Tooltip

Текст, отображаемый при наведении указателя мыши на компонент. Текст отображается на черном фоне

Тип: any

Touched

Признак совершенной попытки отправки данных, введенных в дочерние компоненты компонента Form

Тип: boolean

TraceId

Идентификатор для отслеживания состояния компонента исходя из жизненного цикла экранной формы. Используется для выполнения фрагмента кода по изменению состояния компонента

Тип: string

Visible

Признак инверсии состояния компонента Скрыт

Тип: boolean

Значение по умолчанию: True

Примеры

Данные:

  
    "dataForSelect" : [
        {
          "id": 1,
          "name": "first option"
        },
        {
          "id": 2,
          "name": "second option"
        },
      ]

}

JSX:

<Form
  Touched-var='TestFormTouched'
  OnSubmit={() => {
    if(validate(getValue('TestForm'))) {
      return null;
    }
  }}
>
  <Input
    Mode='Text'
    Tooltip='Поле ввода'
    Text='Введите что-нибудь...'
    Error={(input = Form.Input) => {
      return !!input && input.length > 5;
    }}
    Label='Поле ввода'
    Value-var='Form.Input'
    OutputValue-var='Form.Input'
    OutputState-var='TestForm.Input'
    HighlightError-var='TestFormTouched'
  />
  <Select
    Label="Компонент для множественного выбора"
    Error={(input = Form.Select) => {
      return !!input;
    }}
    HasClearButton={true}
    Label='Компонент для множественного выбора'
    State-var='dataForSelect'
    KeyMap={{Value: 'id', DisplayValue: 'name'}}
    Value-var='Form.Select'
    OutputValue-var='Form.Select'
    OutputState-var='TestForm.Select'
    HighlightError-var='TestFormTouched'
    KeyField="name"
    ValueField="id"
  />
  </Form>