Added full documentation

This commit is contained in:
2022-10-19 20:33:37 +03:00
parent 99785cc76b
commit b01b65586a
37 changed files with 14590 additions and 32 deletions

View File

@ -1,4 +1,7 @@
import { customStylesFormat } from './utils';
/**
* @module createBreadcrumb
*/
/**
* Метод который создает и отвечает за поведение chips
@ -6,7 +9,7 @@ import { customStylesFormat } from './utils';
* @param {string} title имя выбранного элемента для отрисовки chips
* @param {number} index индекс выбранного элемента для отрисовки chips
* @param {string} id уникальное id выбранного элемента
* @returns возвращает сформированный HTMLElement chips item
* @returns {HTMLElement} возвращает сформированный HTMLElement chips item
*/
export function createBreadcrumb(data, title, index, id) {
const { element, option, indexes, selectedItems } = data;

View File

@ -1,3 +1,8 @@
/**
* Utils module
* @module Utils
*/
/**
* Создание кнопки выбора элементов
* @param {HTMLElement} element созданный экземпляр класса DropDown
@ -67,7 +72,7 @@ export function customStylesFormat(elemOption, selector) {
/**
* Проверка содержит ли item указанные свойства,
* @param {object} item проверяемый на определенную структуру элемент
* @returns возвращает true/false если item содержит указанные свойства
* @returns {boolean} возвращает true/false если item содержит указанные свойства
*/
export function checkItemStruct(item) {
if (item && typeof item !== 'object') {
@ -79,9 +84,9 @@ export function checkItemStruct(item) {
/**
* Преобразование каждого елемента полученного из поля Items;
* @param {object} dataItem полученный елемент переданный при создании селекта может быть как object/string
* @param {object | string} dataItem полученный елемент переданный при создании селекта может быть как object/string
* @param {number} index индекс этого элемента
* @returns возвращает сформированный объект
* @returns {object} возвращает сформированный объект
*/
export function getFormatItem(dataItem, index) {
const random = Math.random().toString(36).substring(2, 10);