react-crud-mui 0.0.1-beta.5 → 0.0.1-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,9 +1,10 @@
1
1
  import { FieldValues } from 'react-hook-form';
2
2
  import { ListPageMeta } from '../pages/ListPageFilter';
3
- declare function useURLSearchFilter<TFilter extends FieldValues>(): {
4
- getFiltersInQS: ({ whiteList }?: {
5
- whiteList?: string[];
6
- }) => {
3
+ type UseURLSearchFilterOptions = {
4
+ defaultValues?: Record<string, unknown>;
5
+ };
6
+ declare function useURLSearchFilter<TFilter extends FieldValues>({ defaultValues, }: UseURLSearchFilterOptions): {
7
+ getFiltersInQS: () => {
7
8
  filter: {
8
9
  [key: string]: unknown;
9
10
  };
@@ -13,8 +14,9 @@ declare function useURLSearchFilter<TFilter extends FieldValues>(): {
13
14
  pageSize: number;
14
15
  };
15
16
  sorting: unknown;
17
+ selectedTabIndex: unknown;
16
18
  };
17
19
  };
18
- setFiltersInQS: (filter: TFilter, _meta: ListPageMeta) => void;
20
+ setFiltersInQS: (filter: TFilter, meta: ListPageMeta, extraFilter?: Record<string, unknown>) => void;
19
21
  };
20
22
  export default useURLSearchFilter;
@@ -14,6 +14,9 @@ export interface ListPageProps<TModel extends FieldValues, TFilter extends Field
14
14
  */
15
15
  removeFalsyFilterValues?: boolean;
16
16
  }
17
+ /**
18
+ * Simple list with filter and table
19
+ */
17
20
  declare function ListPage<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>(props: ListPageProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
18
21
  declare namespace ListPage {
19
22
  var Selection: typeof ListPageSelection;
@@ -33,6 +33,13 @@ export interface ListPageFilterProps<TModel extends FieldValues, TFilter extends
33
33
  * Meta data of listpage
34
34
  */
35
35
  defaultMeta?: DeepPartial<ListPageMeta>;
36
+ /**
37
+ * Make search on mount,default true
38
+ */
39
+ searchOnLoad?: boolean;
36
40
  }
41
+ /**
42
+ * ListPage with filtering features
43
+ */
37
44
  declare function ListPageFilter<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>(props: ListPageFilterProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
38
45
  export default ListPageFilter;
@@ -19,5 +19,8 @@ export interface ListPageFormProps<TModel extends FieldValues, TFilter extends F
19
19
  */
20
20
  validationOptions?: ValidationOptions<TFilter>;
21
21
  }
22
+ /**
23
+ * ListPage with form features for filter criterias
24
+ */
22
25
  declare function ListPageForm<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>(props: ListPageFormProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
23
26
  export default ListPageForm;
@@ -1,12 +1,11 @@
1
1
  import { FieldValues } from 'react-hook-form';
2
2
  import { UseSegmentParamsOptions } from '../../detail-page/hooks/useSegmentParams';
3
3
  import { ListPageProps } from './ListPage';
4
- export interface ListPageRouteProps<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues> extends ListPageProps<TModel, TFilter, TDetailPageModel>, Omit<UseSegmentParamsOptions, 'paths' | 'enableSegmentRouting'> {
4
+ export interface ListPageRouteProps<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues> extends ListPageProps<TModel, TFilter, TDetailPageModel>, Omit<UseSegmentParamsOptions, 'paths'> {
5
5
  enableQueryStringFilter?: boolean;
6
- whiteListQueryStringFilter?: string[];
7
6
  }
8
7
  /**
9
8
  * ListPage with routing based on react-router
10
9
  */
11
- declare function ListPageRoute<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>({ defaultFilter, defaultMeta, enableNestedSegments, enableQueryStringFilter, fallbackSegmentIndex, onNeedData, tabs, defaultValues, whiteListQueryStringFilter, ...listPageProps }: ListPageRouteProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
10
+ declare function ListPageRoute<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>({ defaultFilter, defaultMeta, enableNestedSegments, enableQueryStringFilter, enableSegmentRouting, fallbackSegmentIndex, onNeedData, tabs, defaultValues, ...listPageProps }: ListPageRouteProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
12
11
  export default ListPageRoute;