From 1635198b5bfb49c22dccf6441a07459a656cb9cf Mon Sep 17 00:00:00 2001 From: MaxOvs19 Date: Thu, 9 Feb 2023 16:47:55 +0300 Subject: [PATCH] Added Russian version README --- README.md | 3 ++ READMERU.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 104 insertions(+) create mode 100644 READMERU.md diff --git a/README.md b/README.md index 8552656..d897a4c 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Customization, multi-selection and live search by elements are available. - In the multiselect mode, customization of chips (selected elements) is available. - Label of the element (if it was specified). - Switch themes from dark to light. +- The documentation also lists all the elements for catatomization using CSS. ## Installation @@ -77,6 +78,8 @@ All documentation on CG-SELECT is located in the folder of the same name. The do **To view it, follow the link -** https://cg-select.itguild.info/up_/documentation/index.html +**Russian version README -** + ## Contributing 1. Fork it! diff --git a/READMERU.md b/READMERU.md new file mode 100644 index 0000000..bba2915 --- /dev/null +++ b/READMERU.md @@ -0,0 +1,101 @@ +# CG-SELECT + +## version ~ 0.2.31 + +Этот компонент позволяет вам создать пользовательский Select. Он предлагает более гибкую настройку и использование select. +Доступна кастомизация, multi-selection, живой поиск по элементам и многое другое. + +### Возможность настройки основных элементов, таких как: + +- Кнопка самого селекта Select. +- Список с выбранными элементами. +- Placeholder. +- В режиме мультиселекта доступна кастомизация chips (выбранных элементов). +- Label элемента (если она была указана). +- Переключить тему с темной на светлую. +- Так же в документации указанны всеэлементы для катомизации с помощью CSS. + +## Installation + +``` +npm i cg-select +``` + +## Usage + +### Для создания компонента необходимо: + +1. Создайте обычную кнопку. +2. Добавьте ей класс cg-dropdown. + +``` + +``` + +3. Добавьте ему **уникальный класс**, + например: (cg-dropdown_categories) + +``` + +``` + +4. Создайте новый экземпляр класса (new CGSelect) +5. Передайте все нужные настройки как объект. + +#### Все варианты создания и управления селектом есть в документации, раздел "Конструктор класса CGSelect". + +### Пример создания обычного CGSelect. + +```javascript +import CGSelect from 'cg-select'; + +const dropdown = new CGSelect({ + selector: '.cg-dropdown_selector', + placeholder: 'Выберите авто', + items: [ + 'BMW', + { + id: '213sade', + title: 'Opel', + value: 1, + }, + 'Mersedes', + 'MAN', + 'Ferari', + ], +}); +``` + +## Примеры различных вариантов выбора. + +Рабочий пример -- https://cg-select.itguild.info/ + +![image](https://github.com/apuc/cg-select/blob/main/src/images/DefaultSelect.png) +![image](https://github.com/apuc/cg-select/blob/main/src/images/MultiSelect.png) +![image](https://github.com/apuc/cg-select/blob/main/src/images/WhiteTheme.png) +![image](https://github.com/apuc/cg-select/blob/main/src/images/Categories.png) + +Вся документация по CG-SELECT находится в одноименной папке. В документации описаны все методы и переменные, также есть примеры передачи настроек в CGSelect. Вы также можете открыть его на странице с примером, или перейти по ссылке ниже. + +**Для просмотра перейдите по ссылке -** https://cg-select.itguild.info/up_/documentation/index.html + +## Contributing + +1. Fork it! +2. Create your feature branch: `git checkout -b my-new-feature` +3. Commit your changes: `git commit -am 'Add some feature'` +4. Push to the branch: `git push origin my-new-feature` +5. Submit a pull request :D + +## Compatibility + +| Application Compatibility | JS | React | Angular | Vue | +| ------------------------- | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: | :---------------------------------------------------------------------: | +| CG-SELECT | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/yes.png) ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | ![image](https://github.com/apuc/cg-select/blob/main/src/images/no.png) | +| Comment | Tested in Js applications and it worksуспешно. | Works only with a crutch in the form `setTimeout()` | not yet available | not yet available | + +## History + +16.12.2022 - release version 0.1.0! + +20.01.2023 - upgrade to version 0.2.1