diff --git a/README.md b/README.md index 8c0f182..4f0c3bc 100644 --- a/README.md +++ b/README.md @@ -3,31 +3,4 @@ ----------------------------------------------------- This component allows you to create a generic select. ----------------------------------------------------- - -Creating a Component: - - - Сreate an element with class cg-dropdown and give it a unique selector. - ``` - - ``` - - Create a class element. - ``` - const dropdown = new DropDown() - ``` - - Next, pass the desired settings - - -------------------------------------------------- - ## Settings - - options = { - - selector: Here we pass our unique selector. Obligatory item!!! - - placeholder: string - - selected: string - - items = [] - - url: string - - event: string - - styles: {} - - multiselect: boolean - - multiselectTag: boolean - } - +All documentation on the select is located in the folder of the same name diff --git a/documentation/%D0%9A%D0%BE%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%82%D0%BE%D1%80%20%D0%BA%D0%BB%D0%B0%D1%81%D1%81%D0%B0%20DropDown.html b/documentation/%D0%9A%D0%BE%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%82%D0%BE%D1%80%20%D0%BA%D0%BB%D0%B0%D1%81%D1%81%D0%B0%20DropDown.html new file mode 100644 index 0000000..794880a --- /dev/null +++ b/documentation/%D0%9A%D0%BE%D0%BD%D1%81%D1%82%D1%80%D1%83%D0%BA%D1%82%D0%BE%D1%80%20%D0%BA%D0%BB%D0%B0%D1%81%D1%81%D0%B0%20DropDown.html @@ -0,0 +1,147 @@ + + + + + JSDoc: Class: Конструктор класса DropDown + + + + + + + + + +
+

Class: Конструктор класса DropDown

+ +
+
+

+ Конструктор класса + DropDown(options) +

+
+ +
+
+ + +
Конструктор принимает объект и рендерит селект.
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + object + Объект принимающий настройки селекта
+ +
+
Source:
+
+ +
+
+ +
Example
+ +
options = {
+ selector: 'Уникальный селектор',
+      selected: 'Выбранный элемент',
+      placeholder: '...',
+      items: [string|number|object],
+      styles: {
+        head: {
+          background: '...',
+        },
+        list: {...},
+        chips: {...},
+        caret: {...},
+        placeholder: {...},
+      },
+      event: '...',
+      url: 'http/...',
+      multiselect: true/false,
+      multiselectTag: true/false,
+}
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/DropDown.html b/documentation/DropDown.html new file mode 100644 index 0000000..d793dec --- /dev/null +++ b/documentation/DropDown.html @@ -0,0 +1,157 @@ + + + + + JSDoc: Class: DropDown + + + + + + + + + +
+

Class: DropDown

+ +
+
+

+ DropDown() +

+ +
Описание класса DropDown
+
+ +
+
+

Constructor

+ + + +
+ Этот класс реализовывает функционал кастомного селекта, с возможностями кастомизации. +
+ +
+
Author:
+
+
    +
  • Овсяников Максим
  • +
+
+ +
Source:
+
+ +
+
+
+ +

Classes

+ +
+
DropDown
+
+
+ +

Members

+ +

+ indexes +

+ +
Геттер возвращающий индексы выбранных элемента(ов) селекта
+ +
+
Source:
+
+ +
+
+ +

+ value +

+ +
Геттер возвращающий выбранные элемент(ы) селекта
+ +
+
Source:
+
+ +
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/cg-dropdown.js.html b/documentation/cg-dropdown.js.html new file mode 100644 index 0000000..3475c4d --- /dev/null +++ b/documentation/cg-dropdown.js.html @@ -0,0 +1,669 @@ + + + + + JSDoc: Source: cg-dropdown.js + + + + + + + + + +
+

Source: cg-dropdown.js

+ +
+
+
import {
+  createSelected,
+  customStyles,
+  getFormatItem,
+  customStylesFormat,
+} from './components/utils';
+import { createBreadcrumb } from './components/create-element';
+
+/**
+ * @class Описание класса DropDown
+ * @description Этот класс реализовывает функционал кастомного селекта, с возможностями кастомизации.
+ *@author Овсяников Максим
+ */
+export class DropDown {
+  /**
+   * Созданный HTML елемент
+   * @type {HTMLElement}
+   */
+  #element;
+  /**
+   * Созданный список(ul), с классом list
+   * @type {HTMLElement}
+   */
+  #list;
+  /**
+   * Настройки селекта передаваемые при создании экземпляра класса
+   * @type {object}
+   */
+  #options;
+  /**
+   * Переменная для управления каретки
+   * @type {HTMLElement}
+   */
+  #caret;
+  /**
+   * Массив переданных элементов
+   * @type {object[]}
+   */
+  #items;
+  /**
+   * Переданные категории
+   * @type {string}
+   */
+  #category;
+  /**
+   * Выбранный или массив выбранных элементов из списка
+   * @type {object[] | object}
+   */
+  #selectedItems;
+  /**
+   * Массив индексов выбранных элементов
+   * @type {number[]}
+   */
+  #indexes = [];
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @returns {string[] | string | null} Возвращает выбранные элемент(ы) в виде массива/элемента/null
+   * @description Геттер возвращающий выбранные элемент(ы) селекта
+   */
+  get value() {
+    return this.#selectedItems ?? null;
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @returns {number | number[]}Возвращает индексы выбранных элемента(ов) в виде массива/пустой массив
+   * @description Геттер возвращающий индексы выбранных элемента(ов) селекта
+   */
+  get indexes() {
+    return this.#indexes ?? [];
+  }
+
+  /**
+   *
+   * @param {object} options Объект принимающий настройки селекта
+   * @constructor Конструктор класса DropDown
+   * @description  Конструктор принимает объект и рендерит селект.
+   * @example
+   * options = {
+   *  selector: 'Уникальный селектор',
+      selected: 'Выбранный элемент',
+      placeholder: '...',
+      items: [string|number|object],
+      styles: {
+        head: {
+          background: '...',
+        },
+        list: {...},
+        chips: {...},
+        caret: {...},
+        placeholder: {...},
+      },
+      event: '...',
+      url: 'http/...',
+      multiselect: true/false,
+      multiselectTag: true/false,
+   * }
+     
+   */
+  constructor(options = {}) {
+    this.#init(options);
+    this.#render();
+    this.#initEvent();
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @param {string | object} item добавляемый елемент
+   * @description добавляет переданный элемент в конец списка и перерисовывает список. Не может использоваться при передачи элементов с категорями
+   * @method addItem
+   */
+  addItem(item) {
+    if (this.#category) {
+      console.log('can`t add item to category');
+      return;
+    }
+
+    if (!item) {
+      return false;
+    }
+
+    const index = this.#items.length;
+
+    this.#items.push(getFormatItem(item, index));
+    this.#render();
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @param {number} index индекс удаляемого элемента
+   * @description удаляет елемент по индексу из списка и перерисовывает его. Не может использоваться при передачи элементов с категорями.
+   * @method deleteItem
+   */
+  deleteItem(index) {
+    if (this.#category) {
+      console.log('can`t add item to category');
+      return;
+    }
+
+    const item = this.#items[index];
+
+    this.#items.splice(index, 1);
+    this.#render();
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @description удаляет все елементы из списка и перерисовывает его.
+   * @method deleteItemAll
+   */
+  deleteItemAll() {
+    this.#items.splice(0, this.#items.length);
+    this.#render();
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @param {number} index индекс выбранного элемента
+   * @description  выбирает элемент который будет изначально отрисовываться в селекте
+   * @method selectIndex
+   */
+  selectIndex(index) {
+    if (this.#category) {
+      console.log('can`t add item to category');
+      return;
+    }
+
+    const options = this.#element.querySelectorAll('.list__item');
+
+    if (index > options.length) {
+      return;
+    }
+
+    const select = options[index].innerText;
+    this.#render(select);
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @param {number} numberItem номер возвращаемого элемента
+   * @returns {HTMLElement} возвращает ссылку на выбранный HTML элемент
+   * @method getElement
+   */
+  getElement(numberItem) {
+    if (numberItem > this.#items.length) {
+      return;
+    }
+    return this.#items[numberItem];
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @param {boolean} value - Передаваемый параметр для добавления атрибута disabled;
+   * @description Метод позволяющий переключать состояние селекта disabled,
+   * @method disabled
+   */
+  disabled(value) {
+    if (typeof value !== 'boolean') {
+      return;
+    }
+
+    const select = this.#element.querySelector('.cg-select');
+    if (value === true) {
+      this.#element.setAttribute('disabled', true);
+      select.classList.add('disabled');
+    } else {
+      this.#element.removeAttribute('disabled');
+      select.classList.remove('disabled');
+    }
+  }
+
+  /**
+   * Метод экземпляра класса DropDown
+   * @param {HTMLInputElement} button - HTML кнопка
+   * @param {string} method - метод открытия open/close
+   * @description Метод позволяющий открывать/закрывать селект с помощью кнопок
+   * @method buttonControl
+   */
+  buttonControl(button, method) {
+    button.addEventListener('click', () => {
+      if (method === 'open') {
+        this.#open(true);
+      } else if (method === 'close') {
+        this.#close();
+      } else {
+        return;
+      }
+    });
+  }
+
+  /**
+   * Приватный метод инициализации экземпляра класса DropDown
+   * @method #init
+   * @member
+   * @protected
+   * @param {object} options передаваемые настройки селекта
+   * @description Приватный метод. Общая инициализация селекта. Получение настоек и преобразвание элементов селекта.
+   * @example
+   *  {
+        selector: '.cg-dropdown_one',
+        placeholder: 'Выберите авто',
+        items: [
+          'BMW',
+          {
+            id: '213sade',
+            title: 'Opel',
+            value: 1,
+          },
+          'Mersedes',
+          'MAN',
+          'max',
+        ],
+        multiselect: true,
+        multiselectTag: true,
+      }
+   */
+  #init(options) {
+    this.#options = options;
+    const { items, multiselect, url } = this.#options;
+
+    const elem = document.querySelector(options.selector);
+
+    if (!elem) {
+      throw new Error(`Element with selector ${options.selector}`);
+    }
+
+    this.#element = elem;
+
+    this.#element.addEventListener('click', () => {
+      this.#open();
+    });
+
+    this.#items = [];
+
+    if (multiselect) {
+      this.#selectedItems = [];
+    }
+
+    if (!items && url) {
+      this.#renderUrl();
+      return;
+    }
+
+    items.forEach((dataItem, index) => {
+      if (dataItem.category && dataItem.categoryItems) {
+        this.#category = dataItem.category;
+
+        this.#items.push(this.#category);
+        dataItem.categoryItems.forEach((categoryItem, indexCategory) => {
+          this.#items.push(getFormatItem(categoryItem, indexCategory));
+        });
+      } else {
+        this.#items.push(getFormatItem(dataItem, index));
+      }
+    });
+  }
+
+  /**
+   * Привaтный метод экземпляра класса DropDown
+   *
+   * @method #initSelected
+   * @param {string} select необязательный елемент. Используется в методе selectIndex
+   * @description Отрисовывает и стилизует селект
+   * @protected
+   */
+  #initSelected(select) {
+    const { styles, selected, placeholder } = this.#options;
+
+    if (selected) {
+      createSelected(this.#element, selected);
+    } else if (placeholder) {
+      createSelected(this.#element, placeholder);
+    } else {
+      createSelected(this.#element, 'Select...');
+    }
+
+    if (styles) {
+      customStyles(this.#element, styles);
+    }
+
+    if (select) {
+      createSelected(this.#element, select, styles);
+    }
+  }
+
+  /**
+   * Приватный метод рендера экземпляра класса DropDown
+   *@protected
+   * @method #render
+   * @param {string} select  необязательный елемент. Передаеться в метод initSelected
+   * @description Рендер елементов в селекте.
+   */
+  #render(select) {
+    const { styles, multiselect } = this.#options;
+
+    if (select || (select && styles)) {
+      this.#initSelected(select);
+      customStyles(this.#element, styles);
+    } else {
+      this.#initSelected();
+    }
+
+    const ulList = document.createElement('ul');
+
+    ulList.classList.add('list');
+
+    if (styles) {
+      const { list } = styles;
+      customStylesFormat(list, ulList);
+    }
+
+    this.#element.appendChild(ulList);
+
+    this.#items.forEach((dataItem) => {
+      const liItem = document.createElement('li');
+      const strongItem = document.createElement('strong');
+
+      liItem.classList.add('list__item');
+      strongItem.classList.add('category');
+
+      if (multiselect) {
+        const checkBox = document.createElement('input');
+        checkBox.type = 'checkbox';
+        checkBox.setAttribute('id', `chbox-${dataItem.id}`);
+
+        liItem.appendChild(checkBox);
+      }
+
+      let textNode = '';
+
+      if (dataItem.title) {
+        textNode = document.createTextNode(dataItem.title);
+        liItem.appendChild(textNode);
+        ulList.appendChild(liItem);
+      } else {
+        textNode = document.createTextNode(dataItem);
+        strongItem.appendChild(textNode);
+        ulList.appendChild(strongItem);
+      }
+    });
+
+    this.#items.filter((item, index) => {
+      if (typeof item !== 'object') {
+        this.#items.splice(index, 1);
+      }
+      return item;
+    });
+
+    this.#addOptionsBehaviour();
+  }
+
+  /**
+   * Приватный метод рендера экземпляра класса DropDown
+   *@protected
+   * @method #renderUrl
+   * @description Рендер елементов в селекте переданных с URL и их настойка
+   */
+  async #renderUrl() {
+    const { url, items, multiselect } = this.#options;
+
+    if (items) {
+      return;
+    }
+
+    if (!url) {
+      return;
+    }
+
+    const response = await fetch(url);
+    const dataUrl = await response.json();
+
+    dataUrl.forEach((dataItem, index) => {
+      const item = {
+        id: dataItem.id,
+        title: dataItem.name,
+        value: index,
+      };
+      const ulUrl = this.#element.querySelector('.list');
+      const liUrl = document.createElement('li');
+      const textUrl = document.createTextNode(item.title);
+
+      if (multiselect) {
+        const checkBox = document.createElement('input');
+        checkBox.type = 'checkbox';
+
+        checkBox.setAttribute('id', `chbox-${item.id}`);
+        liUrl.appendChild(checkBox);
+      }
+
+      liUrl.classList.add('list__item');
+
+      liUrl.appendChild(textUrl);
+      ulUrl.appendChild(liUrl);
+
+      this.#items.push(item);
+    });
+
+    this.#items.filter((item, index) => {
+      if (typeof item !== 'object') {
+        this.#items.splice(index, 1);
+      }
+      return item;
+    });
+
+    this.#addOptionsBehaviour();
+  }
+
+  /**
+   * Приватный метод экземпляра класса DropDown
+   * @protected
+   * @param {boolean} oneClick необязательный параметр передаваемый из функции buttonControl
+   * @description Открывает список для выбора элемента
+   * @method #open
+   */
+  #open(oneClick) {
+    this.#list = this.#element.querySelector('.list');
+    this.#caret = this.#element.querySelector('.caret');
+
+    if (oneClick === true) {
+      this.#list.classList.add('open');
+      this.#caret.classList.add('caret_rotate');
+    } else {
+      this.#list.classList.toggle('open');
+      this.#caret.classList.toggle('caret_rotate');
+    }
+  }
+
+  /**
+   * Приватный метод экземпляра класса DropDown
+   * @protected
+   * @description Закрывает список
+   * @method #close
+   */
+  #close() {
+    this.#list.classList.remove('open');
+    this.#caret.classList.remove('caret_rotate');
+  }
+
+  /**
+   * Приватный метод экземпляра класса DropDown
+   * @protected
+   * @description Метод реализовывающий выбор элементов в разных режимах. Обычный/Мультиселект/Мультиселект + Мультиселект Таг.
+   * @method #addOptionsBehaviour
+   */
+  #addOptionsBehaviour() {
+    const { multiselect, placeholder, selected, multiselectTag } = this.#options;
+
+    const options = this.#element.querySelectorAll('.list__item');
+    const select = this.#element.querySelector('.selected');
+
+    const ul = document.createElement('ul');
+
+    if (multiselect) {
+      ul.classList.add('multiselect-tag');
+      select.classList.add('overflow-hidden');
+    }
+
+    options.forEach((option, index) => {
+      option.addEventListener('click', (event) => {
+        const item = this.#items[index];
+        if (multiselect) {
+          event.stopPropagation();
+          option.classList.toggle('active');
+
+          const checkBox = option.querySelector('input[type="checkbox"]');
+
+          if (checkBox) {
+            if (!(event.target instanceof HTMLInputElement)) {
+              checkBox.checked = !checkBox.checked;
+            }
+
+            const checkIndex = this.#indexes.indexOf(index);
+
+            if (checkIndex === -1) {
+              this.#indexes.push(index);
+
+              select.innerText = '';
+
+              if (multiselectTag) {
+                this.#selectedItems.push(item);
+                select.appendChild(ul);
+
+                const data = {
+                  option: this.#options,
+                  element: this.#element,
+                  indexes: this.#indexes,
+                  selectedItems: this.#selectedItems,
+                };
+
+                ul.appendChild(createBreadcrumb(data, item.title, index, item.id));
+              } else {
+                this.#selectedItems.push(item.title);
+                select.innerText = this.#selectedItems;
+              }
+            } else {
+              if (multiselectTag) {
+                const tagItem = document.getElementById(`tag-${index}-${item.id}`);
+
+                ul.removeChild(tagItem);
+              }
+              this.#indexes.splice(checkIndex, 1);
+              this.#selectedItems.splice(checkIndex, 1);
+            }
+
+            if (!this.#selectedItems.length) {
+              if (placeholder) {
+                select.innerText = placeholder;
+              } else if (selected) {
+                select.innerText = selected;
+              } else {
+                select.innerText = 'Select...';
+              }
+            } else {
+              if (multiselectTag) {
+                select.appendChild(ul);
+              } else {
+                select.innerText = this.#selectedItems;
+              }
+            }
+          }
+        } else {
+          select.innerText = item.title;
+          this.#selectedItems = item;
+
+          options.forEach((option) => {
+            option.classList.remove('active');
+          });
+          option.classList.add('active');
+        }
+      });
+    });
+  }
+
+  /**
+   * Приватный метод экземпляра класса DropDown
+   * @protected
+   * @description Открывает и закрывает список по переданному эвенту
+   * @method #initEvent
+   */
+  #initEvent() {
+    const { event } = this.#options;
+    if (!event) {
+      return;
+    }
+
+    if (event) {
+      if (event === 'mouseenter') {
+        this.#element.addEventListener(event, () => {
+          this.#open();
+        });
+        this.#element.addEventListener('mouseleave', () => {
+          this.#close();
+        });
+      }
+    }
+  }
+}
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/create-element.js.html b/documentation/create-element.js.html new file mode 100644 index 0000000..e629900 --- /dev/null +++ b/documentation/create-element.js.html @@ -0,0 +1,147 @@ + + + + + JSDoc: Source: create-element.js + + + + + + + + + +
+

Source: create-element.js

+ +
+
+
import { customStylesFormat } from './utils';
+/**
+ * @module createElementChips
+ */
+
+/**
+ * Метод который создает и отвечает за поведение chips
+ * @param {object} data объект в котором содержатся настройки и элементы селекта
+ * @param {string} title имя выбранного элемента для отрисовки chips
+ * @param {number} index индекс выбранного элемента для отрисовки chips
+ * @param {string} id уникальное id выбранного элемента
+ * @returns {HTMLElement} возвращает сформированный HTMLElement chips item
+ */
+export function createBreadcrumb(data, title, index, id) {
+  const { element, option, indexes, selectedItems } = data;
+  const { placeholder, styles } = option;
+
+  const selected = element.querySelector('.selected');
+  const liChip = document.createElement('li');
+  const textNode = document.createTextNode(title);
+  const svgIcon = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
+  const path1 = document.createElementNS('http://www.w3.org/2000/svg', 'path');
+  const path2 = document.createElementNS('http://www.w3.org/2000/svg', 'path');
+
+  svgIcon.setAttribute('viewBox', '0 0 10 10');
+  path1.setAttribute('d', 'M3,7 L7,3');
+  path2.setAttribute('d', 'M3,3 L7,7');
+  liChip.setAttribute('id', `tag-${index}-${id}`);
+
+  svgIcon.classList.add('svg-icon');
+
+  svgIcon.appendChild(path1);
+  svgIcon.appendChild(path2);
+  liChip.appendChild(textNode);
+  liChip.appendChild(svgIcon);
+
+  if (styles) {
+    const { chips } = styles;
+    customStylesFormat(chips, liChip);
+  }
+
+  svgIcon.addEventListener('click', (event) => {
+    event.stopPropagation();
+
+    const deleteIcon = indexes.indexOf(index);
+
+    indexes.splice(deleteIcon, 1);
+    selectedItems.splice(deleteIcon, 1);
+
+    let checkBox = '';
+
+    if (id) {
+      checkBox = document.getElementById(`chbox-${id}`);
+    } else {
+      checkBox = document.getElementById(`chbox-${index}`);
+    }
+
+    checkBox.checked = false;
+    checkBox.parentElement.classList.remove('active');
+
+    if (!selectedItems.length) {
+      selected.innerText = placeholder;
+    }
+
+    liChip.parentElement.removeChild(liChip);
+  });
+
+  return liChip;
+}
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/fonts/OpenSans-Bold-webfont.eot b/documentation/fonts/OpenSans-Bold-webfont.eot new file mode 100644 index 0000000..5d20d91 Binary files /dev/null and b/documentation/fonts/OpenSans-Bold-webfont.eot differ diff --git a/documentation/fonts/OpenSans-Bold-webfont.svg b/documentation/fonts/OpenSans-Bold-webfont.svg new file mode 100644 index 0000000..3ed7be4 --- /dev/null +++ b/documentation/fonts/OpenSans-Bold-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/fonts/OpenSans-Bold-webfont.woff b/documentation/fonts/OpenSans-Bold-webfont.woff new file mode 100644 index 0000000..1205787 Binary files /dev/null and b/documentation/fonts/OpenSans-Bold-webfont.woff differ diff --git a/documentation/fonts/OpenSans-BoldItalic-webfont.eot b/documentation/fonts/OpenSans-BoldItalic-webfont.eot new file mode 100644 index 0000000..1f639a1 Binary files /dev/null and b/documentation/fonts/OpenSans-BoldItalic-webfont.eot differ diff --git a/documentation/fonts/OpenSans-BoldItalic-webfont.svg b/documentation/fonts/OpenSans-BoldItalic-webfont.svg new file mode 100644 index 0000000..6a2607b --- /dev/null +++ b/documentation/fonts/OpenSans-BoldItalic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/fonts/OpenSans-BoldItalic-webfont.woff b/documentation/fonts/OpenSans-BoldItalic-webfont.woff new file mode 100644 index 0000000..ed760c0 Binary files /dev/null and b/documentation/fonts/OpenSans-BoldItalic-webfont.woff differ diff --git a/documentation/fonts/OpenSans-Italic-webfont.eot b/documentation/fonts/OpenSans-Italic-webfont.eot new file mode 100644 index 0000000..0c8a0ae Binary files /dev/null and b/documentation/fonts/OpenSans-Italic-webfont.eot differ diff --git a/documentation/fonts/OpenSans-Italic-webfont.svg b/documentation/fonts/OpenSans-Italic-webfont.svg new file mode 100644 index 0000000..e1075dc --- /dev/null +++ b/documentation/fonts/OpenSans-Italic-webfont.svg @@ -0,0 +1,1830 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/fonts/OpenSans-Italic-webfont.woff b/documentation/fonts/OpenSans-Italic-webfont.woff new file mode 100644 index 0000000..ff652e6 Binary files /dev/null and b/documentation/fonts/OpenSans-Italic-webfont.woff differ diff --git a/documentation/fonts/OpenSans-Light-webfont.eot b/documentation/fonts/OpenSans-Light-webfont.eot new file mode 100644 index 0000000..1486840 Binary files /dev/null and b/documentation/fonts/OpenSans-Light-webfont.eot differ diff --git a/documentation/fonts/OpenSans-Light-webfont.svg b/documentation/fonts/OpenSans-Light-webfont.svg new file mode 100644 index 0000000..11a472c --- /dev/null +++ b/documentation/fonts/OpenSans-Light-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/fonts/OpenSans-Light-webfont.woff b/documentation/fonts/OpenSans-Light-webfont.woff new file mode 100644 index 0000000..e786074 Binary files /dev/null and b/documentation/fonts/OpenSans-Light-webfont.woff differ diff --git a/documentation/fonts/OpenSans-LightItalic-webfont.eot b/documentation/fonts/OpenSans-LightItalic-webfont.eot new file mode 100644 index 0000000..8f44592 Binary files /dev/null and b/documentation/fonts/OpenSans-LightItalic-webfont.eot differ diff --git a/documentation/fonts/OpenSans-LightItalic-webfont.svg b/documentation/fonts/OpenSans-LightItalic-webfont.svg new file mode 100644 index 0000000..431d7e3 --- /dev/null +++ b/documentation/fonts/OpenSans-LightItalic-webfont.svg @@ -0,0 +1,1835 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/fonts/OpenSans-LightItalic-webfont.woff b/documentation/fonts/OpenSans-LightItalic-webfont.woff new file mode 100644 index 0000000..43e8b9e Binary files /dev/null and b/documentation/fonts/OpenSans-LightItalic-webfont.woff differ diff --git a/documentation/fonts/OpenSans-Regular-webfont.eot b/documentation/fonts/OpenSans-Regular-webfont.eot new file mode 100644 index 0000000..6bbc3cf Binary files /dev/null and b/documentation/fonts/OpenSans-Regular-webfont.eot differ diff --git a/documentation/fonts/OpenSans-Regular-webfont.svg b/documentation/fonts/OpenSans-Regular-webfont.svg new file mode 100644 index 0000000..25a3952 --- /dev/null +++ b/documentation/fonts/OpenSans-Regular-webfont.svg @@ -0,0 +1,1831 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/documentation/fonts/OpenSans-Regular-webfont.woff b/documentation/fonts/OpenSans-Regular-webfont.woff new file mode 100644 index 0000000..e231183 Binary files /dev/null and b/documentation/fonts/OpenSans-Regular-webfont.woff differ diff --git a/documentation/global.html b/documentation/global.html new file mode 100644 index 0000000..ddcd9df --- /dev/null +++ b/documentation/global.html @@ -0,0 +1,677 @@ + + + + + JSDoc: Global + + + + + + + + + +
+

Global

+ +
+
+

+
+ +
+
+
+
+ +

Members

+ +

+ (protected) #init +

+ +
+ Приватный метод. Общая инициализация селекта. Получение настоек и преобразвание + элементов селекта. +
+ +
+
Source:
+
+ +
+
+ +
Example
+ +
{
+        selector: '.cg-dropdown_one',
+        placeholder: 'Выберите авто',
+        items: [
+          'BMW',
+          {
+            id: '213sade',
+            title: 'Opel',
+            value: 1,
+          },
+          'Mersedes',
+          'MAN',
+          'max',
+        ],
+        multiselect: true,
+        multiselectTag: true,
+      }
+ +

Methods

+ +

+ (protected) #addOptionsBehaviour() +

+ +
+ Метод реализовывающий выбор элементов в разных режимах. + Обычный/Мультиселект/Мультиселект + Мультиселект Таг. +
+ +
+
Source:
+
+ +
+
+ +

+ (protected) #close() +

+ +
Закрывает список
+ +
+
Source:
+
+ +
+
+ +

+ (protected) #initEvent() +

+ +
Открывает и закрывает список по переданному эвенту
+ +
+
Source:
+
+ +
+
+ +

+ (protected) #initSelected(select) +

+ +
Отрисовывает и стилизует селект
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
select + string + + необязательный елемент. Используется в методе selectIndex +
+ +
+
Source:
+
+ +
+
+ +

+ (protected) #open(oneClick) +

+ +
Открывает список для выбора элемента
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
oneClick + boolean + + необязательный параметр передаваемый из функции buttonControl +
+ +
+
Source:
+
+ +
+
+ +

+ (protected) #render(select) +

+ +
Рендер елементов в селекте.
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
select + string + + необязательный елемент. Передаеться в метод initSelected +
+ +
+
Source:
+
+ +
+
+ +

+ (protected) #renderUrl() +

+ +
Рендер елементов в селекте переданных с URL и их настойка
+ +
+
Source:
+
+ +
+
+ +

+ addItem(item) +

+ +
+ добавляет переданный элемент в конец списка и перерисовывает список. Не может + использоваться при передачи элементов с категорями +
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
item + string + | + + object + добавляемый елемент
+ +
+
Source:
+
+ +
+
+ +

+ buttonControl(button, method) +

+ +
+ Метод позволяющий открывать/закрывать селект с помощью кнопок +
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
button + HTMLInputElement + HTML кнопка
method + string + метод открытия open/close
+ +
+
Source:
+
+ +
+
+ +

+ deleteItem(index) +

+ +
+ удаляет елемент по индексу из списка и перерисовывает его. Не может использоваться при + передачи элементов с категорями. +
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
index + number + индекс удаляемого элемента
+ +
+
Source:
+
+ +
+
+ +

+ deleteItemAll() +

+ +
удаляет все елементы из списка и перерисовывает его.
+ +
+
Source:
+
+ +
+
+ +

+ disabled(value) +

+ +
Метод позволяющий переключать состояние селекта disabled,
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
value + boolean + + Передаваемый параметр для добавления атрибута disabled; +
+ +
+
Source:
+
+ +
+
+ +

+ getElement(numberItem) → {HTMLElement} +

+ +
Метод экземпляра класса DropDown
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
numberItem + number + номер возвращаемого элемента
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
возвращает ссылку на выбранный HTML элемент
+ +
+
Type
+
+ HTMLElement +
+
+ +

+ selectIndex(index) +

+ +
+ выбирает элемент который будет изначально отрисовываться в селекте +
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
index + number + индекс выбранного элемента
+ +
+
Source:
+
+ +
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/index.html b/documentation/index.html new file mode 100644 index 0000000..1ce8330 --- /dev/null +++ b/documentation/index.html @@ -0,0 +1,67 @@ + + + + + JSDoc: Home + + + + + + + + + +
+

Home

+ +

+
+ + + +
+ + + + + + + diff --git a/documentation/module-Utils.html b/documentation/module-Utils.html new file mode 100644 index 0000000..51ca858 --- /dev/null +++ b/documentation/module-Utils.html @@ -0,0 +1,404 @@ + + + + + JSDoc: Module: util; + + + + + + + + + +
+

Module: Utils

+ +
+
+ +
+
+
Utils module
+ +
+
Source:
+
+ +
+
+
+ +

Methods

+ +

+ (static) checkItemStruct(item) → {boolean} +

+ +
Проверка содержит ли item указанные свойства,
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
item + object + проверяемый на определенную структуру элемент
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
возвращает true/false если item содержит указанные свойства
+ +
+
Type
+
+ boolean +
+
+ +

+ (static) createSelected(element, content, styles) +

+ +
Создание кнопки выбора элементов
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + HTMLElement + созданный экземпляр класса DropDown
content + string + placeholer передаваемый из настроек селекта
styles + object + + не обязательный параметр. Объект в котором находяться настройки кастомизации + частей селекта +
+ +
+
Source:
+
+ +
+
+ +

+ (static) customStyles(element, styles) +

+ +
+ Поиск и стилизация елементов полученных из styles экземпляра DropDown +
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + HTMLElement + созданный экземпляр класса DropDown
styles + object + + объект в котором находяться настройки кастомизации частей селекта +
+ +
+
Source:
+
+ +
+
+ +

+ (static) customStylesFormat(elemOption, selector) +

+ +
Универсальный метод для стилизации селекта
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
elemOption + object + + объект полученное из объекта styles у которого мы получаем ключ-значение стилей +
selector + HTMLElement + HTMLElement подвергающиеся кастомизации
+ +
+
Source:
+
+ +
+
+ +

+ (static) getFormatItem(dataItem, index) → {object} +

+ +
Преобразование каждого елемента полученного из поля Items;
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
dataItem + object + | + + string + + полученный елемент переданный при создании селекта может быть как object/string +
index + number + индекс этого элемента
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
возвращает сформированный объект
+ +
+
Type
+
+ object +
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/module-createElementChips.html b/documentation/module-createElementChips.html new file mode 100644 index 0000000..5fc573c --- /dev/null +++ b/documentation/module-createElementChips.html @@ -0,0 +1,169 @@ + + + + + JSDoc: Module: createElementChips + + + + + + + + + +
+

Module: createElementChips

+ +
+
+ +
+
+ +

Methods

+ +

+ (static) createBreadcrumb(data, title, index, id) → {HTMLElement} +

+ +
Метод который создает и отвечает за поведение chips
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
data + object + + объект в котором содержатся настройки и элементы селекта +
title + string + имя выбранного элемента для отрисовки chips
index + number + индекс выбранного элемента для отрисовки chips
id + string + уникальное id выбранного элемента
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
возвращает сформированный HTMLElement chips item
+ +
+
Type
+
+ HTMLElement +
+
+
+
+
+ + + +
+ + + + + + + diff --git a/documentation/scripts/linenumber.js b/documentation/scripts/linenumber.js new file mode 100644 index 0000000..4354785 --- /dev/null +++ b/documentation/scripts/linenumber.js @@ -0,0 +1,25 @@ +/*global document */ +(() => { + const source = document.getElementsByClassName('prettyprint source linenums'); + let i = 0; + let lineNumber = 0; + let lineId; + let lines; + let totalLines; + let anchorHash; + + if (source && source[0]) { + anchorHash = document.location.hash.substring(1); + lines = source[0].getElementsByTagName('li'); + totalLines = lines.length; + + for (; i < totalLines; i++) { + lineNumber++; + lineId = `line${lineNumber}`; + lines[i].id = lineId; + if (lineId === anchorHash) { + lines[i].className += ' selected'; + } + } + } +})(); diff --git a/documentation/scripts/prettify/Apache-License-2.0.txt b/documentation/scripts/prettify/Apache-License-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/documentation/scripts/prettify/Apache-License-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/documentation/scripts/prettify/lang-css.js b/documentation/scripts/prettify/lang-css.js new file mode 100644 index 0000000..041e1f5 --- /dev/null +++ b/documentation/scripts/prettify/lang-css.js @@ -0,0 +1,2 @@ +PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", +/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/documentation/scripts/prettify/prettify.js b/documentation/scripts/prettify/prettify.js new file mode 100644 index 0000000..eef5ad7 --- /dev/null +++ b/documentation/scripts/prettify/prettify.js @@ -0,0 +1,28 @@ +var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; +(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= +[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), +l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, +q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, +q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, +"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), +a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} +for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], +"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], +H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], +J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ +I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), +["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", +/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), +["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", +hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= +!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p th:last-child { border-right: 1px solid #ddd; } + +.ancestors, .attribs { color: #999; } +.ancestors a, .attribs a +{ + color: #999 !important; + text-decoration: none; +} + +.clear +{ + clear: both; +} + +.important +{ + font-weight: bold; + color: #950B02; +} + +.yes-def { + text-indent: -1000px; +} + +.type-signature { + color: #aaa; +} + +.name, .signature { + font-family: Consolas, Monaco, 'Andale Mono', monospace; +} + +.details { margin-top: 14px; border-left: 2px solid #DDD; } +.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; } +.details dd { margin-left: 70px; } +.details ul { margin: 0; } +.details ul { list-style-type: none; } +.details li { margin-left: 30px; padding-top: 6px; } +.details pre.prettyprint { margin: 0 } +.details .object-value { padding-top: 0; } + +.description { + margin-bottom: 1em; + margin-top: 1em; +} + +.code-caption +{ + font-style: italic; + font-size: 107%; + margin: 0; +} + +.source +{ + border: 1px solid #ddd; + width: 80%; + overflow: auto; +} + +.prettyprint.source { + width: inherit; +} + +.source code +{ + font-size: 100%; + line-height: 18px; + display: block; + padding: 4px 12px; + margin: 0; + background-color: #fff; + color: #4D4E53; +} + +.prettyprint code span.line +{ + display: inline-block; +} + +.prettyprint.linenums +{ + padding-left: 70px; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.prettyprint.linenums ol +{ + padding-left: 0; +} + +.prettyprint.linenums li +{ + border-left: 3px #ddd solid; +} + +.prettyprint.linenums li.selected, +.prettyprint.linenums li.selected * +{ + background-color: lightyellow; +} + +.prettyprint.linenums li * +{ + -webkit-user-select: text; + -moz-user-select: text; + -ms-user-select: text; + user-select: text; +} + +.params .name, .props .name, .name code { + color: #4D4E53; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 100%; +} + +.params td.description > p:first-child, +.props td.description > p:first-child +{ + margin-top: 0; + padding-top: 0; +} + +.params td.description > p:last-child, +.props td.description > p:last-child +{ + margin-bottom: 0; + padding-bottom: 0; +} + +.disabled { + color: #454545; +} diff --git a/documentation/styles/prettify-jsdoc.css b/documentation/styles/prettify-jsdoc.css new file mode 100644 index 0000000..5a2526e --- /dev/null +++ b/documentation/styles/prettify-jsdoc.css @@ -0,0 +1,111 @@ +/* JSDoc prettify.js theme */ + +/* plain text */ +.pln { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* string content */ +.str { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a keyword */ +.kwd { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a comment */ +.com { + font-weight: normal; + font-style: italic; +} + +/* a type name */ +.typ { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a literal value */ +.lit { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* punctuation */ +.pun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp open bracket */ +.opn { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* lisp close bracket */ +.clo { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a markup tag name */ +.tag { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute name */ +.atn { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a markup attribute value */ +.atv { + color: #006400; + font-weight: normal; + font-style: normal; +} + +/* a declaration */ +.dec { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* a variable name */ +.var { + color: #000000; + font-weight: normal; + font-style: normal; +} + +/* a function name */ +.fun { + color: #000000; + font-weight: bold; + font-style: normal; +} + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; +} diff --git a/documentation/styles/prettify-tomorrow.css b/documentation/styles/prettify-tomorrow.css new file mode 100644 index 0000000..b6f92a7 --- /dev/null +++ b/documentation/styles/prettify-tomorrow.css @@ -0,0 +1,132 @@ +/* Tomorrow Theme */ +/* Original theme - https://github.com/chriskempson/tomorrow-theme */ +/* Pretty printing styles. Used with prettify.js. */ +/* SPAN elements with the classes below are added by prettyprint. */ +/* plain text */ +.pln { + color: #4d4d4c; } + +@media screen { + /* string content */ + .str { + color: #718c00; } + + /* a keyword */ + .kwd { + color: #8959a8; } + + /* a comment */ + .com { + color: #8e908c; } + + /* a type name */ + .typ { + color: #4271ae; } + + /* a literal value */ + .lit { + color: #f5871f; } + + /* punctuation */ + .pun { + color: #4d4d4c; } + + /* lisp open bracket */ + .opn { + color: #4d4d4c; } + + /* lisp close bracket */ + .clo { + color: #4d4d4c; } + + /* a markup tag name */ + .tag { + color: #c82829; } + + /* a markup attribute name */ + .atn { + color: #f5871f; } + + /* a markup attribute value */ + .atv { + color: #3e999f; } + + /* a declaration */ + .dec { + color: #f5871f; } + + /* a variable name */ + .var { + color: #c82829; } + + /* a function name */ + .fun { + color: #4271ae; } } +/* Use higher contrast and text-weight for printable form. */ +@media print, projection { + .str { + color: #060; } + + .kwd { + color: #006; + font-weight: bold; } + + .com { + color: #600; + font-style: italic; } + + .typ { + color: #404; + font-weight: bold; } + + .lit { + color: #044; } + + .pun, .opn, .clo { + color: #440; } + + .tag { + color: #006; + font-weight: bold; } + + .atn { + color: #404; } + + .atv { + color: #060; } } +/* Style */ +/* +pre.prettyprint { + background: white; + font-family: Consolas, Monaco, 'Andale Mono', monospace; + font-size: 12px; + line-height: 1.5; + border: 1px solid #ccc; + padding: 10px; } +*/ + +/* Specify class=linenums on a pre to get line numbering */ +ol.linenums { + margin-top: 0; + margin-bottom: 0; } + +/* IE indents via margin-left */ +li.L0, +li.L1, +li.L2, +li.L3, +li.L4, +li.L5, +li.L6, +li.L7, +li.L8, +li.L9 { + /* */ } + +/* Alternate shading for lines */ +li.L1, +li.L3, +li.L5, +li.L7, +li.L9 { + /* */ } diff --git a/documentation/utils.js.html b/documentation/utils.js.html new file mode 100644 index 0000000..0f22e40 --- /dev/null +++ b/documentation/utils.js.html @@ -0,0 +1,193 @@ + + + + + JSDoc: Source: utils.js + + + + + + + + + +
+

Source: utils.js

+ +
+
+
/**
+ * Utils module
+ * @module Utils;
+ */
+
+/**
+ * Создание кнопки выбора элементов
+ * @param {HTMLElement} element созданный экземпляр класса DropDown
+ * @param {string} content placeholer передаваемый из настроек селекта
+ * @param {object} styles не обязательный параметр. Объект в котором находяться настройки кастомизации частей селекта
+ */
+export function createSelected(element, content, styles) {
+  if (content) {
+    element.innerHTML = `
+      <div class="cg-select">
+         <p class="selected">${content}</p>
+          <div class="caret"></div>
+       </div>
+      `;
+  }
+
+  if (styles) {
+    customStyles(element, styles);
+
+    element.innerHTML = `
+      <div class="cg-select" style = "${styles}">
+          <p class="selected" style = "${styles}">${content}</p>
+          <div class="caret" style = "${styles}"></div>
+      </div>
+    `;
+  }
+}
+
+/**
+ * Поиск и стилизация елементов полученных из styles экземпляра DropDown
+ * @param {HTMLElement} element созданный экземпляр класса DropDown
+ * @param {object} styles объект в котором находяться настройки кастомизации частей селекта
+ */
+export function customStyles(element, styles) {
+  if (!styles) {
+    return;
+  }
+
+  const { head, caret, placeholder } = styles;
+
+  const cgSelect = element.querySelector('.cg-select');
+  const caretSelect = element.querySelector('.caret');
+  const placeholderSelect = element.querySelector('.selected');
+
+  customStylesFormat(head, cgSelect);
+
+  customStylesFormat(caret, caretSelect);
+
+  if (placeholderSelect) {
+    customStylesFormat(placeholder, placeholderSelect);
+  }
+}
+
+// export function customStylesFormat(elemOption, selector) {
+//   if (elemOption) {
+//     Object.entries(elemOption).forEach(([key, value]) => {
+//       selector.style[key] = value;
+//     });
+//   }
+// }
+/**
+ * Универсальный метод для стилизации селекта
+ * @param {object} elemOption объект полученное из объекта styles у которого мы получаем ключ-значение стилей
+ * @param {HTMLElement} selector  HTMLElement подвергающиеся кастомизации
+ */
+exports.customStylesFormat = (elemOption, selector) => {
+  if (elemOption) {
+    Object.entries(elemOption).forEach(([key, value]) => {
+      selector.style[key] = value;
+    });
+  }
+};
+
+/**
+ * Проверка содержит ли item  указанные свойства,
+ * @param {object} item проверяемый на определенную структуру элемент
+ * @returns {boolean} возвращает true/false если item содержит указанные свойства
+ */
+export function checkItemStruct(item) {
+  if (item && typeof item !== 'object') {
+    return false;
+  }
+
+  return item.hasOwnProperty('id') && item.hasOwnProperty('title') && item.hasOwnProperty('value');
+}
+
+/**
+ * Преобразование каждого елемента полученного из поля Items;
+ * @param {object | string} dataItem полученный елемент переданный при создании селекта может быть как object/string
+ * @param {number} index индекс этого элемента
+ * @returns {object} возвращает сформированный объект
+ */
+export function getFormatItem(dataItem, index) {
+  const random = Math.random().toString(36).substring(2, 10);
+  let item = {};
+
+  if (checkItemStruct(dataItem)) {
+    item = {
+      id: dataItem.id,
+      title: dataItem.title,
+      value: index,
+    };
+  } else {
+    item = {
+      id: random,
+      title: dataItem,
+      value: index,
+    };
+  }
+
+  return item;
+}
+
+
+
+
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Wed + Oct 19 2022 18:07:14 GMT+0300 (Moscow Standard Time) +
+ + + + + diff --git a/src/cg-dropdown.js b/src/cg-dropdown.js index a43ab33..67769df 100644 --- a/src/cg-dropdown.js +++ b/src/cg-dropdown.js @@ -1,40 +1,115 @@ import { - customStyles, createSelected, + customStyles, getFormatItem, customStylesFormat, } from './components/utils'; import { createBreadcrumb } from './components/create-element'; +/** + * @class Описание класса DropDown + * @description Этот класс реализовывает функционал кастомного селекта, с возможностями кастомизации. + *@author Овсяников Максим + */ export class DropDown { - // Глобальные переменные класса + /** + * Созданный HTML елемент + * @type {HTMLElement} + */ #element; + /** + * Созданный список(ul), с классом list + * @type {HTMLElement} + */ #list; + /** + * Настройки селекта передаваемые при создании экземпляра класса + * @type {object} + */ #options; + /** + * Переменная для управления каретки + * @type {HTMLElement} + */ #caret; + /** + * Массив переданных элементов + * @type {object[]} + */ #items; + /** + * Переданные категории + * @type {string} + */ #category; + /** + * Выбранный или массив выбранных элементов из списка + * @type {object[] | object} + */ #selectedItems; + /** + * Массив индексов выбранных элементов + * @type {number[]} + */ #indexes = []; - // Геттер возвращающий выбранные элементы + /** + * Метод экземпляра класса DropDown + * @returns {string[] | string | null} Возвращает выбранные элемент(ы) в виде массива/элемента/null + * @description Геттер возвращающий выбранные элемент(ы) селекта + */ get value() { return this.#selectedItems ?? null; } - // Геттер возвращающий индексы выбранных элементов + /** + * Метод экземпляра класса DropDown + * @returns {number | number[]}Возвращает индексы выбранных элемента(ов) в виде массива/пустой массив + * @description Геттер возвращающий индексы выбранных элемента(ов) селекта + */ get indexes() { return this.#indexes ?? []; } - // Конструктор принимающий настройки селекта + /** + * + * @param {object} options Объект принимающий настройки селекта + * @constructor Конструктор класса DropDown + * @description Конструктор принимает объект и рендерит селект. + * @example + * options = { + * selector: 'Уникальный селектор', + selected: 'Выбранный элемент', + placeholder: '...', + items: [string|number|object], + styles: { + head: { + background: '...', + }, + list: {...}, + chips: {...}, + caret: {...}, + placeholder: {...}, + }, + event: '...', + url: 'http/...', + multiselect: true/false, + multiselectTag: true/false, + * } + + */ constructor(options = {}) { this.#init(options); this.#render(); this.#initEvent(); } - // Метод добавления елемента в список index == string/object + /** + * Метод экземпляра класса DropDown + * @param {string | object} item добавляемый елемент + * @description добавляет переданный элемент в конец списка и перерисовывает список. Не может использоваться при передачи элементов с категорями + * @method addItem + */ addItem(item) { if (this.#category) { console.log('can`t add item to category'); @@ -51,7 +126,12 @@ export class DropDown { this.#render(); } - // Метод удаления елемента из спискаindex == number + /** + * Метод экземпляра класса DropDown + * @param {number} index индекс удаляемого элемента + * @description удаляет елемент по индексу из списка и перерисовывает его. Не может использоваться при передачи элементов с категорями. + * @method deleteItem + */ deleteItem(index) { if (this.#category) { console.log('can`t add item to category'); @@ -64,13 +144,22 @@ export class DropDown { this.#render(); } - // Метод удаляющий все элементы списка. + /** + * Метод экземпляра класса DropDown + * @description удаляет все елементы из списка и перерисовывает его. + * @method deleteItemAll + */ deleteItemAll() { this.#items.splice(0, this.#items.length); this.#render(); } - // Метод позволяющий в селекте выбрать элемент который будет изначально отрисовывать, index == number + /** + * Метод экземпляра класса DropDown + * @param {number} index индекс выбранного элемента + * @description выбирает элемент который будет изначально отрисовываться в селекте + * @method selectIndex + */ selectIndex(index) { if (this.#category) { console.log('can`t add item to category'); @@ -87,12 +176,25 @@ export class DropDown { this.#render(select); } - // Метод возвращающий елемент по номеру, number == number - getElement(number) { - return this.#items[number]; + /** + * Метод экземпляра класса DropDown + * @param {number} numberItem номер возвращаемого элемента + * @returns {HTMLElement} возвращает ссылку на выбранный HTML элемент + * @method getElement + */ + getElement(numberItem) { + if (numberItem > this.#items.length) { + return; + } + return this.#items[numberItem]; } - // Метод позволяющий сделать селект disabled, value == boolean; + /** + * Метод экземпляра класса DropDown + * @param {boolean} value - Передаваемый параметр для добавления атрибута disabled; + * @description Метод позволяющий переключать состояние селекта disabled, + * @method disabled + */ disabled(value) { if (typeof value !== 'boolean') { return; @@ -108,7 +210,13 @@ export class DropDown { } } - // Метод позволяющий открывать/закрывать селект с помощью кнопок, button == внешняя кнопка(HTMLElement); method == string; + /** + * Метод экземпляра класса DropDown + * @param {HTMLInputElement} button - HTML кнопка + * @param {string} method - метод открытия open/close + * @description Метод позволяющий открывать/закрывать селект с помощью кнопок + * @method buttonControl + */ buttonControl(button, method) { button.addEventListener('click', () => { if (method === 'open') { @@ -121,7 +229,32 @@ export class DropDown { }); } - // Общая инициализация селекта и формирование элементов + /** + * Приватный метод инициализации экземпляра класса DropDown + * @method #init + * @member + * @protected + * @param {object} options передаваемые настройки селекта + * @description Приватный метод. Общая инициализация селекта. Получение настоек и преобразвание элементов селекта. + * @example + * { + selector: '.cg-dropdown_one', + placeholder: 'Выберите авто', + items: [ + 'BMW', + { + id: '213sade', + title: 'Opel', + value: 1, + }, + 'Mersedes', + 'MAN', + 'max', + ], + multiselect: true, + multiselectTag: true, + } + */ #init(options) { this.#options = options; const { items, multiselect, url } = this.#options; @@ -163,7 +296,14 @@ export class DropDown { }); } - // Метод отрисовывающий кнопку селекта и каретку + /** + * Привaтный метод экземпляра класса DropDown + * + * @method #initSelected + * @param {string} select необязательный елемент. Используется в методе selectIndex + * @description Отрисовывает и стилизует селект + * @protected + */ #initSelected(select) { const { styles, selected, placeholder } = this.#options; @@ -184,7 +324,13 @@ export class DropDown { } } - // Общий рендер элементов в список и их настойка + /** + * Приватный метод рендера экземпляра класса DropDown + *@protected + * @method #render + * @param {string} select необязательный елемент. Передаеться в метод initSelected + * @description Рендер елементов в селекте. + */ #render(select) { const { styles, multiselect } = this.#options; @@ -244,7 +390,12 @@ export class DropDown { this.#addOptionsBehaviour(); } - // Общий рендер элементов в список и их настойка с получением данных с URL + /** + * Приватный метод рендера экземпляра класса DropDown + *@protected + * @method #renderUrl + * @description Рендер елементов в селекте переданных с URL и их настойка + */ async #renderUrl() { const { url, items, multiselect } = this.#options; @@ -295,7 +446,13 @@ export class DropDown { this.#addOptionsBehaviour(); } - // Метод открывающий список + /** + * Приватный метод экземпляра класса DropDown + * @protected + * @param {boolean} oneClick необязательный параметр передаваемый из функции buttonControl + * @description Открывает список для выбора элемента + * @method #open + */ #open(oneClick) { this.#list = this.#element.querySelector('.list'); this.#caret = this.#element.querySelector('.caret'); @@ -309,13 +466,23 @@ export class DropDown { } } - // Метод закрывающий список + /** + * Приватный метод экземпляра класса DropDown + * @protected + * @description Закрывает список + * @method #close + */ #close() { this.#list.classList.remove('open'); this.#caret.classList.remove('caret_rotate'); } - // Метод реализовывающий выбор элементов в разных режимах. Обычный/Мультиселект/Мультиселект + мультиселект таг. + /** + * Приватный метод экземпляра класса DropDown + * @protected + * @description Метод реализовывающий выбор элементов в разных режимах. Обычный/Мультиселект/Мультиселект + Мультиселект Таг. + * @method #addOptionsBehaviour + */ #addOptionsBehaviour() { const { multiselect, placeholder, selected, multiselectTag } = this.#options; @@ -405,7 +572,12 @@ export class DropDown { }); } - // Метод позволяющий открывать/закрывать список по переданному эвенту. + /** + * Приватный метод экземпляра класса DropDown + * @protected + * @description Открывает и закрывает список по переданному эвенту + * @method #initEvent + */ #initEvent() { const { event } = this.#options; if (!event) { diff --git a/src/components/create-element.js b/src/components/create-element.js index da418c3..e27739a 100644 --- a/src/components/create-element.js +++ b/src/components/create-element.js @@ -1,6 +1,16 @@ import { customStylesFormat } from './utils'; +/** + * @module createBreadcrumb + */ -// Метод который создает и отвечает за поведение chips +/** + * Метод который создает и отвечает за поведение chips + * @param {object} data объект в котором содержатся настройки и элементы селекта + * @param {string} title имя выбранного элемента для отрисовки chips + * @param {number} index индекс выбранного элемента для отрисовки chips + * @param {string} id уникальное id выбранного элемента + * @returns {HTMLElement} возвращает сформированный HTMLElement chips item + */ export function createBreadcrumb(data, title, index, id) { const { element, option, indexes, selectedItems } = data; const { placeholder, styles } = option; diff --git a/src/components/utils.js b/src/components/utils.js index 4950db2..c254b26 100644 --- a/src/components/utils.js +++ b/src/components/utils.js @@ -1,10 +1,20 @@ -// Создание селектора +/** + * Utils module + * @module Utils + */ + +/** + * Создание кнопки выбора элементов + * @param {HTMLElement} element созданный экземпляр класса DropDown + * @param {string} content placeholer передаваемый из настроек селекта + * @param {object} styles не обязательный параметр. Объект в котором находяться настройки кастомизации частей селекта + */ export function createSelected(element, content, styles) { if (content) { element.innerHTML = `

${content}

-
+
`; } @@ -14,14 +24,18 @@ export function createSelected(element, content, styles) { element.innerHTML = `
- ${content} +

${content}

`; } } -// Метод ищет и стилизует полученные елементы из styles +/** + * Поиск и стилизация елементов полученных из styles экземпляра DropDown + * @param {HTMLElement} element созданный экземпляр класса DropDown + * @param {object} styles объект в котором находяться настройки кастомизации частей селекта + */ export function customStyles(element, styles) { if (!styles) { return; @@ -42,7 +56,24 @@ export function customStyles(element, styles) { } } -// Метод checkItemStruct возвращает true/false если item содержит указанные свойства, +/** + * Универсальный метод для стилизации селекта + * @param {object} elemOption объект полученное из объекта styles у которого мы получаем ключ-значение стилей + * @param {HTMLElement} selector HTMLElement подвергающиеся кастомизации + */ +export function customStylesFormat(elemOption, selector) { + if (elemOption) { + Object.entries(elemOption).forEach(([key, value]) => { + selector.style[key] = value; + }); + } +} + +/** + * Проверка содержит ли item указанные свойства, + * @param {object} item проверяемый на определенную структуру элемент + * @returns {boolean} возвращает true/false если item содержит указанные свойства + */ export function checkItemStruct(item) { if (item && typeof item !== 'object') { return false; @@ -51,7 +82,12 @@ export function checkItemStruct(item) { return item.hasOwnProperty('id') && item.hasOwnProperty('title') && item.hasOwnProperty('value'); } -// Метод getFormatItem преобразовывает каждый елемент полученный из поля Items; +/** + * Преобразование каждого елемента полученного из поля Items; + * @param {object | string} dataItem полученный елемент переданный при создании селекта может быть как object/string + * @param {number} index индекс этого элемента + * @returns {object} возвращает сформированный объект + */ export function getFormatItem(dataItem, index) { const random = Math.random().toString(36).substring(2, 10); let item = {}; @@ -72,12 +108,3 @@ export function getFormatItem(dataItem, index) { return item; } - -// Универсальный метод для стилизации селекта -export function customStylesFormat(elemOption, selector) { - if (elemOption) { - Object.entries(elemOption).forEach(([key, value]) => { - selector.style[key] = value; - }); - } -} diff --git a/src/index.js b/src/index.js index b62ccb4..ed3c042 100644 --- a/src/index.js +++ b/src/index.js @@ -4,7 +4,17 @@ import { DropDown } from './cg-dropdown'; const dropdown = new DropDown({ selector: '.cg-dropdown_one', placeholder: 'Выберите авто', - items: ['BMW', 'Opel', 'Mersedes', 'MAN', 'max'], + items: [ + 'BMW', + { + id: '213sade', + title: 'Opel', + value: 1, + }, + 'Mersedes', + 'MAN', + 'max', + ], multiselect: true, multiselectTag: true, });