Skip to content

Commit

Permalink
Export some datagrid hooks (#4271)
Browse files Browse the repository at this point in the history
* Export useDataGridColumnSorting, useDataGridColumnSelector, and useDataGridStyleSelector from EUI

* changelog
  • Loading branch information
chandlerprall authored Nov 17, 2020
1 parent 3cef201 commit 0ba20e0
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- Added `eql` glyph in `EuiIcon` ([#4110](https://github.com/elastic/eui/pull/4110))
- Added `testenv` mock for `htmlIdGenerator` ([#4212](https://github.com/elastic/eui/pull/4212))
- Added several Sass mixins for handling of unified focus/hover states ([#4242](https://github.com/elastic/eui/pull/4242))
- Exported `useDataGridColumnSelector`, `useDataGridColumnSorting`, and `useDataGridStyleSelector` hooks ([#4271](https://github.com/elastic/eui/pull/4271))

**Theme: Amsterdam**

Expand Down
2 changes: 1 addition & 1 deletion src/components/datagrid/column_selector.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const getShowColumnSelectorValue = (
return showColumnSelector[valueName] !== false;
};

export const useColumnSelector = (
export const useDataGridColumnSelector = (
availableColumns: EuiDataGridColumn[],
columnVisibility: EuiDataGridColumnVisibility,
showColumnSelector: EuiDataGridToolBarVisibilityOptions['showColumnSelector'],
Expand Down
2 changes: 1 addition & 1 deletion src/components/datagrid/column_sorting.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import {
} from './data_grid_schema';
import { EuiToken } from '../token';

export const useColumnSorting = (
export const useDataGridColumnSorting = (
columns: EuiDataGridColumn[],
sorting: EuiDataGridSorting | undefined,
schema: EuiDataGridSchema,
Expand Down
14 changes: 8 additions & 6 deletions src/components/datagrid/data_grid.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ import { EuiDataGridCellProps } from './data_grid_cell';
import { EuiButtonEmpty } from '../button';
import { keys, htmlIdGenerator } from '../../services';
import { EuiDataGridBody } from './data_grid_body';
import { useColumnSelector } from './column_selector';
import { useStyleSelector, startingStyles } from './style_selector';
import { useDataGridColumnSelector } from './column_selector';
import { useDataGridStyleSelector, startingStyles } from './style_selector';
import { EuiTablePagination } from '../table/table_pagination';
import { EuiFocusTrap } from '../focus_trap';
import {
Expand All @@ -76,7 +76,7 @@ import {
useDetectSchema,
schemaDetectors as providedSchemaDetectors,
} from './data_grid_schema';
import { useColumnSorting } from './column_sorting';
import { useDataGridColumnSorting } from './column_sorting';
import { EuiMutationObserver } from '../observer/mutation_observer';
import { DataGridContext } from './data_grid_context';

Expand Down Expand Up @@ -769,20 +769,22 @@ export const EuiDataGrid: FunctionComponent<EuiDataGridProps> = (props) => {
orderedVisibleColumns,
setVisibleColumns,
switchColumnPos,
] = useColumnSelector(
] = useDataGridColumnSelector(
columns,
columnVisibility,
checkOrDefaultToolBarDiplayOptions(toolbarVisibility, 'showColumnSelector'),
displayValues
);
const columnSorting = useColumnSorting(
const columnSorting = useDataGridColumnSorting(
orderedVisibleColumns,
sorting,
mergedSchema,
allSchemaDetectors,
displayValues
);
const [styleSelector, gridStyles] = useStyleSelector(gridStyleWithDefaults);
const [styleSelector, gridStyles] = useDataGridStyleSelector(
gridStyleWithDefaults
);

// compute the default column width from the container's clientWidth and count of visible columns
const defaultColumnWidth = useDefaultColumnWidth(
Expand Down
3 changes: 3 additions & 0 deletions src/components/datagrid/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,8 @@ export {
EuiDataGridSchemaDetector,
SchemaTypeScore,
} from './data_grid_schema';
export { useDataGridColumnSelector } from './column_selector';
export { useDataGridColumnSorting } from './column_sorting';
export { useDataGridStyleSelector } from './style_selector';

export * from './data_grid_types';
2 changes: 1 addition & 1 deletion src/components/datagrid/style_selector.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ const densityStyles: { [key: string]: Partial<EuiDataGridStyle> } = {
},
};

export const useStyleSelector = (
export const useDataGridStyleSelector = (
initialStyles: EuiDataGridStyle
): [ReactElement, EuiDataGridStyle] => {
// track styles specified by the user at run time
Expand Down

0 comments on commit 0ba20e0

Please sign in to comment.