Module:
Enumerations #
Classes #
Interfaces #
- BooleanComponentTypeProperties
- ColumnMessageConfig
- CustomComponentTypeProperties
- DataTableConfig
- DateComponentTypeProperties
- EnumComponentTypeProperties
- GenericComponentTypeProperties
- IDataSource
- LocalDataSourceOptions
- NumberComponentTypeProperties
- PaginatedListRequest
- PaginatedListResponse
- QueryObserver
- SearchFilter
- StringComponentTypeProperties
Type Aliases #
ApiFunction #
Ƭ ApiFunction<Data>: (request: PaginatedListRequest<Data>) => Promise<PaginatedListResponse<Data>>
Type parameters #
| Name |
|---|
| Data |
Type declaration #
▸ (request): Promise<PaginatedListResponse<Data>>
Parameters #
| Name | Type |
|---|---|
| request | PaginatedListRequest<Data> |
Returns #
Promise<PaginatedListResponse<Data>>
Defined in #
ComponentTypeProperties #
Ƭ ComponentTypeProperties: BooleanComponentTypeProperties | NumberComponentTypeProperties | StringComponentTypeProperties | EnumComponentTypeProperties<string> | CustomComponentTypeProperties | DateComponentTypeProperties
Defined in #
dataComponent/ComponentType.ts:59
FullDataTableConfig #
Ƭ FullDataTableConfig<Data>: Required<DataTableConfig<Data>>
Type parameters #
| Name |
|---|
| Data |
Defined in #
InterpolationValues #
Ƭ InterpolationValues: Record<string, string | number | boolean | Date | null | undefined>
Defined in #
MessageConfig #
Ƭ MessageConfig<Data>: Partial<Record<keyof Data, ColumnMessageConfig>> & { pagination?: { first: string ; last: string ; next: string ; previous: string } ; search?: { ariaLabel: string ; placeholder: string } }
Type parameters #
| Name |
|---|
| Data |
Defined in #
MessageFormatter #
Ƭ MessageFormatter: (messageId: string, options?: { default?: string ; values?: InterpolationValues }) => string | undefined
Type declaration #
▸ (messageId, options?): string | undefined
Parameters #
| Name | Type |
|---|---|
| messageId | string |
| options? | Object |
| options.default? | string |
| options.values? | InterpolationValues |
Returns #
string | undefined
Defined in #
SortDirection #
Ƭ SortDirection: false | “asc” | “desc”
Defined in #
TableColumnConfig #
Ƭ TableColumnConfig<Data>: Record<keyof Data | string & {}, ComponentTypeProperties>
Type parameters #
| Name |
|---|
| Data |
Defined in #
dataComponent/ComponentType.ts:81
Variables #
DATATABLE_CONFIG #
• Const DATATABLE_CONFIG: “DATATABLE_CONFIG”
Defined in #
DATATABLE_MESSAGE_FORMATTER #
• Const DATATABLE_MESSAGE_FORMATTER: “DATATABLE_MESSAGE_FORMATTER”
Defined in #
Functions #
createMessageFormatter #
▸ createMessageFormatter<Data>(dataTableConfig): Readable<MessageFormatter>
Type parameters #
| Name |
|---|
| Data |
Parameters #
| Name | Type |
|---|---|
| dataTableConfig | Required<DataTableConfig<Data>> |
Returns #
Readable<MessageFormatter>
Defined in #
util/messageFormatterUtil.ts:7
mergeDataTableConfigDefaults #
▸ mergeDataTableConfigDefaults<Data>(config): FullDataTableConfig<Data>
Type parameters #
| Name |
|---|
| Data |
Parameters #
| Name | Type |
|---|---|
| config | DataTableConfig<Data> |
Returns #
FullDataTableConfig<Data>
Defined in #
util/dataTableConfigUtil.ts:38
wrapFetchToThrow #
▸ wrapFetchToThrow<Data>(func): ApiFunction<Data>
Type parameters #
| Name |
|---|
| Data |
Parameters #
| Name | Type |
|---|---|
| func | (data: PaginatedListRequest<Data>) => Promise<Response> |
Returns #
ApiFunction<Data>