|
| 1 | +<script setup> |
| 2 | +import {FormField, Form, useFormValues} from '../../../src'; |
| 3 | + |
| 4 | +const form = new Form(); |
| 5 | +const values = useFormValues(form) |
| 6 | + |
| 7 | +</script> |
| 8 | + |
| 9 | +# Поле single-checkbox |
| 10 | + |
| 11 | +Поле может использоваться в качестве переключателя или для выбора одного значения |
| 12 | +из двух. |
| 13 | + |
| 14 | +- Ключевое слово `single-checkbox`. |
| 15 | +- WhatWG [Спецификация](https://html.spec.whatwg.org/multipage/input.html#checkbox-state-(type=checkbox)). |
| 16 | + |
| 17 | +## Параметры |
| 18 | + |
| 19 | +### values <Badge type = "info">Необязательный</Badge> |
| 20 | + |
| 21 | +- Тип `[any, any]`. |
| 22 | +В случае, если данный параметр передан, то включенный параметр будет соответствовать `values[0]` |
| 23 | +значение, а выключенный `values[1]`. |
| 24 | +____ |
| 25 | + |
| 26 | +Так же все параметры, общие для всех `FormField`. Информацию о них можно посмотреть на [этой странице](./form-field.md#params). |
| 27 | + |
| 28 | +## Значение |
| 29 | + |
| 30 | +Если параметр **values** не был передан, то значение будет **true** - включён, **false** - выключен. |
| 31 | +В случае, когда **values** передаётся, Включенному знаю будет соответствовать `values[0]`, |
| 32 | +а выключенному оставшееся значение. |
| 33 | + |
| 34 | +## Спецификация |
| 35 | + |
| 36 | +- Выбор элемента возможен по щелчку на сам элемент. |
| 37 | +- Выбор возможен по нажатию `Enter` или `Space`. |
| 38 | +- Блокировка полей отменяет навигацию используя `Tab`. |
| 39 | +Также происходит изменение стилистики `single-checkbox`. |
| 40 | +- При неудачной валидации поле должно изменить стилистику `single-checkbox`. |
| 41 | + |
| 42 | +## Примеры |
| 43 | + |
| 44 | +Для данного поля нет дополнительных обязательных параметров, по этому нам необходимо |
| 45 | +указать лишь `type` и `name`: |
| 46 | + |
| 47 | +::: code-group |
| 48 | + |
| 49 | +```html |
| 50 | +<form-field name = "hasPhone" type="single-checkbox"/> |
| 51 | +``` |
| 52 | + |
| 53 | +```ts |
| 54 | +import {FormField} from "jenesius-vue-form"; |
| 55 | + |
| 56 | +``` |
| 57 | + |
| 58 | +::: |
| 59 | + |
| 60 | +Поле по умолчанию: |
| 61 | +<FormField type = "single-checkbox" name = "isAdmin" label = "Это администратор" /> |
| 62 | + |
| 63 | +____ |
| 64 | + |
| 65 | +В заблокированном состоянии: |
| 66 | +<FormField disabled type = "single-checkbox" name = "isAdmin" label = "Заблокированное" /> |
| 67 | + |
| 68 | +____ |
| 69 | + |
| 70 | +Поле не прошло валидацию: |
| 71 | +<FormField :errors = "['Seleact this fields']" type = "single-checkbox" name = "isAdmin" label = "С ошибкой" /> |
| 72 | + |
| 73 | +____ |
| 74 | + |
| 75 | +Поле с переданными `values`: ```['yes', 'no']``` |
| 76 | +<FormField :values = "['yes', 'no']" type = "single-checkbox" name = "isAdmin" label = "С переданными values" /> |
| 77 | +_____ |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +---- |
| 83 | +Текущее состояние формы: |
| 84 | +```ts-vue |
| 85 | +{{values}} |
| 86 | +``` |
0 commit comments