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

@ -9,7 +9,7 @@
"homepage": "https://cg-select.itguild.info", "homepage": "https://cg-select.itguild.info",
"scripts": { "scripts": {
"start": "parcel example/index.html -p 4500 --open ", "start": "parcel example/index.html -p 4500 --open ",
"build": "parcel build index.js", "build": "parcel build index.ts",
"deploy": "gh-pages -d dist", "deploy": "gh-pages -d dist",
"predeploy": "npm run build" "predeploy": "npm run build"
}, },

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -1,6 +1,5 @@
{ {
"compilerOptions": { "compilerOptions": {
/* Projects */ /* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
@ -10,7 +9,7 @@
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */ /* Language and Environment */
"target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ "target": "es2017" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */ // "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
@ -24,7 +23,7 @@
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */ /* Modules */
"module": "commonjs", /* Specify what module code is generated. */ "module": "commonjs" /* Specify what module code is generated. */,
// "rootDir": "./", /* Specify the root folder within your source files. */ // "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
@ -48,7 +47,7 @@
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */ // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */ "outDir": "build" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */ // "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */ // "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
@ -70,12 +69,12 @@
/* Interop Constraints */ /* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
/* Type Checking */ /* Type Checking */
"strict": true, /* Enable all strict type-checking options. */ "strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */