Skip to content

Commit 8612cc9

Browse files
committed
updating ru documentation
1 parent 8134104 commit 8612cc9

File tree

9 files changed

+42
-97
lines changed

9 files changed

+42
-97
lines changed

docs/fields/form-fields.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -91,40 +91,7 @@ Passed parameters:
9191

9292
- **options** A set of enumerated dimensions. There are two types of transfer: array and object.
9393
We will analyze each in more detail, but we recommend using Array to avoid errors and incomprehensible
94-
moments in your code.
95-
96-
In the case of Option(Array) the structure looks like this:
97-
98-
```ts
99-
[
100-
{label: 'Green color', value: 'green'},
101-
{label: 'Red color', value: 'red'}
102-
]
103-
```
104-
105-
The **label** field is a text label that will be displayed as a title.
106-
107-
The **value** field accepts any value.
108-
:::tip Why an array is useful
109-
You will not get confused, where is the label and where is the value. In the case of an object, there is a possibility that
110-
you have to
111-
constantly look at the documentation to clarify the location of the label: on the right or on the left.
112-
:::
113-
114-
Let's move on to options as an object. Remember: on the left is the value, on the right is the label (title).
115-
116-
```json
117-
{
118-
"green": "Green color",
119-
"red": "Red color"
120-
}
121-
```
122-
123-
However, in this case, we run into the following problem: the value can be **only** a string. Even the given number
124-
as a value - will be automatically converted by JavaScript to a string. There is one situation when it is convenient
125-
use
126-
or store the value in an object. To do this, we have provided a [function](./../guide/utils#convertOptionsObject) for
127-
converting an object to an array.
94+
moments in your code. Described in more detail [here](./form-field-options).
12895

12996
## Password
13097

docs/guide/peculiarities.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This is easier to show with an example. Let's say on the interface we need
2525
show the address, which consists of two fields: Country and City. In the best traditions, we will create a separate field
2626
for the address structure and describe the above two fields there:
2727

28-
```vue{3,4,13}
28+
```vue{4,5,12}
2929
// input-address.vue
3030
<template>
3131
<div>
@@ -44,7 +44,7 @@ const form = new Form({name: props.name})
4444
```
4545
Next, we will connect this component to our project
4646

47-
```vue{4}
47+
```vue{3}
4848
// app.vue
4949
<template>
5050
<input-address name="address"/>

docs/guide/validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ form.validate() // true
2626

2727
For field validation, FormField takes one required parameter:
2828

29-
#### Validation <Badge type = "tip">Required</Badge>
29+
#### validation <Badge type = "tip">Required</Badge>
3030
It has the following type:
3131
```ts
3232
interface FormFieldProps {

docs/guide/working-with-values.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ child keys is 0, this property is completely removed from the changes object.
198198
form.setValues({age: 24})
199199
form.change({name: "Jack", age: 25}); // { name: "Jack", age: 25 }
200200
form.cleanChangesByField('name');
201-
// Changes: { name: "Jack" }
202-
// Values: { name: "Jack", age: 24 }
201+
// Changes: { age: 25 }
202+
// Values: { age: 25 }
203203
```
204204

205205
## Check field for change

docs/ru/fields/form-fields.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -91,40 +91,7 @@ const coolOptions = [
9191

9292
- **options** Набор перечислимых измерений. Существует два типа передачи: массив и объект.
9393
Разберем каждый подробнее, но рекомендуем использовать Array, чтобы избежать ошибок и непонятных
94-
моменты в вашем коде.
95-
96-
В случае Option(Array) структура выглядит следующим образом:
97-
98-
```ts
99-
[
100-
{label: 'Green color', value: 'green'},
101-
{label: 'Red color', value: 'red'}
102-
]
103-
```
104-
105-
Поле **label** — текстовая метка, которая будет отображаться в виде заголовка.
106-
107-
Поле **value** принимает любое значение.
108-
:::tip Чем полезен массив
109-
Вы не запутаетесь, где метка, а где значение. В случае с объектом существует вероятность того, что
110-
тебе придется
111-
постоянно заходите в документацию, чтобы уточнить расположение метки: справа или слева.
112-
:::
113-
114-
Перейдем к опциям как к объекту. Помните: слева — значение, справа — метка (заголовок).
115-
116-
```json
117-
{
118-
"green": "Green color",
119-
"red": "Red color"
120-
}
121-
```
122-
123-
Однако в этом случае мы сталкиваемся со следующей проблемой: значение может быть **только** строкой. Даже указанное число
124-
как значение — будет автоматически преобразовано JavaScript в строку. Есть одна ситуация, когда удобно
125-
использовать
126-
или сохраните значение в объекте. Для этого мы предоставили [функцию](./../guide/utils#convertOptionsObject) для
127-
преобразования объекта в массив.
94+
моменты в вашем коде. Подробнее о options описано [здесь](./form-field-options)
12895

12996
## Password
13097

docs/ru/fields/model-value.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# Использование v-model
22

3-
Мы постарались сделать все, чтобы пользование этой библиотекой было комфортным. Один из тех моментов
4-
это директива *v-model*. В описании формы сказано, что все зависимые элементы зависят от состояния
5-
форме, а не точное переданное значение modelValue. Однако, если свойство *name* не указано для поля ввода
6-
ввод подается точно по значению *model-value*:
3+
Мы постарались сделать так, чтобы пользоваться этой библиотекой было
4+
комфортно. Один из таких моментов это директива *v-model*. В описании
5+
формы сказано, что все зависимые элементы связаны с состоянием формы,
6+
и не полагаются на значение modelValue. Однако, если свойство *name*
7+
не указано, то `form-field` полагается на *model-value*:
78

89
::: warning Не используйте modelValue с именем
9-
Одновременное использование v-model(:modelValue) и **name** приводит к сохранению состояния формы в двух местах:
10-
непосредственно в форме и в переменной, передаваемой в modelValue. Мы не рекомендуем использовать оба этих свойства вместе.
11-
Вместо этого используйте [ComputedValue](./../guide/reactivity#computedValue)
12-
и [setValues](./../guide/working-with-values#setValues) для получения и изменения значений.
10+
Одновременное использование v-model(:modelValue) и **name** приводит к
11+
сохранению состояния формы в двух местах: непосредственно в форме и в
12+
переменной, передаваемой в modelValue. Мы не рекомендуем использовать
13+
оба этих свойства вместе. Вместо этого используйте
14+
[ComputedValue](./../guide/reactivity#computedValue)
15+
и [setValues](./../guide/working-with-values#setValues) для получения
16+
и изменения значений.
1317
:::
1418

1519
```vue
@@ -26,21 +30,23 @@ const input = ref("");
2630
</script>
2731
```
2832

29-
В этом примере мы регистрируем два поля ввода. Один будет прикреплен к форме с именем *city*, а другой
30-
не будет зависеть от формы, и в этом случае он будет полагаться на значение из *modelValue*.
33+
В этом примере мы регистрируем два поля ввода. Один будет прикреплено
34+
к форме с именем *city*, а другое не будет зависеть от формы, и в этом
35+
случае оно будет полагаться на значение из *modelValue*.
3136

32-
Также не забудьте использовать ручные настройки *v-model*, этот пример хорошо описан в
33-
[документации](https://vuejs.org/guide/components/v-model.html) для Vue. Использование такого механизма
34-
вы можете получить нередактируемое поле:
37+
Также не забудьте использовать ручные настройки *v-model*, этот пример
38+
хорошо описан в [документации](https://vuejs.org/guide/components/v-model.html)
39+
для Vue. Используя такой механизма вы можете получить неизменяемое поле:
3540
```vue
3641
<template>
3742
<input-field label = "City" v-model = "value"/>
3843
<input-field label = "City (Local)" :model-value = "value"/>
3944
</template>
4045
```
41-
Достаточно простого примера, на котором даже при вводе или выборе значения состояние поля не изменится.
42-
Однако, как только мы добавим свойство name, *model-value* будет игнорироваться, и вы также можете увидеть это в консоли
43-
предупреждение:
46+
Достаточно простого примера, на котором даже при вводе или выборе
47+
значения состояние поля не изменится. Однако, как только мы добавим
48+
свойство name, *model-value* будет игнорироваться, и вы также можете
49+
увидеть это в консоли предупреждение:
4450
```vue
4551
<template>
4652
<input-field label = "City" v-model = "value"/>

docs/ru/guide/peculiarities.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
Если ключ является составным(имеет разделители **.**), то он будет разложен.
2323

2424
Это легче показать на примере. Допустим на интерфейсе нам необходимо
25-
показать адрес, который состоит из вух полей: Страна и Город. В лучших традициях мы создадим отдельное поле
25+
показать адрес, который состоит из двух полей: Страна и Город. В лучших традициях мы создадим отдельное поле
2626
для структуры address и опишем там вышеупомянутые два поля:
2727

28-
```vue{3,4,13}
28+
```vue{4,5,12}
2929
// input-address.vue
3030
<template>
3131
<div>
@@ -44,7 +44,7 @@ const form = new Form({name: props.name})
4444
```
4545
Далее подключим эту компоненту к нам в проект
4646

47-
```vue{4}
47+
```vue{3}
4848
// App.vue
4949
<template>
5050
<input-address name="address"/>

docs/ru/guide/validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ form.validate() // true
2626

2727
Для валидации поля, FormField принимает один обязательный параметр:
2828

29-
#### Validation <Badge type = "tip">Обязательный</Badge>
29+
#### validation <Badge type = "tip">Обязательный</Badge>
3030
Имеет следующий тип:
3131
```ts
3232
interface FormFieldProps {
@@ -53,7 +53,7 @@ type FormFieldValidationCallback = (value: any) => true | string | boolean
5353
import {FormField, Form} from "jenesius-vue-form";
5454

5555
const validation = [
56-
x => x.length > 5 || "Значит слишком коротко. Минимальная длина 5.",
56+
x => x.length > 5 || "Длина значения должна быть больше 5 символов.",
5757
x => x.length < 25 || "Длина значения должна быть меньше 25."
5858
]
5959
</script>

docs/ru/guide/working-with-values.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ form.getValueByName('login') // Correct
164164
способ не сможет найти нужное значение поля.
165165
:::
166166

167-
## Принятие изменений
167+
## Подтверждение изменений
168168
Для того чтобы подтвердить все изменения или только для конкретного поля, воспользуйтесь методом **acceptChanges**.
169169
Метод очищает changes (целиком или единичное поле) и устанавливает очищенное значение в values.
170170

@@ -189,6 +189,11 @@ form.pureValues; // { username: "Jack", age: 24, id: 1 }
189189
form.changes; // {}
190190
```
191191

192+
::: warning События
193+
Использование данного метода не порождает события `изменения`. Это
194+
важно учитывать при его использовании.
195+
:::
196+
192197
## Очистка изменений для поля
193198
Метод **cleanChangesByField** отменяет изменения для переданного поля. Данная функция работает только с объектом changes и не
194199
затрагивает объект values. Если в дочернее свойство объекта changes является объектом, но при этом количество
@@ -198,8 +203,8 @@ form.changes; // {}
198203
form.setValues({age: 24})
199204
form.change({name: "Jack", age: 25}); // { name: "Jack", age: 25 }
200205
form.cleanChangesByField('name');
201-
// Changes: { name: "Jack" }
202-
// Values: { name: "Jack", age: 24 }
206+
// Changes: { age: 25 }
207+
// Values: { age: 25 }
203208
```
204209

205210
## Проверка поля на изменение

0 commit comments

Comments
 (0)