Merge pull request #185 from Jenesius/issue_179

updating ru documentation. #179

Author: Jenesius

docs/fields/form-fields.md

@@ -91,40 +91,7 @@ Passed parameters:
 
 - **options** A set of enumerated dimensions. There are two types of transfer: array and object.
   We will analyze each in more detail, but we recommend using Array to avoid errors and incomprehensible
-  moments in your code.
-
-In the case of Option(Array) the structure looks like this:
-
-```ts
-[
-{label: 'Green color', value: 'green'},
-{label: 'Red color', value: 'red'}
-]
-```
-
-The **label** field is a text label that will be displayed as a title.
-
-The **value** field accepts any value.
-:::tip Why an array is useful
-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
-you have to
-constantly look at the documentation to clarify the location of the label: on the right or on the left.
-:::
-
-Let's move on to options as an object. Remember: on the left is the value, on the right is the label (title).
-
-```json
-{
-   "green": "Green color",
-   "red": "Red color"
-}
-```
-
-However, in this case, we run into the following problem: the value can be **only** a string. Even the given number
-as a value - will be automatically converted by JavaScript to a string. There is one situation when it is convenient
-use
-or store the value in an object. To do this, we have provided a [function](./../guide/utils#convertOptionsObject) for
-converting an object to an array.
+  moments in your code. Described in more detail [here](./form-field-options).
 
 ## Password
 

docs/guide/peculiarities.md

@@ -25,7 +25,7 @@ This is easier to show with an example. Let's say on the interface we need
 show the address, which consists of two fields: Country and City. In the best traditions, we will create a separate field
 for the address structure and describe the above two fields there:
 
-```vue{3,4,13}
+```vue{4,5,12}
 // input-address.vue
 <template>
      <div>
@@ -44,7 +44,7 @@ const form = new Form({name: props.name})
 ```
 Next, we will connect this component to our project
 
-```vue{4}
+```vue{3}
 // app.vue
 <template>
     <input-address name="address"/>

docs/guide/validation.md

@@ -26,7 +26,7 @@ form.validate() // true
 
 For field validation, FormField takes one required parameter:
 
-#### Validation <Badge type = "tip">Required</Badge>
+#### validation <Badge type = "tip">Required</Badge>
 It has the following type:
 ```ts
 interface FormFieldProps {

docs/guide/working-with-values.md

@@ -198,8 +198,8 @@ child keys is 0, this property is completely removed from the changes object.
 form.setValues({age: 24})
 form.change({name: "Jack", age: 25}); // { name: "Jack", age: 25 }
 form.cleanChangesByField('name');
-// Changes: { name: "Jack" }
-// Values: { name: "Jack", age: 24 }
+// Changes: { age: 25 }
+// Values: { age: 25 }
 ```
 
 ## Check field for change

docs/ru/fields/form-fields.md

@@ -91,40 +91,7 @@ const coolOptions = [
 
 - **options** Набор перечислимых измерений. Существует два типа передачи: массив и объект.
   Разберем каждый подробнее, но рекомендуем использовать Array, чтобы избежать ошибок и непонятных
-  моменты в вашем коде.
-
-В случае Option(Array) структура выглядит следующим образом:
-
-```ts
-[
-	{label: 'Green color', value: 'green'},
-	{label: 'Red color', value: 'red'}
-]
-```
-
-Поле **label** — текстовая метка, которая будет отображаться в виде заголовка.
-
-Поле **value** принимает любое значение.
-:::tip Чем полезен массив
-Вы не запутаетесь, где метка, а где значение. В случае с объектом существует вероятность того, что
-тебе придется
-постоянно заходите в документацию, чтобы уточнить расположение метки: справа или слева.
-:::
-
-Перейдем к опциям как к объекту. Помните: слева — значение, справа — метка (заголовок).
-
-```json
-{
-  "green": "Green color",
-  "red": "Red color"
-}
-```
-
-Однако в этом случае мы сталкиваемся со следующей проблемой: значение может быть **только** строкой. Даже указанное число
-как значение — будет автоматически преобразовано JavaScript в строку. Есть одна ситуация, когда удобно
-использовать
-или сохраните значение в объекте. Для этого мы предоставили [функцию](./../guide/utils#convertOptionsObject) для
-преобразования объекта в массив.
+  моменты в вашем коде. Подробнее о options описано [здесь](./form-field-options)
 
 ## Password
 

docs/ru/fields/model-value.md

@@ -1,15 +1,19 @@
 # Использование v-model
 
-Мы постарались сделать все, чтобы пользование этой библиотекой было комфортным. Один из тех моментов
-это директива *v-model*. В описании формы сказано, что все зависимые элементы зависят от состояния
-форме, а не точное переданное значение modelValue. Однако, если свойство *name* не указано для поля ввода
-ввод подается точно по значению *model-value*:
+Мы постарались сделать так, чтобы пользоваться этой библиотекой было
+комфортно. Один из таких моментов это директива *v-model*. В описании 
+формы сказано, что все зависимые элементы связаны с состоянием формы, 
+и не полагаются на значение modelValue. Однако, если свойство *name* 
+не указано, то `form-field` полагается на *model-value*:
 
 ::: warning Не используйте modelValue с именем
-Одновременное использование v-model(:modelValue) и **name** приводит к сохранению состояния формы в двух местах:
-непосредственно в форме и в переменной, передаваемой в modelValue. Мы не рекомендуем использовать оба этих свойства вместе.
-Вместо этого используйте [ComputedValue](./../guide/reactivity#computedValue)
-и [setValues](./../guide/working-with-values#setValues) для получения и изменения значений.
+Одновременное использование v-model(:modelValue) и **name** приводит к
+сохранению состояния формы в двух местах: непосредственно в форме и в 
+переменной, передаваемой в modelValue. Мы не рекомендуем использовать 
+оба этих свойства вместе. Вместо этого используйте
+[ComputedValue](./../guide/reactivity#computedValue)
+и [setValues](./../guide/working-with-values#setValues) для получения 
+и изменения значений.
 :::
 
 ```vue
@@ -26,21 +30,23 @@ const input = ref("");
 </script>
 ```
 
-В этом примере мы регистрируем два поля ввода. Один будет прикреплен к форме с именем *city*, а другой
-не будет зависеть от формы, и в этом случае он будет полагаться на значение из *modelValue*.
+В этом примере мы регистрируем два поля ввода. Один будет прикреплено 
+к форме с именем *city*, а другое не будет зависеть от формы, и в этом
+случае оно будет полагаться на значение из *modelValue*.
 
-Также не забудьте использовать ручные настройки *v-model*, этот пример хорошо описан в
-[документации](https://vuejs.org/guide/components/v-model.html) для Vue. Использование такого механизма
-вы можете получить нередактируемое поле:
+Также не забудьте использовать ручные настройки *v-model*, этот пример
+хорошо описан в [документации](https://vuejs.org/guide/components/v-model.html)
+для Vue. Используя такой механизма вы можете получить неизменяемое поле:
 ```vue
 <template>
     <input-field label = "City" v-model = "value"/>
     <input-field label = "City (Local)" :model-value = "value"/>
 </template>
 ```
-Достаточно простого примера, на котором даже при вводе или выборе значения состояние поля не изменится.
-Однако, как только мы добавим свойство name, *model-value* будет игнорироваться, и вы также можете увидеть это в консоли
-предупреждение:
+Достаточно простого примера, на котором даже при вводе или выборе
+значения состояние поля не изменится. Однако, как только мы добавим
+свойство name, *model-value* будет игнорироваться, и вы также можете
+увидеть это в консоли предупреждение:
 ```vue
 <template>
     <input-field label = "City" v-model = "value"/>

docs/ru/guide/peculiarities.md

@@ -22,10 +22,10 @@
 Если ключ является составным(имеет разделители **.**), то он будет разложен.
 
 Это легче показать на примере. Допустим на интерфейсе нам необходимо
-показать адрес, который состоит из вух полей: Страна и Город. В лучших традициях мы создадим отдельное поле
+показать адрес, который состоит из двух полей: Страна и Город. В лучших традициях мы создадим отдельное поле
 для структуры address и опишем там вышеупомянутые два поля:
 
-```vue{3,4,13}
+```vue{4,5,12}
 // input-address.vue
 <template>
     <div>
@@ -44,7 +44,7 @@ const form = new Form({name: props.name})
 ```
 Далее подключим эту компоненту к нам в проект
 
-```vue{4}
+```vue{3}
 // App.vue
 <template>
 	<input-address name="address"/>

docs/ru/guide/validation.md

@@ -26,7 +26,7 @@ form.validate() // true
 
 Для валидации поля, FormField принимает один обязательный параметр:
 
-#### Validation <Badge type = "tip">Обязательный</Badge>
+#### validation <Badge type = "tip">Обязательный</Badge>
 Имеет следующий тип:
 ```ts
 interface FormFieldProps {
@@ -53,7 +53,7 @@ type FormFieldValidationCallback = (value: any) => true | string | boolean
 import {FormField, Form} from "jenesius-vue-form";
 
 const validation = [
-	x => x.length > 5 || "Значит слишком коротко. Минимальная длина 5.",
+	x => x.length > 5 || "Длина значения должна быть больше 5 символов.",
     x => x.length < 25 || "Длина значения должна быть меньше 25."
 ]
 </script>

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

@@ -164,7 +164,7 @@ form.getValueByName('login') // Correct
 способ не сможет найти нужное значение поля.
 :::
 
-## Принятие изменений
+## Подтверждение изменений
 Для того чтобы подтвердить все изменения или только для конкретного поля, воспользуйтесь методом **acceptChanges**.
 Метод очищает changes (целиком или единичное поле) и устанавливает очищенное значение в values.
 
@@ -189,6 +189,11 @@ form.pureValues; // { username: "Jack", age: 24, id: 1 }
 form.changes; // {}
 ```
 
+::: warning События
+Использование данного метода не порождает события `изменения`. Это
+важно учитывать при его использовании.
+:::
+
 ## Очистка изменений для поля
 Метод **cleanChangesByField** отменяет изменения для переданного поля. Данная функция работает только с объектом changes и не
 затрагивает объект values. Если в дочернее свойство объекта changes является объектом, но при этом количество
@@ -198,8 +203,8 @@ form.changes; // {}
 form.setValues({age: 24})
 form.change({name: "Jack", age: 25}); // { name: "Jack", age: 25 }
 form.cleanChangesByField('name');
-// Changes: { name: "Jack" }
-// Values: { name: "Jack", age: 24 }
+// Changes: { age: 25 }
+// Values: { age: 25 }
 ```
 
 ## Проверка поля на изменение