@steroidsjs/core 2.3.0-beta.6 → 2.3.0-beta.9

package/hooks/useList.d.ts

@@ -1,201 +1,206 @@
-import { IApiMethod } from '../components/ApiComponent';
-import { IAddressBarConfig } from '../hooks/useAddressBar';
-import { IList } from '../actions/list';
-import { ILayoutNamesProps } from '../ui/list/LayoutNames/LayoutNames';
-import { IPaginationProps } from '../ui/list/Pagination/Pagination';
-import { IPaginationSizeProps } from '../ui/list/PaginationSize/PaginationSize';
-import { IEmptyProps } from '../ui/list/Empty/Empty';
-import { IFormProps } from '../ui/form/Form/Form';
-import { Model } from '../components/MetaComponent';
-export declare type ListControlPosition = 'top' | 'bottom' | 'both' | string;
-interface ISortProps {
-    /**
-     * Включить сортировку
-     * @example false
-     */
-    enable?: boolean;
-    /**
-     * Аттрибут (название) поля сортировки в форме
-     * @example sort
-     */
-    attribute?: string;
-    /**
-     * Значение сортировки по умолчанию. Нужно указать название свойства, по которому items будут сортироваться,
-     * а с помощью знака "-" задать тип сортировки (со знаком минус - сортировать по убыванию, иначе по возрастанию).
-     * @example -price
-     */
-    defaultValue?: string | string[] | null;
-}
-export interface IListConfig {
-    /**
-     * Идентификатор списка
-     * @example ArticlesList
-     */
-    listId?: string;
-    /**
-     * Первичный ключ для item
-     * @example id
-     */
-    primaryKey?: string;
-    /**
-     * Url, который вернет коллекцию элементов
-     * @example api/v1/articles
-     */
-    action?: string | IApiMethod;
-    /**
-     * Тип HTTP запроса (GET | POST | PUT | DELETE)
-     * @example GET
-     */
-    actionMethod?: HttpMethod;
-    /**
-     * Подключение пагинации
-     * @example {loadMore: true}
-     */
-    pagination?: boolean | IPaginationProps;
-    /**
-     * Переключение количества элементов в списке
-     * @example {sizes: [3, 6, 9], defaultValue: 3}
-     */
-    paginationSize?: boolean | IPaginationSizeProps;
-    /**
-     * Подключение сортировки
-     * @example {enable: true, defaultSort: 'startDate'}
-     */
-    sort?: boolean | ISortProps;
-    /**
-     * Варианты расположения элементов коллекции
-     * @example {items: [{id: 'list', label: 'List'}, {id: 'grid', label: 'Grid'}]}
-     */
-    layout?: boolean | ILayoutNamesProps;
-    /**
-     * Заглушка в случае отсутствия элементов
-     * @example {text: 'Записи не найдены'}
-     */
-    empty?: boolean | string | IEmptyProps;
-    /**
-     * Форма для поиска элементов
-     * @example {fields: ['title'], model: {attributes: ['title:string:Название']}}
-     */
-    searchForm?: Omit<IFormProps, 'formId'> & {
-        formId?: string;
-    };
-    /**
-     * Удаление данных списка из хранилища Redux при размонтировании компонента
-     * @example true
-     */
-    autoDestroy?: boolean;
-    /**
-     * Отправлять запрос на обновление данных при изменении данных формы. По-умолчанию - включено.
-     * @example false
-     */
-    autoFetchOnFormChanges?: boolean;
-    /**
-     * Обработчик, который вызывается при изменении значений формы, и нужен для подгрузки новых элементов коллекции
-     * @param {IList} list
-     * @param {Object} query
-     * @param {*} http
-     * @return {Promise}
-     */
-    onFetch?: (list: IList, query: Record<string, unknown>, http: any) => Promise<any>;
-    /**
-     * Обработчик, который составляет список условий для локальной фильтрации элементов коллекции
-     * @param {Object} query
-     * @return {Array} ['>=', 'age', 18]
-     */
-    condition?: (query: Record<string, unknown>) => any[];
-    /**
-     * Синхронизация значений формы списка с адресной строкой
-     * @example true
-     */
-    addressBar?: boolean | IAddressBarConfig;
-    scope?: string[];
-    /**
-     * Дополнительные параметры, значения которых нужно передавать в запросе для получения данных
-     * @example {tagName: 'MarketReviews'}
-     */
-    query?: Record<string, unknown>;
-    model?: string;
-    /**
-     * Модель для синхронизации значений формы с адресной строкой
-     * @example {attributes: [{attribute: 'isMilesAvailable', type: boolean}]}
-     */
-    searchModel?: string;
-    /**
-     * Элементы коллекции
-     */
-    items?: Array<any>;
-    /**
-     * Начальные элементы. Используется для подгрузки нескольких списков в один запрос, при этом не отменяя пагинацию
-     * и последующие запросы на бекенд для 2-й и следующих страниц
-     */
-    initialItems?: Array<any>;
-    /**
-     * Количество элементов всего в списке (для отрисовки пагинации), заданное вручную
-     */
-    initialTotal?: number;
-}
-export interface IListOutput {
-    list: IList;
-    model: Model;
-    searchModel: Model;
-    paginationPosition: ListControlPosition;
-    paginationSizePosition: ListControlPosition;
-    layoutNamesPosition: ListControlPosition;
-    renderList: (children: any) => any;
-    renderEmpty: () => any;
-    renderPagination: () => any;
-    renderPaginationSize: () => any;
-    renderLayoutNames: () => any;
-    renderSearchForm: () => any;
-    onFetch: (params?: Record<string, unknown>) => void;
-    onSort: (value: any) => void;
-}
-export declare const defaultConfig: {
-    actionMethod: string;
-    primaryKey: string;
-    autoDestroy: boolean;
-    sort: {
-        enable: boolean;
-        attribute: string;
-        defaultValue: any;
-    };
-};
-export declare const normalizeSortProps: (props: IListConfig['sort']) => {
-    enable: boolean;
-    attribute: string;
-    defaultValue: any;
-};
-export declare const getDefaultSearchModel: ({ paginationProps, paginationSizeProps, sort, layoutNamesProps, }: {
-    paginationProps: any;
-    paginationSizeProps: any;
-    sort: any;
-    layoutNamesProps: any;
-}) => {
-    attributes: ({
-        type: string;
-        attribute: any;
-        defaultValue: any;
-        jsType?: undefined;
-    } | {
-        type: string;
-        jsType: string;
-        attribute: any;
-        defaultValue: any;
-    })[];
-};
-export declare const createInitialValues: ({ paginationProps, paginationSizeProps, sort, layoutNamesProps, initialQuery, configQuery, }: {
-    paginationProps: any;
-    paginationSizeProps: any;
-    sort: any;
-    layoutNamesProps: any;
-    initialQuery: any;
-    configQuery: any;
-}) => any;
-/**
- * useList
- * Добавляет массу возможностей для взаимодействия с коллекциями. Коллекции можно получать как с бекенда,
- * так и передавать статичным массивом. В обоих случаях поддерживается пагинация, сортировка, фильтрация данных.
- * Выбранные фильтры синхронизируются с адресной строкой.
- */
-export default function useList(config: IListConfig): IListOutput;
-export {};
+import { IApiMethod } from '../components/ApiComponent';
+import { IAddressBarConfig } from '../hooks/useAddressBar';
+import { IList } from '../actions/list';
+import { ILayoutNamesProps } from '../ui/list/LayoutNames/LayoutNames';
+import { IPaginationProps } from '../ui/list/Pagination/Pagination';
+import { IPaginationSizeProps } from '../ui/list/PaginationSize/PaginationSize';
+import { IEmptyProps } from '../ui/list/Empty/Empty';
+import { IFormProps } from '../ui/form/Form/Form';
+import { Model } from '../components/MetaComponent';
+export declare type ListControlPosition = 'top' | 'bottom' | 'both' | string;
+interface ISortProps {
+    /**
+     * Включить сортировку
+     * @example false
+     */
+    enable?: boolean;
+    /**
+     * Аттрибут (название) поля сортировки в форме
+     * @example sort
+     */
+    attribute?: string;
+    /**
+     * Значение сортировки по умолчанию. Нужно указать название свойства, по которому items будут сортироваться,
+     * а с помощью знака "-" задать тип сортировки (со знаком минус - сортировать по убыванию, иначе по возрастанию).
+     * @example -price
+     */
+    defaultValue?: string | string[] | null;
+}
+export interface IListConfig {
+    /**
+     * Идентификатор списка
+     * @example ArticlesList
+     */
+    listId?: string;
+    /**
+     * Первичный ключ для item
+     * @example id
+     */
+    primaryKey?: string;
+    /**
+     * Url, который вернет коллекцию элементов
+     * @example api/v1/articles
+     */
+    action?: string | IApiMethod;
+    /**
+     * Тип HTTP запроса (GET | POST | PUT | DELETE)
+     * @example GET
+     */
+    actionMethod?: HttpMethod;
+    /**
+     * Подключение пагинации
+     * @example {loadMore: true}
+     */
+    pagination?: boolean | IPaginationProps;
+    /**
+     * Переключение количества элементов в списке
+     * @example {sizes: [3, 6, 9], defaultValue: 3}
+     */
+    paginationSize?: boolean | IPaginationSizeProps;
+    /**
+     * Подключение сортировки
+     * @example {enable: true, defaultSort: 'startDate'}
+     */
+    sort?: boolean | ISortProps;
+    /**
+     * Варианты расположения элементов коллекции
+     * @example {items: [{id: 'list', label: 'List'}, {id: 'grid', label: 'Grid'}]}
+     */
+    layout?: boolean | ILayoutNamesProps;
+    /**
+     * Заглушка в случае отсутствия элементов
+     * @example {text: 'Записи не найдены'}
+     */
+    empty?: boolean | string | IEmptyProps;
+    /**
+     * Состояние загрузки элементов списка
+     * @example false
+     */
+    isLoading?: boolean;
+    /**
+     * Форма для поиска элементов
+     * @example {fields: ['title'], model: {attributes: ['title:string:Название']}}
+     */
+    searchForm?: Omit<IFormProps, 'formId'> & {
+        formId?: string;
+    };
+    /**
+     * Удаление данных списка из хранилища Redux при размонтировании компонента
+     * @example true
+     */
+    autoDestroy?: boolean;
+    /**
+     * Отправлять запрос на обновление данных при изменении данных формы. По-умолчанию - включено.
+     * @example false
+     */
+    autoFetchOnFormChanges?: boolean;
+    /**
+     * Обработчик, который вызывается при изменении значений формы, и нужен для подгрузки новых элементов коллекции
+     * @param {IList} list
+     * @param {Object} query
+     * @param {*} http
+     * @return {Promise}
+     */
+    onFetch?: (list: IList, query: Record<string, unknown>, http: any) => Promise<any>;
+    /**
+     * Обработчик, который составляет список условий для локальной фильтрации элементов коллекции
+     * @param {Object} query
+     * @return {Array} ['>=', 'age', 18]
+     */
+    condition?: (query: Record<string, unknown>) => any[];
+    /**
+     * Синхронизация значений формы списка с адресной строкой
+     * @example true
+     */
+    addressBar?: boolean | IAddressBarConfig;
+    scope?: string[];
+    /**
+     * Дополнительные параметры, значения которых нужно передавать в запросе для получения данных
+     * @example {tagName: 'MarketReviews'}
+     */
+    query?: Record<string, unknown>;
+    model?: string;
+    /**
+     * Модель для синхронизации значений формы с адресной строкой
+     * @example {attributes: [{attribute: 'isMilesAvailable', type: boolean}]}
+     */
+    searchModel?: string;
+    /**
+     * Элементы коллекции
+     */
+    items?: Array<any>;
+    /**
+     * Начальные элементы. Используется для подгрузки нескольких списков в один запрос, при этом не отменяя пагинацию
+     * и последующие запросы на бекенд для 2-й и следующих страниц
+     */
+    initialItems?: Array<any>;
+    /**
+     * Количество элементов всего в списке (для отрисовки пагинации), заданное вручную
+     */
+    initialTotal?: number;
+}
+export interface IListOutput {
+    list: IList;
+    model: Model;
+    searchModel: Model;
+    paginationPosition: ListControlPosition;
+    paginationSizePosition: ListControlPosition;
+    layoutNamesPosition: ListControlPosition;
+    renderList: (children: any) => any;
+    renderEmpty: () => any;
+    renderPagination: () => any;
+    renderPaginationSize: () => any;
+    renderLayoutNames: () => any;
+    renderSearchForm: () => any;
+    onFetch: (params?: Record<string, unknown>) => void;
+    onSort: (value: any) => void;
+}
+export declare const defaultConfig: {
+    actionMethod: string;
+    primaryKey: string;
+    autoDestroy: boolean;
+    sort: {
+        enable: boolean;
+        attribute: string;
+        defaultValue: any;
+    };
+};
+export declare const normalizeSortProps: (props: IListConfig['sort']) => {
+    enable: boolean;
+    attribute: string;
+    defaultValue: any;
+};
+export declare const getDefaultSearchModel: ({ paginationProps, paginationSizeProps, sort, layoutNamesProps, }: {
+    paginationProps: any;
+    paginationSizeProps: any;
+    sort: any;
+    layoutNamesProps: any;
+}) => {
+    attributes: ({
+        type: string;
+        attribute: any;
+        defaultValue: any;
+        jsType?: undefined;
+    } | {
+        type: string;
+        jsType: string;
+        attribute: any;
+        defaultValue: any;
+    })[];
+};
+export declare const createInitialValues: ({ paginationProps, paginationSizeProps, sort, layoutNamesProps, initialQuery, configQuery, }: {
+    paginationProps: any;
+    paginationSizeProps: any;
+    sort: any;
+    layoutNamesProps: any;
+    initialQuery: any;
+    configQuery: any;
+}) => any;
+/**
+ * useList
+ * Добавляет массу возможностей для взаимодействия с коллекциями. Коллекции можно получать как с бекенда,
+ * так и передавать статичным массивом. В обоих случаях поддерживается пагинация, сортировка, фильтрация данных.
+ * Выбранные фильтры синхронизируются с адресной строкой.
+ */
+export default function useList(config: IListConfig): IListOutput;
+export {};