Форма

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

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

vue

<script setup lang="ts">
import { reactive, ref } from 'vue'
import { LhForm, LhFormItem, LhInput, LhButton, LhMessage } from '@lh-ui/vue3'

const formRef = ref()
const formModel = reactive({
  name: '',
  email: '',
})

const formRules = {
  name: [{ required: true, message: 'Введите имя' }],
  email: [{ required: true, message: 'Введите эл. почту' }],
}

async function submitForm() {
  const valid = await formRef.value.validate()
  if (valid) {
    LhMessage.success('Отправлено успешно')
    console.log('Отправлено успешно', formModel)
  }
}

function resetForm() {
  formRef.value?.resetFields()
}
</script>

<template>
  <LhForm ref="formRef" :model="formModel" :rules="formRules" label-width="80px">
    <LhFormItem prop="name" label="Имя" required>
      <LhInput v-model="formModel.name" placeholder="Введите имя" />
    </LhFormItem>
    <LhFormItem prop="email" label="Эл. почта" required>
      <LhInput v-model="formModel.email" placeholder="Введите эл. почту" />
    </LhFormItem>
    <LhFormItem>
      <LhButton type="primary" @click="submitForm">Отправить</LhButton>
      <LhButton plain @click="resetForm" style="margin-left: 8px">Сбросить</LhButton>
    </LhFormItem>
  </LhForm>
</template>

vue

<script>
import { LhForm, LhFormItem, LhInput, LhButton, LhMessage } from '@lh-ui/vue3'

export default {
  components: { LhForm, LhFormItem, LhInput, LhButton },
  data() {
    return {
      formModel: { name: '', email: '' },
      formRules: {
        name: [{ required: true, message: 'Введите имя' }],
        email: [{ required: true, message: 'Введите эл. почту' }],
      },
    }
  },
  methods: {
    async submitForm() {
      const valid = await this.$refs.formRef.validate()
      if (valid) {
        LhMessage.success('Отправлено успешно')
        console.log('Отправлено успешно', this.formModel)
      }
    },
    resetForm() { this.$refs.formRef?.resetFields() },
  },
}
</script>

<template>
  <LhForm ref="formRef" :model="formModel" :rules="formRules" label-width="80px">
    <LhFormItem prop="name" label="Имя" required>
      <LhInput v-model="formModel.name" placeholder="Введите имя" />
    </LhFormItem>
    <LhFormItem prop="email" label="Эл. почта" required>
      <LhInput v-model="formModel.email" placeholder="Введите эл. почту" />
    </LhFormItem>
    <LhFormItem>
      <LhButton type="primary" @click="submitForm">Отправить</LhButton>
      <LhButton plain @click="resetForm">Сбросить</LhButton>
    </LhFormItem>
  </LhForm>
</template>

Пользовательская тема

К форме можно применить пользовательскую цветовую тему.

vue

<script setup lang="ts">
import { reactive } from 'vue'
import { LhConfigProvider, LhForm, LhFormItem, LhInput, LhButton } from '@lh-ui/vue3'

const themeForm = reactive({ name: '' })
const cerblueTheme = {
  'primary-color': '#2B4C7C',
  'primary-color-hover': '#3D649E',
  'primary-color-bg': '#E8EDF3',
}
</script>

<template>
  <!-- Тема сине-белого фарфора -->
  <LhConfigProvider :theme-vars="cerblueTheme">
    <LhForm :model="themeForm" label-width="80px">
      <LhFormItem label="Имя">
        <LhInput v-model="themeForm.name" />
      </LhFormItem>
      <LhFormItem>
        <LhButton type="primary">Отправить</LhButton>
      </LhFormItem>
    </LhForm>
  </LhConfigProvider>
</template>

vue

<script>
import { LhConfigProvider, LhForm, LhFormItem, LhInput, LhButton } from '@lh-ui/vue3'

export default {
  data() {
    return {
      themeForm: { name: '' },
      cerblueTheme: {
        'primary-color': '#2B4C7C',
        'primary-color-hover': '#3D649E',
        'primary-color-bg': '#E8EDF3',
      },
    }
  },
}
</script>

<template>
  <!-- Тема сине-белого фарфора -->
  <LhConfigProvider :theme-vars="cerblueTheme">
    <LhForm :model="themeForm" label-width="80px">
      <LhFormItem label="Имя">
        <LhInput v-model="themeForm.name" />
      </LhFormItem>
      <LhFormItem>
        <LhButton type="primary">Отправить</LhButton>
      </LhFormItem>
    </LhForm>
  </LhConfigProvider>
</template>

Интернационализация

vue

<script setup lang="ts">
import { reactive, ref } from 'vue'
import { LhConfigProvider, LhForm, LhFormItem, LhInput, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

const locale = ref('zh-CN')
const formModel = reactive({ name: '' })
</script>

<template>
  <!-- Настройка интернационализации -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhForm :model="formModel" label-width="80px">
      <LhFormItem :label="locale === 'zh-CN' ? '姓名' : 'Name'">
        <LhInput v-model="formModel.name" :placeholder="locale === 'zh-CN' ? '请输入姓名' : 'Enter name'" />
      </LhFormItem>
      <LhFormItem>
        <LhButton type="primary">{{ locale === 'zh-CN' ? '提交' : 'Submit' }}</LhButton>
      </LhFormItem>
    </LhForm>
  </LhConfigProvider>
</template>

vue

<script>
import { LhConfigProvider, LhForm, LhFormItem, LhInput, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

export default {
  data() {
    return {
      locale: 'zh-CN',
      formModel: { name: '' },
      zhCN: zhCN,
      enUS: enUS,
    }
  },
}
</script>

<template>
  <!-- Настройка интернационализации -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhForm :model="formModel" label-width="80px">
      <LhFormItem :label="locale === 'zh-CN' ? '姓名' : 'Name'">
        <LhInput v-model="formModel.name" :placeholder="locale === 'zh-CN' ? '请输入姓名' : 'Enter name'" />
      </LhFormItem>
      <LhFormItem>
        <LhButton type="primary">{{ locale === 'zh-CN' ? '提交' : 'Submit' }}</LhButton>
      </LhFormItem>
    </LhForm>
  </LhConfigProvider>
</template>

Положение меток и строковая компоновка

label-position переключает выравнивание меток (left / right / top); inline располагает элементы формы горизонтально.

vue

<script setup lang="ts">
import { reactive } from 'vue'
const fpModel = reactive({ name: '', city: '' })
</script>

<template>
  <LhForm :model="fpModel" label-position="top" inline>
    <LhFormItem prop="name" label="Название" required>
      <LhInput v-model="fpModel.name" />
    </LhFormItem>
    <LhFormItem prop="city" label="Город">
      <LhInput v-model="fpModel.city" />
    </LhFormItem>
  </LhForm>
</template>

vue

<script>
export default {
  data() {
    return {
      fpModel: { name: '', city: '' },
    }
  },
}
</script>

<template>
  <LhForm :model="fpModel" label-position="top" inline>
    <LhFormItem prop="name" label="Название" required>
      <LhInput v-model="fpModel.name" />
    </LhFormItem>
    <LhFormItem prop="city" label="Город">
      <LhInput v-model="fpModel.city" />
    </LhFormItem>
  </LhForm>
</template>

LhForm Props

Свойство	Описание	Тип	По умолчанию
model	Объект данных формы	`{ [x: string]: unknown; }`	—
rules	Правила проверки полей	`{ [x: string]: LhFormRule[]; }`	—
labelPosition	Положение метки	`"left" \| "right" \| "top"`	`'right'`
labelWidth	Ширина метки	`string \| number`	—
inline	Использовать ли строковую компоновку	`boolean`	`false`
sx	Свойство быстрой компоновки sx	`LhSxProps`	—

LhFormItem Props

Свойство	Описание	Тип	По умолчанию
prop	Путь к полю модели, поддерживает `user.name`	`string`	—
label	Текст метки	`string`	—
required	Обязательное поле	`boolean`	`false`
rules	Правила проверки текущего поля, имеют приоритет над rules формы	`LhFormRule[]`	—

Правила проверки

type LhFormRule = {
  required?: boolean
  message?: string
  validator?: (value: unknown, model: Record<string, unknown>) => string | undefined
}

LhForm предоставляет методы validate() и resetFields().

Доступность

Текст ошибки в LhFormItem несёт role="alert": при провале проверки программа чтения с экрана немедленно его озвучивает
Область содержимого связывается с текстом ошибки через aria-describedby, благодаря чему вспомогательные технологии считывают соответствие «поле → ошибка»; при отсутствии ошибки связь автоматически удаляется
Элементы управления формы (Input / Select / Checkbox / Radio / Switch / Slider / InputNumber / DatePicker / TimePicker / Cascader) считывают состояние проверки родительского LhFormItem и при провале помечаются aria-invalid, а после исправления ошибки метка снимается; элементы вне LhFormItem этому не подвергаются
Резервный текст обязательного поля берётся из языкового пакета form.required (на русском «Это поле обязательно для заполнения») и переключается вместе с языком ConfigProvider; message в rules имеет более высокий приоритет

Типы

Структура открытых TypeScript-типов этого компонента (автоматически извлечено из packages/components/form/src/types.ts и исходников @lh-ui/share/core/*; раскройте каждый пункт, чтобы увидеть полное определение; описания свойств — в таблице Props выше):

LhFormLabelPosition

export type LhFormLabelPosition = 'left' | 'right' | 'top'

LhFormProps

export interface LhFormProps {
  model: Record<string, unknown>
  rules?: Record<string, LhFormRule[]>
  labelPosition?: LhFormLabelPosition
  labelWidth?: string | number
  inline?: boolean
  /** Свойство быстрой компоновки sx */
  sx?: LhSxProps
}

LhFormItemProps

export interface LhFormItemProps {
  prop?: string
  label?: string
  required?: boolean
  rules?: LhFormRule[]
}

LhFormRule _{(из @lh-ui/share/core/form)}

export interface LhFormRule {
  required?: boolean
  message?: string
  validator?: (value: unknown, model: Record<string, unknown>) => string | undefined
}

Форма ​

Базовое использование ​

Пользовательская тема ​

Интернационализация ​

Положение меток и строковая компоновка ​

LhForm Props ​

LhFormItem Props ​

Правила проверки ​

Доступность ​

Типы ​