99 lines
5.0 KiB
Markdown
99 lines
5.0 KiB
Markdown
# CG-SELECT
|
||
|
||
## version ~ 0.2.1
|
||
|
||
Этот компонент позволяет создать кастомный селект. Он предлагает более гибкую настройку и использование селекта.
|
||
Доступна кастомизация, мультивыбор и живой поиск по елементам.
|
||
|
||
### Доступна возможность кастомизации основных элементов, таких как:
|
||
|
||
- Кнопка селекта.
|
||
- Список c элементами селекта.
|
||
- Placeholder.
|
||
- При режиме мультиселект доступна кастомизация chips(выбранных эл-ов).
|
||
- Label элемента(если он был указан)
|
||
- Переключение тем с темной на светлую
|
||
|
||
## Installation
|
||
|
||
```
|
||
npm i cg-select
|
||
```
|
||
|
||
## Usage
|
||
|
||
### Для создания компонета нужно:
|
||
|
||
1. Создать обычный button елемент.
|
||
2. Присвоить ему класс cg-dropdown.
|
||
|
||
```
|
||
<button class="cg-dropdown"></button>
|
||
```
|
||
|
||
3. Присвоить ему **уникальный класс**, например(cg-dropdown_categories)
|
||
|
||
```
|
||
<button class="cg-dropdown cg-dropdown_categories"></button>
|
||
```
|
||
|
||
4. Создать новый экземпляр класса(new DropDown)
|
||
5. Передать все желаемые настройки как объект
|
||
|
||
#### Все опции для создания и управления находятся в документации, раздел "Конструктор класса DropDown".
|
||
|
||
### Пример создния обычного селекта
|
||
|
||
```javascript
|
||
import { DropDown } from 'cg-select/src/cg-select';
|
||
import 'cg-select/src/main.scss';
|
||
|
||
const dropdown = new DropDown({
|
||
selector: '.cg-dropdown_selector',
|
||
placeholder: 'Выберите авто',
|
||
items: [
|
||
'BMW',
|
||
{
|
||
id: '213sade',
|
||
title: 'Opel',
|
||
value: 1,
|
||
},
|
||
'Mersedes',
|
||
'MAN',
|
||
'Ferari',
|
||
],
|
||
});
|
||
```
|
||
|
||
## Пример разных селектов
|
||
|
||
Так же рабочий пример -- https://cg-select.itguild.info/
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Вся документация по CG-SELECT находится в одноименной папке. В документации описаны все методы и переменные, также есть примеры передачи настроек в select. Так же её можно открыть на странице с примером, или перейти по ссылке ниже.
|
||
|
||
**Чтобы ознакомиться с ней, перейдите по ссылке -** 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
|
||
|
||
| Совместимость с приложениями | JS | React | Angular | Vue |
|
||
| ---------------------------- | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------: | :---------------------------------------------------------------------: |
|
||
| CG-SELECT |  |   |  |  |
|
||
| Комментарий | Протестирован в Js приложениях и работает успешно. | Работает только с костылем в виде `setTimeout()` | пока недоступно | тесты не проведены |
|
||
|
||
## History
|
||
|
||
16.12.2022 - релиз версии 0.1.0!
|