Added descriptions in interfaces

This commit is contained in:
2023-01-16 15:43:45 +03:00
parent ae258e68f4
commit 0542278467
7 changed files with 29 additions and 9 deletions

View File

@ -1,5 +1,8 @@
import { ICgSelect } from '../../interfaces/cg-select.interface';
/**
* @description Настройки для создания чипсов.
*/
export interface ICreateBreadCrumb {
/**
* Определенный экземпляр класса.

View File

@ -1,5 +1,8 @@
import { IItems } from '../../interfaces/items.interface';
/**
* @description Настройки получаемых элементов.
*/
export interface IDataItem {
/**
* Необязательный параметр. Категория группы элементов.
@ -18,6 +21,9 @@ export interface IDataItem {
ItemValue: string | IItems | number;
}
/**
* @description Настройки для текста селекта и тд.
*/
export interface ISelectedItems {
/**
* Placeholder необязательный параметр, в который передается текст плейсхолдера селекта.

View File

@ -1,5 +1,8 @@
import { IItems } from './items.interface';
/**
* @description Настройки селекта.
*/
export interface ICgSelect {
/**
* Уникальный селектор - *обязательный параметр(индефикатор), который задаеться при создании селекта.
@ -91,6 +94,9 @@ export interface ICgSelect {
multiselectTag?: boolean;
}
/**
* @description Настройки стилей.
*/
export interface IStyle {
/**
* Кастомизация кнопки селекта.

View File

@ -1,3 +1,6 @@
/**
* @description Строение элемента.
*/
export interface IItems {
/**
* Уникальное ID элемента

View File

@ -1,3 +1,6 @@
/**
* @description Настройки для добавления языков.
*/
export interface ILanguage {
/**
* Текст в поиске.