cloud-ide-lms-model/lib/common-types/common.d.ts

Package for Model management of Cloud IDEsys LMS

import { IEntityErrorLogger } from "../model/core/core_system_entity";
/** @description Label placement options: 'floating' will move if value is set or removed, 'fixed' will stay at the same position */
export type labelPlacementType = 'floating' | 'fixed';
/** @description Type of control */
export type controlType = "date" | "datetime-local" | "email" | "month" | "number" | "password" | "search" | "tel" | "text" | "time" | "url" | "week" | "checkbox" | "select" | "";
/** @description Input types allowed to set value */
export type inputType = number | string | undefined | null | boolean;
/** @description Label direction from start or end of control */
export type labelDirType = 'start' | 'end';
/** @description Auto capitalization for the value, applicable to words or complete sentences */
export type autocapitalizeType = "on" | "off" | "words" | 'sentences';
/** @description Auto complete type to help reader understand the type of value */
export type autocompleteType = "name" | "email" | "tel" | "url" | "on" | "off" | "honorific-prefix" | "given-name" | "additional-name" | "family-name" | "honorific-suffix" | "nickname" | "username" | "new-password" | "current-password" | "one-time-code" | "organization-title" | "organization" | "street-address" | "address-line1" | "address-line2" | "address-line3" | "address-level4" | "address-level3" | "address-level2" | "address-level1" | "country" | "country-name" | "postal-code" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-number" | "cc-exp" | "cc-exp-month" | "cc-exp-year" | "cc-csc" | "cc-type" | "transaction-currency" | "transaction-amount" | "language" | "bday" | "bday-day" | "bday-month" | "bday-year" | "sex" | "tel-country-code" | "tel-national" | "tel-area-code" | "tel-local" | "tel-extension" | "impp" | "photo";
/** @description Size of control */
export type themeSize = "3xs" | "2xs" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
/** @description Loader type like pill or spinner */
export type spinnerType = "spinner" | "pill-spinner";
/** @description Type of icon behavior */
export type iconType = "round" | "box" | "none";
/**
 * @description Type of input style like solid, outline, or standard
 * @example solid: solid border and background color, outline: border with outline, standard: no border
 */
export type elementStyleType = "solid" | "outline" | "standard";
export interface MRequestMiddelware {
    Validate?: Function;
}
/** data return type for select on search */
export type selectSearchType = {
    query: string;
    value: string | number;
};
export declare class MTableQueries {
    total?: number;
    pageIndex?: number;
    pageSize?: number;
    query?: string;
    sort?: {
        order: 'asc' | 'desc' | '';
        key: string | number;
    };
    constructor(init: MTableQueries);
    Validate?(): Partial<IEntityErrorLogger>;
}
export type TableQueries = MTableQueries;
export declare const initialTableData: TableQueries;
export type listView = 'grid' | 'list';
export type FilterQuery = {
    sort: 'asc' | 'desc' | '';
    search: '';
};
export interface paginationQueryResponse {
    paginatedResults: any[];
    totalDocument: number;
}
export interface CommonSelect {
    label: string;
    value: string;
}