cg-select/documentation/index.html

109 lines
4.5 KiB
HTML
Raw Normal View History

2022-10-19 20:33:37 +03:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css" />
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css" />
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
2022-11-17 21:21:06 +03:00
2022-10-26 16:22:50 +03:00
<section>
<h2>CG-SELECT</h2>
2022-12-28 20:33:21 +03:00
<a href="/example/index.html">-- Вернуться к примеру --</a>
2022-10-26 16:22:50 +03:00
<p>
Этот компонент предлагает более гибкую настройку и использование селекта. Так же
2022-11-17 21:21:06 +03:00
реализованны методы взаимодействия с селектом.
2022-10-26 16:22:50 +03:00
</p>
2022-10-19 20:33:37 +03:00
<h5>Для создания компонета нужно:</h5>
<ul>
<li>Создать button елемент</li>
<li>Присвоить ему класс cg-dropdown</li>
<li>Присвоить ему уникальный класс, например(cg-dropdown_categories)</li>
<li>Создать новый экземпляр класса(new DropDown)</li>
<li>Передать все желаемые настройки как объект</li>
</ul>
<p>
<strong>*Все настройки можно посмореть в вкладке</strong>
2022-12-29 17:15:19 +03:00
<a href="constructor.html">Конструктор класса</a>
</p>
2022-10-26 16:22:50 +03:00
<h5>Доступна возможность кастомизации основных элементов, таких как:</h5>
<ul>
<li>Кнопка селекта</li>
<li>Список c элементами селекта</li>
<li>Placeholder</li>
<li>При режиме мультиселект доступна кастомизация chips(выбранных эл-ов)</li>
<li>Label элемента(если он был указан)</li>
<li>Переключение тем с темной на светлую</li>
2022-10-26 16:22:50 +03:00
</ul>
</section>
2022-10-19 20:33:37 +03:00
</div>
<nav>
<h2><a href="index.html">Home</a></h2>
<h3>Classes</h3>
<ul>
<li><a href="DropDown.html">DropDown</a></li>
<li>
2022-12-29 17:15:19 +03:00
<a href="constructor.html">Конструктор класса DropDown</a>
2022-10-19 20:33:37 +03:00
</li>
</ul>
<h3>Modules</h3>
<ul>
<li><a href="module-Utils.html">Utils</a></li>
<li><a href="module-createElementChips.html">createElementChips</a></li>
</ul>
<h3>Private methods</h3>
<ul>
<li><a href="global.html#addOptionsBehaviour">#addOptionsBehaviour</a></li>
<li><a href="global.html#close">#close</a></li>
<li><a href="global.html#checkTheme">#checkTheme</a></li>
<li><a href="global.html#closeSelectClick">#closeSelectClick</a></li>
<li><a href="global.html#init">#init</a></li>
<li><a href="global.html#initEvent">#initEvent</a></li>
<li><a href="global.html#initSelected">#initSelected</a></li>
<li><a href="global.html#open">#open</a></li>
<li><a href="global.html#render">#render</a></li>
<li><a href="global.html#renderUrl">#renderUrl</a></li>
2022-10-25 21:03:10 +03:00
<li><a href="global.html#searchMode">#searchMode</a></li>
2022-12-29 17:15:19 +03:00
<li><a href="global.html#displayMode">#displayMode</a></li>
<li><a href="global.html#selectMode">#selectMode</a></li>
</ul>
<h3>Public methods</h3>
2022-10-19 20:33:37 +03:00
<ul>
2022-12-29 17:15:19 +03:00
<li><a href="global.html#addLanguage">addLanguage</a></li>
2022-10-19 20:33:37 +03:00
<li><a href="global.html#addItem">addItem</a></li>
<li><a href="global.html#buttonControl">buttonControl</a></li>
<li><a href="global.html#deleteItem">deleteItem</a></li>
<li><a href="global.html#deleteItemAll">deleteItemAll</a></li>
<li><a href="global.html#disabled">disabled</a></li>
<li><a href="global.html#getElement">getElement</a></li>
<li><a href="global.html#selectIndex">selectIndex</a></li>
</ul>
</nav>
<br class="clear" />
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed
Oct 19 2022 20:30:19 GMT+0300 (Moscow Standard Time)
</footer>
<script>
prettyPrint();
</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>