Fix packege.json

This commit is contained in:
Макс Овсяников 2022-11-14 12:23:18 +03:00
parent 585387c415
commit f9dbbb01a9
5 changed files with 1421 additions and 298 deletions

View File

@ -1,33 +1,40 @@
# CG-SELECT # CG-SELECT
## version ~1.0.0
## version ~ 0.0.1
Этот компонент позволяет создать кастомный селект. Он предлагает более гибкую настройку и использование селекта. Этот компонент позволяет создать кастомный селект. Он предлагает более гибкую настройку и использование селекта.
Доступна кастомизация, мультивыбор и живой поиск по елементам. Доступна кастомизация, мультивыбор и живой поиск по елементам.
### Доступна возможность кастомизации основных элементов, таких как: ### Доступна возможность кастомизации основных элементов, таких как:
* Кнопка селекта.
* Список c элементами селекта. - Кнопка селекта.
* Placeholder. - Список c элементами селекта.
* При режиме мультиселект доступна кастомизация chips(выбранных эл-ов). - Placeholder.
* Label элемента(если он был указан) - При режиме мультиселект доступна кастомизация chips(выбранных эл-ов).
* Переключение тем с темной на светлую - Label элемента(если он был указан)
- Переключение тем с темной на светлую
## Installation ## Installation
TODO: Describe the installation process TODO: Describe the installation process
## Usage ## Usage
### Для создания компонета нужно: ### Для создания компонета нужно:
1. Создать обычный button елемент. 1. Создать обычный button елемент.
2. Присвоить ему класс cg-dropdown. 2. Присвоить ему класс cg-dropdown.
``` ```
<button class="cg-dropdown"></button> <button class="cg-dropdown"></button>
``` ```
3. Присвоить ему **уникальный класс**, например(cg-dropdown_categories) 3. Присвоить ему **уникальный класс**, например(cg-dropdown_categories)
``` ```
<button class="cg-dropdown cg-dropdown_categories"></button> <button class="cg-dropdown cg-dropdown_categories"></button>
``` ```
4. Создать новый экземпляр класса(new DropDown) 4. Создать новый экземпляр класса(new DropDown)
5. Передать все желаемые настройки как объект 5. Передать все желаемые настройки как объект
@ -39,22 +46,20 @@ TODO: Describe the installation process
import { DropDown } from './cg-dropdown'; import { DropDown } from './cg-dropdown';
const dropdown = new DropDown({ const dropdown = new DropDown({
selector: '.cg-dropdown_selector', selector: '.cg-dropdown_selector',
placeholder: 'Выберите авто', placeholder: 'Выберите авто',
items: [ items: [
'BMW', 'BMW',
{ {
id: '213sade', id: '213sade',
title: 'Opel', title: 'Opel',
value: 1, value: 1,
}, },
'Mersedes', 'Mersedes',
'MAN', 'MAN',
'Ferari', 'Ferari',
], ],
}); });
``` ```
#### Примеры разных селектов #### Примеры разных селектов
@ -67,10 +72,13 @@ const dropdown = new DropDown({
Вся документация по CG-SELECT находится в одноименной папке. В документации описаны все методы и переменные, также есть примеры передачи настроек в select. Чтобы просмотреть его, откройте файл index.html в браузере из папки с документацией. Вся документация по CG-SELECT находится в одноименной папке. В документации описаны все методы и переменные, также есть примеры передачи настроек в select. Чтобы просмотреть его, откройте файл index.html в браузере из папки с документацией.
## Contributing ## Contributing
1. Fork it! 1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature` 2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'` 3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature` 4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D 5. Submit a pull request :D
## History ## History
TODO: Write history TODO: Write history

1639
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -3,22 +3,28 @@
"version": "0.0.1", "version": "0.0.1",
"description": "", "description": "",
"scripts": { "scripts": {
"start": "parcel ./index.html -p 4500 --open", "start": "parcel ./src/index.html -p 4500 --open ",
"build": "parcel build ./src/index.html" "build": "parcel build ./src/index.html --public-url /cg-select/",
"deploy": "gh-pages -d dist",
"predeploy": "npm run build"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/MaxOvs19/Dropdown-list.git" "url": "git+https://github.com/MaxOvs19/Cg-select.git"
}, },
"author": "", "author": "",
"license": "ISC", "license": "ISC",
"bugs": { "bugs": {
"url": "https://github.com/MaxOvs19/Dropdown-list/issues" "url": "https://github.com/MaxOvs19/Cg-select/issues"
}, },
"homepage": "https://github.com/MaxOvs19/Dropdown-list#readme", "homepage": "https://github.com/MaxOvs19/Cg-select",
"devDependencies": { "devDependencies": {
"@parcel/transformer-sass": "^2.7.0", "@parcel/transformer-sass": "^2.7.0",
"parcel": "^2.7.0", "parcel": "^2.7.0",
"prettier": "^2.7.1" "prettier": "^2.7.1"
},
"dependencies": {
"@parcel/optimizer-css": "^2.8.0",
"gh-pages": "^4.0.0"
} }
} }

View File

@ -5,13 +5,13 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Cg-Select</title> <title>Cg-Select</title>
<link href="./src/style/main.scss" rel="stylesheet" /> <link href="style/main.scss" rel="stylesheet" />
</head> </head>
<body> <body>
<div class="container"> <div class="container">
<header class="header"> <header class="header">
<h1>CG-SELECT</h1> <h1>CG-SELECT</h1>
<img src="src/images/logoCG.jpg" alt="#" class="header__logo" /> <img src="/src/images/logoCG.jpg" alt="#" class="header__logo" />
</header> </header>
</div> </div>

View File

@ -1,4 +1,4 @@
@import 'src/style/nativSelect.scss'; @import './nativSelect.scss';
@import './scrolbar.scss'; @import './scrolbar.scss';
@import './whiteTheme.scss'; @import './whiteTheme.scss';
@import './svgStyle.scss'; @import './svgStyle.scss';