Extracted DiscoverGrid to a package named @kbn/unified-data-table as UnifiedDataTable component #163211
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,239 @@ | ||
| # @kbn/unified-data-table | ||
|
|
||
| This package contains components and services for the unified data table UI (as used in Discover). | ||
|
|
||
| ## UnifiedDataTable Component | ||
| Props description: | ||
| | Property | Type | Description | | ||
| | :--- | :--- | :--- | | ||
| | **ariaLabelledBy** | string | Determines which element labels the grid for ARIA. | | ||
| | **className** | (optional) string | Optional class name to apply. | | ||
| | **columns** | string[] | Determines ids of the columns which are displayed. | | ||
| | **expandedDoc** | (optional) DataTableRecord | If set, the given document is displayed in a flyout. | | ||
| | **dataView** | DataView | The used data view. | | ||
| | **loadingState** | DataLoadingState | Determines if data is currently loaded. | | ||
| | **onFilter** | DocViewFilterFn | Function to add a filter in the grid cell or document flyout. | | ||
| | **onResize** | (optional)(colSettings: { columnId: string; width: number }) => void; | Function triggered when a column is resized by the user. | | ||
| | **onSetColumns** | (columns: string[], hideTimeColumn: boolean) => void; | Function to set all columns. | | ||
| | **onSort** | (optional)(sort: string[][]) => void; | Function to change sorting of the documents, skipped when isSortEnabled is set to false. | | ||
| | **rows** | (optional)DataTableRecord[] | Array of documents provided by Elasticsearch. | | ||
| | **sampleSize** | number | The max size of the documents returned by Elasticsearch. | | ||
| | **setExpandedDoc** | (optional)(doc?: DataTableRecord) => void; | Function to set the expanded document, which is displayed in a flyout. | | ||
| | **settings** | (optional)UnifiedDataTableSettings | Grid display settings persisted in Elasticsearch (e.g. column width). | | ||
| | **searchDescription** | (optional)string | Search description. | | ||
| | **searchTitle** | (optional)string | Search title. | | ||
| | **showTimeCol** | boolean | Determines whether the time columns should be displayed (legacy settings). | | ||
| | **showFullScreenButton** | (optional)boolean | Determines whether the full screen button should be displayed. | | ||
| | **isSortEnabled** | (optional)boolean | Manage user sorting control. | | ||
| | **sort** | SortOrder[] | Current sort setting. | | ||
| | **useNewFieldsApi** | boolean | How the data is fetched. | | ||
| | **isPaginationEnabled** | (optional)boolean | Manage pagination control. | | ||
| | **controlColumnIds** | (optional)string[] | List of used control columns (available: 'openDetails', 'select'). | | ||
| | **rowHeightState** | (optional)number | Row height from state. | | ||
| | **onUpdateRowHeight** | (optional)(rowHeight: number) => void; | Update row height state. | | ||
| | **isPlainRecord** | (optional)boolean | Is text base lang mode enabled. | | ||
| | **rowsPerPageState** | (optional)number | Current state value for rowsPerPage. | | ||
| | **onUpdateRowsPerPage** | (optional)(rowsPerPage: number) => void; | Update rows per page state. | | ||
| | **onFieldEdited** | (optional)() => void; | Callback to execute on edit runtime field. | | ||
| | **cellActionsTriggerId** | (optional)string | Optional triggerId to retrieve the column cell actions that will override the default ones. | | ||
| | **services** | See Required **services** list below | Service dependencies. | | ||
| | **renderDocumentView** | (optional)(hit: DataTableRecord,displayedRows: DataTableRecord[],displayedColumns: string[]) => JSX.Element | undefined; | Callback to render DocumentView when the document is expanded. | | ||
| | **configRowHeight** | (optional)number | Optional value for providing configuration setting for UnifiedDataTable rows height. | | ||
| | **showMultiFields** | (optional)boolean | Optional value for providing configuration setting for enabling to display the complex fields in the table. Default is true. | | ||
| | **maxDocFieldsDisplayed** | (optional)number | Optional value for providing configuration setting for maximum number of document fields to display in the table. Default is 50. | | ||
| | **externalControlColumns** | (optional)EuiDataGridControlColumn[] | Optional value for providing EuiDataGridControlColumn list of the additional leading control columns. UnifiedDataTable includes two control columns: Open Details and Select. | | ||
| | **totalHits** | (optional)number | Number total hits from ES. | | ||
| | **onFetchMoreRecords** | (optional)() => void | To fetch more. | | ||
| | **externalAdditionalControls** | (optional)React.ReactNode | Optional value for providing the additional controls available in the UnifiedDataTable toolbar to manage it's records or state. UnifiedDataTable includes Columns, Sorting and Bulk Actions. | | ||
| | **rowsPerPageOptions** | (optional)number[] | Optional list of number type values to set custom UnifiedDataTable paging options to display the records per page. | | ||
| | **renderCustomGridBody** | (optional)(args: EuiDataGridCustomBodyProps) => React.ReactNode; | An optional function called to completely customize and control the rendering of EuiDataGrid's body and cell placement. | | ||
| | **trailingControlColumns** | (optional)EuiDataGridControlColumn[] | An optional list of the EuiDataGridControlColumn type for setting trailing control columns standard for EuiDataGrid. | | ||
| | **visibleCellActions** | (optional)number | An optional value for a custom number of the visible cell actions in the table. By default is up to 3. | | ||
| | **externalCustomRenderers** | (optional)Record<string,(props: EuiDataGridCellValueElementProps) => React.ReactNode>; | An optional settings for a specified fields rendering like links. Applied only for the listed fields rendering. | | ||
| | **consumer** | (optional)string | Name of the UnifiedDataTable consumer component or application. | | ||
|
|
||
| *Required **services** list: | ||
| ``` | ||
| theme: ThemeServiceStart; | ||
| fieldFormats: FieldFormatsStart; | ||
| uiSettings: IUiSettingsClient; | ||
| dataViewFieldEditor: DataViewFieldEditorStart; | ||
| toastNotifications: ToastsStart; | ||
| storage: Storage; | ||
| data: DataPublicPluginStart; | ||
| ``` | ||
|
|
||
| Usage example: | ||
|
There was a problem hiding this comment. Maybe worth to add a note, please use |
||
|
|
||
| ``` | ||
| // Memoize unified data table to avoid the unnecessary re-renderings | ||
| const DataTableMemoized = React.memo(UnifiedDataTable); | ||
|
|
||
| // Add memoized component with all needed props | ||
| <DataTableMemoized | ||
| ariaLabelledBy="timelineDocumentsAriaLabel" | ||
| className={'unifiedDataTableTimeline'} | ||
| columns={['event.category', 'event.action', 'host.name', 'user.name']} | ||
| expandedDoc={expandedDoc as DataTableRecord} | ||
| dataView={dataView} | ||
| loadingState={isQueryLoading ? DataLoadingState.loading : DataLoadingState.loaded} | ||
| onFilter={() => { | ||
| // Add logic to refetch the data when the filter by field was added/removed. Refetch data. | ||
| }} | ||
| onResize={(colSettings: { columnId: string; width: number }) => { | ||
| // Update the table state with the new width for the column | ||
| }} | ||
| onSetColumns={(columns: string[], hideTimeColumn: boolean) => { | ||
| // Update table state with the new columns. Refetch data. | ||
| }} | ||
| onSort={!isTextBasedQuery ? onSort : undefined | ||
| // Update table state with the new sorting settings. Refetch data. | ||
| } | ||
| rows={searchResultRows} | ||
| sampleSize={500} | ||
| setExpandedDoc={() => { | ||
| // Callback function to do the logic when the document is expanded | ||
| }} | ||
| settings={tableSettings} | ||
| showTimeCol={true} | ||
| isSortEnabled={true} | ||
| sort={sortingColumns} | ||
| rowHeightState={3} | ||
| onUpdateRowHeight={(rowHeight: number) => { | ||
| // Do the state update with the new setting of the row height | ||
| }} | ||
| isPlainRecord={isTextBasedQuery} | ||
| rowsPerPageState={50} | ||
| onUpdateRowsPerPage={(rowHeight: number) => { | ||
| // Do the state update with the new number of the rows per page | ||
| } | ||
| onFieldEdited={() => | ||
| // Callback to execute on edit runtime field. Refetch data. | ||
| } | ||
| cellActionsTriggerId={SecurityCellActionsTrigger.DEFAULT} | ||
| services={{ | ||
| theme, | ||
| fieldFormats, | ||
| storage, | ||
| toastNotifications: toastsService, | ||
| uiSettings, | ||
| dataViewFieldEditor, | ||
| data: dataPluginContract, | ||
| }} | ||
| visibleCellActions={3} | ||
| externalCustomRenderers={{ | ||
| // Set the record style definition for the specific fields rendering Record<string,(props: EuiDataGridCellValueElementProps) => React.ReactNode> | ||
| }} | ||
| renderDocumentView={() => | ||
| // Implement similar callback to render the Document flyout | ||
| const renderDetailsPanel = useCallback( | ||
| () => ( | ||
| <DetailsPanel | ||
| browserFields={browserFields} | ||
| handleOnPanelClosed={handleOnPanelClosed} | ||
| runtimeMappings={runtimeMappings} | ||
| tabType={TimelineTabs.query} | ||
| scopeId={timelineId} | ||
| isFlyoutView | ||
| /> | ||
| ), | ||
| [browserFields, handleOnPanelClosed, runtimeMappings, timelineId] | ||
| ); | ||
| } | ||
| externalControlColumns={leadingControlColumns} | ||
| externalAdditionalControls={additionalControls} | ||
| trailingControlColumns={trailingControlColumns} | ||
| renderCustomGridBody={renderCustomGridBody} | ||
| rowsPerPageOptions={[10, 30, 40, 100]} | ||
| showFullScreenButton={false} | ||
| useNewFieldsApi={true} | ||
| maxDocFieldsDisplayed={50} | ||
| consumer="timeline" | ||
| totalHits={ | ||
| // total number of the documents in the search query result. For example: 1200 | ||
| } | ||
| onFetchMoreRecords={() => { | ||
| // Do some data fetch to get more data | ||
| }} | ||
| configRowHeight={3} | ||
| showMultiFields={true} | ||
| /> | ||
| ``` | ||
|
|
||
| ## JsonCodeEditorCommon Component | ||
| Props description: | ||
| | Property | Type | Description | | ||
| | :--- | :--- | :--- | | ||
| | **width** | (optional) string or number | Editor component width. | | ||
| | **height** | (optional) string or number | Editor component height. | | ||
| | **hasLineNumbers** | (optional) boolean | Define if the editor component has line numbers style. | | ||
| | **hideCopyButton** | (optional) boolean | Show/hide setting for Copy button. | | ||
| | **onEditorDidMount** | (editor: monaco.editor.IStandaloneCodeEditor) => void | Do some logic to update the state with the edotor component value. | | ||
|
|
||
| Usage example: | ||
|
|
||
| ``` | ||
| <JsonCodeEditorCommon | ||
| jsonValue={jsonValue} | ||
| width={100} | ||
| height={400} | ||
| hasLineNumbers={true} | ||
| onEditorDidMount={(editorNode: monaco.editor.IStandaloneCodeEditor) => setEditor(editorNode)} | ||
| /> | ||
|
|
||
| ``` | ||
|
|
||
| ## Utils | ||
|
|
||
| * `getRowsPerPageOptions(currentRowsPerPage)` - gets list of the table defaults for perPage options. | ||
|
|
||
| * `getDisplayedColumns(currentRowsPerPage)` - gets list of the table columns with the logic to define the empty list with _source column. | ||
|
|
||
| * `popularizeField(...)` - helper function to define the dataView persistance and save indexPattern update capabilities. | ||
|
|
||
| ## Hooks | ||
|
|
||
| * `useColumns(...)` - this hook define the state update for the columns event handlers and allows to use them for external components outside the UnifiedDataTable. | ||
|
|
||
| An example of using hooks for defining event handlers for columns management with setting the consumer specific setAppState: | ||
|
|
||
| ``` | ||
| const { | ||
| columns: currentColumns, | ||
| onAddColumn, | ||
| onRemoveColumn, | ||
| onMoveColumn, | ||
| onSetColumns, | ||
| } = useColumns({ | ||
| capabilities, | ||
| defaultOrder: uiSettings.get(SORT_DEFAULT_ORDER_SETTING), | ||
| dataView, | ||
| dataViews, | ||
| setAppState: stateContainer.appState.update, | ||
| useNewFieldsApi, | ||
| columns, | ||
| sort, | ||
| }); | ||
|
|
||
| // Use onAddColumn, onRemoveColumn handlers in the DocumentView | ||
|
|
||
| const renderDocumentView = useCallback( | ||
| (hit: DataTableRecord, displayedRows: DataTableRecord[], displayedColumns: string[]) => ( | ||
| <DiscoverGridFlyout | ||
| dataView={dataView} | ||
| hit={hit} | ||
| hits={displayedRows} | ||
| // if default columns are used, dont make them part of the URL - the context state handling will take care to restore them | ||
| columns={displayedColumns} | ||
| savedSearchId={savedSearch.id} | ||
| onFilter={onAddFilter} | ||
| onRemoveColumn={onRemoveColumn} | ||
| onAddColumn={onAddColumn} | ||
| onClose={() => setExpandedDoc(undefined)} | ||
| setExpandedDoc={setExpandedDoc} | ||
| query={query} | ||
| /> | ||
| ), | ||
| [dataView, onAddColumn, onAddFilter, onRemoveColumn, query, savedSearch.id, setExpandedDoc] | ||
| ); | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { Config } from '@kbn/config'; | ||
|
|
||
| export type ConfigMock = jest.Mocked<Config>; | ||
|
|
||
| const createConfigMock = (): ConfigMock => ({ | ||
| has: jest.fn(), | ||
| get: jest.fn(), | ||
| set: jest.fn(), | ||
| getFlattenedPaths: jest.fn(), | ||
| toRaw: jest.fn(), | ||
| }); | ||
|
|
||
| export const configMock = { | ||
| create: createConfigMock, | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this, it's super helpful!