Skip to content

Commit 2484946

Browse files
authored
docs: added ru readme (#260)
1 parent 4f967f2 commit 2484946

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README-ru.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# @gravity-ui/dynamic-forms · [![npm package](https://img.shields.io/npm/v/@gravity-ui/dynamic-forms)](https://www.npmjs.com/package/@gravity-ui/dynamic-forms) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/dynamic-forms/.github/workflows/ci.yml?label=CI&logo=github)](https://github.com/gravity-ui/dynamic-forms/actions/workflows/ci.yml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.gravity-ui.com/dynamic-forms/)
2+
3+
Библиотека для рендеринга форм и их значений на основе `JSON Schema`.
4+
5+
## Установка
6+
7+
```shell
8+
npm install --save-dev @gravity-ui/dynamic-forms
9+
```
10+
11+
## Использование
12+
13+
```jsx
14+
import {DynamicField, Spec, dynamicConfig} from '@gravity-ui/dynamic-forms';
15+
16+
// To embed in a final-form
17+
<DynamicField name={name} spec={spec} config={config} />;
18+
19+
import {DynamicView, dynamicViewConfig} from '@gravity-ui/dynamic-forms';
20+
21+
// To get an overview of the values
22+
<DynamicView value={value} spec={spec} config={dynamicViewConfig} />;
23+
```
24+
25+
### I18N
26+
27+
Некоторые компоненты содержат текстовые токены, доступные на двух языках: `en` (по умолчанию) и `ru`. Для настройки языка используйте функцию `configure`:
28+
29+
```js
30+
// index.js
31+
32+
import {configure, Lang} from '@gravity-ui/dynamic-forms';
33+
34+
configure({lang: Lang.Ru});
35+
```
36+
37+
## Разработка
38+
39+
Для запуска Storybook в режиме разработки выполните следующую команду:
40+
41+
```shell
42+
npm ci
43+
npm run dev
44+
```

0 commit comments

Comments
 (0)