{ "id": "@kbn/shared-ux-table-persist", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist", "type": "Function", "tags": [], "label": "useEuiTablePersist", "description": [ "\nA hook that stores and retrieves from local storage the table page size and sort criteria.\nReturns the persisting page size and sort and the onTableChange handler that should be passed\nas props to an Eui table component." ], "signature": [ "(props: ", "EuiTablePersistProps", " & { initialSort: ", "PropertySort", "; }) => { sorting: { sort: ", "PropertySort", "; }; pageSize: number; onTableChange: (nextValues: ", "CriteriaWithPagination", ") => void; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "EuiTablePersistProps", " & { initialSort: ", "PropertySort", "; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist", "type": "Function", "tags": [], "label": "useEuiTablePersist", "description": [], "signature": [ "(props: ", "EuiTablePersistProps", " & { initialSort?: undefined; }) => { sorting: true; pageSize: number; onTableChange: (nextValues: ", "CriteriaWithPagination", ") => void; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist.$1", "type": "CompoundType", "tags": [], "label": "props", "description": [], "signature": [ "EuiTablePersistProps", " & { initialSort?: undefined; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist", "type": "Function", "tags": [], "label": "useEuiTablePersist", "description": [], "signature": [ "(props: ", "EuiTablePersistProps", ") => { sorting: true | { sort: ", "PropertySort", "; }; pageSize: number; onTableChange: (nextValues: ", "CriteriaWithPagination", ") => void; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "EuiTablePersistProps", "" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist", "type": "Function", "tags": [], "label": "useEuiTablePersist", "description": [], "signature": [ "({\n tableId,\n customOnTableChange,\n initialSort,\n initialPageSize,\n pageSizeOptions,\n}: ", "EuiTablePersistProps", ") => { pageSize: number; sorting: boolean | { sort: ", "PropertySort", "; }; onTableChange: (nextValues: ", "CriteriaWithPagination", ") => void; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.useEuiTablePersist.$1", "type": "Object", "tags": [], "label": "{\n tableId,\n customOnTableChange,\n initialSort,\n initialPageSize,\n pageSizeOptions,\n}", "description": [], "signature": [ "EuiTablePersistProps", "" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/use_table_persist.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.withEuiTablePersist", "type": "Function", "tags": [], "label": "withEuiTablePersist", "description": [], "signature": [ "(WrappedComponent: React.ComponentClass, any>, euiTablePersistDefault: (", "EuiTablePersistProps", " & { get?: undefined; }) | { get: ", { "pluginId": "@kbn/shared-ux-table-persist", "scope": "common", "docId": "kibKbnSharedUxTablePersistPluginApi", "section": "def-common.EuiTablePersistPropsGetter", "text": "EuiTablePersistPropsGetter" }, "; }) => React.FC<", { "pluginId": "@kbn/shared-ux-table-persist", "scope": "common", "docId": "kibKbnSharedUxTablePersistPluginApi", "section": "def-common.HOCProps", "text": "HOCProps" }, ">>" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.withEuiTablePersist.$1", "type": "Object", "tags": [], "label": "WrappedComponent", "description": [], "signature": [ "React.ComponentClass, any>" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.withEuiTablePersist.$2", "type": "CompoundType", "tags": [], "label": "euiTablePersistDefault", "description": [], "signature": [ "(", "EuiTablePersistProps", " & { get?: undefined; }) | { get: ", { "pluginId": "@kbn/shared-ux-table-persist", "scope": "common", "docId": "kibKbnSharedUxTablePersistPluginApi", "section": "def-common.EuiTablePersistPropsGetter", "text": "EuiTablePersistPropsGetter" }, "; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.EuiTablePersistInjectedProps", "type": "Interface", "tags": [], "label": "EuiTablePersistInjectedProps", "description": [], "signature": [ { "pluginId": "@kbn/shared-ux-table-persist", "scope": "common", "docId": "kibKbnSharedUxTablePersistPluginApi", "section": "def-common.EuiTablePersistInjectedProps", "text": "EuiTablePersistInjectedProps" }, "" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.EuiTablePersistInjectedProps.euiTablePersist", "type": "Object", "tags": [], "label": "euiTablePersist", "description": [], "signature": [ "{ onTableChange: (change: ", "CriteriaWithPagination", ") => void; sorting: true | { sort: ", "PropertySort", "; }; pageSize: number; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.DEFAULT_PAGE_SIZE_OPTIONS", "type": "Array", "tags": [], "label": "DEFAULT_PAGE_SIZE_OPTIONS", "description": [], "signature": [ "number[]" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.EuiTablePersistPropsGetter", "type": "Type", "tags": [], "label": "EuiTablePersistPropsGetter", "description": [], "signature": [ "(props: Omit) => ", "EuiTablePersistProps", "" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.EuiTablePersistPropsGetter.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [P in Exclude]: P[P]; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/shared-ux-table-persist", "id": "def-common.HOCProps", "type": "Type", "tags": [], "label": "HOCProps", "description": [], "signature": [ "P & { euiTablePersistProps?: Partial<", "EuiTablePersistProps", "> | undefined; }" ], "path": "src/platform/packages/shared/shared-ux/table_persist/src/table_persist_hoc.tsx", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }