Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Discover] Fixes pagination style #5778

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ import { DiscoverGridContextProvider } from './data_grid_table_context';
import { DocViewFilterFn, OpenSearchSearchHit } from '../../doc_views/doc_views_types';
import { usePagination } from '../utils/use_pagination';
import { buildColumns } from '../../utils/columns';
import { useOpenSearchDashboards } from '../../../../../opensearch_dashboards_react/public';
import { DiscoverServices } from '../../../build_services';
import {
DOC_HIDE_TIME_COLUMN_SETTING,
SAMPLE_SIZE_SETTING,
Expand All @@ -25,7 +23,6 @@ import { UI_SETTINGS } from '../../../../../data/common';
import { LegacyDiscoverTable } from '../default_discover_table/default_discover_table';
import { toolbarVisibility } from './constants';
import { getDataGridTableSetting } from '../utils/local_storage';
import { Storage } from '../../../../../opensearch_dashboards_utils/public';
import { SortOrder } from '../default_discover_table/helper';

export interface DataGridTableProps {
Expand All @@ -35,7 +32,7 @@ export interface DataGridTableProps {
onFilter: DocViewFilterFn;
onMoveColumn: (colName: string, destination: number) => void;
onRemoveColumn: (column: string) => void;
onReorderColumn: (col: string, source: number, destination: number) => void;
hits?: number;
onSort: (s: SortOrder[]) => void;
rows: OpenSearchSearchHit[];
onSetColumns: (columns: string[]) => void;
Expand All @@ -46,7 +43,6 @@ export interface DataGridTableProps {
isToolbarVisible?: boolean;
isContextView?: boolean;
isLoading?: boolean;
storage: Storage;
showPagination?: boolean;
}

Expand All @@ -57,18 +53,17 @@ export const DataGridTable = ({
onFilter,
onMoveColumn,
onRemoveColumn,
onReorderColumn,
onSetColumns,
onSort,
sort,
hits,
rows,
displayTimeColumn,
title = '',
description = '',
isToolbarVisible = true,
isContextView = false,
isLoading = false,
storage,
showPagination,
}: DataGridTableProps) => {
const services = getServices();
Expand Down Expand Up @@ -159,12 +154,13 @@ export const DataGridTable = ({
];
}, []);

const datagridActive = getDataGridTableSetting(storage);
const datagridActive = getDataGridTableSetting(services.storage);

const legacyDiscoverTable = useMemo(
() => (
<LegacyDiscoverTable
columns={adjustedColumns}
hits={hits}
rows={rows}
indexPattern={indexPattern}
sort={sort}
Expand All @@ -183,6 +179,7 @@ export const DataGridTable = ({
),
[
adjustedColumns,
hits,
rows,
indexPattern,
sort,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.osdDocTable_pagination {
width: 100%;

& ~ table {
margin-bottom: 0;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,23 @@
import './_doc_table.scss';

import React, { useEffect, useRef, useState } from 'react';
import {

Check failure on line 9 in src/plugins/discover/public/application/components/default_discover_table/default_discover_table.tsx

View workflow job for this annotation

GitHub Actions / Build and Verify on Linux (ciGroup1)

Replace `⏎··EuiButtonEmpty,⏎··EuiCallOut,⏎··EuiProgress,⏎` with `·EuiButtonEmpty,·EuiCallOut,·EuiProgress·`
EuiButtonEmpty,
EuiCallOut,
EuiProgress,
EuiPagination,
EuiFlexGroup,
EuiFlexItem,
} from '@elastic/eui';
import { FormattedMessage } from '@osd/i18n/react';
import { TableHeader } from './table_header';
import { DocViewFilterFn, OpenSearchSearchHit } from '../../doc_views/doc_views_types';
import { TableRow } from './table_rows';
import { IndexPattern } from '../../../opensearch_dashboards_services';
import { Pagination } from './pagination';
import { SortOrder } from './helper';
import { getLegacyDisplayedColumns } from './helper';

export interface DefaultDiscoverTableProps {
columns: string[];
hits?: number;
rows: OpenSearchSearchHit[];
indexPattern: IndexPattern;
sort: SortOrder[];
Expand All @@ -42,6 +41,7 @@

export const LegacyDiscoverTable = ({
columns,
hits,
rows,
indexPattern,
sort,
Expand Down Expand Up @@ -121,26 +121,15 @@
indexPattern && (
<>
{showPagination ? (
<EuiFlexGroup>
<EuiFlexItem grow={false}>
<EuiPagination
pageCount={pageCount}
activePage={activePage}
onPageClick={(currentPage) => goToPage(currentPage)}
/>
</EuiFlexItem>
<EuiFlexItem>
<FormattedMessage
id="discover.docTable.pagerControl.pagesCountLabel"
defaultMessage="{startItem}&ndash;{endItem} of {totalItems}"
values={{
startItem: currentRowCounts.startRow,
endItem: currentRowCounts.endRow,
totalItems: rows.length,
}}
/>
</EuiFlexItem>
</EuiFlexGroup>
<Pagination
pageCount={pageCount}
activePage={activePage}
goToPage={goToPage}
startItem={currentRowCounts.startRow + 1}
endItem={currentRowCounts.endRow}
totalItems={hits}
sampleSize={sampleSize}
/>
) : null}
<table data-test-subj="docTable" className="osd-table table">
<thead>
Expand Down Expand Up @@ -193,6 +182,17 @@
</EuiButtonEmpty>
</EuiCallOut>
)}
{showPagination ? (
<Pagination
pageCount={pageCount}
activePage={activePage}
goToPage={goToPage}
startItem={currentRowCounts.startRow + 1}
endItem={currentRowCounts.endRow}
totalItems={hits}
sampleSize={sampleSize}
/>
) : null}
</>
)
);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

import { EuiFlexGroup, EuiFlexItem, EuiPagination, EuiTextColor } from '@elastic/eui';
import React from 'react';
import { FormattedMessage } from '@osd/i18n/react';
import './_pagination.scss';

interface Props {
pageCount: number;
activePage: number;
goToPage: (page: number) => void;
startItem: number;
endItem: number;
totalItems?: number;
sampleSize: number;
}

export const Pagination = ({
pageCount,
activePage,
goToPage,
startItem,
endItem,
totalItems = 0,
sampleSize,
}: Props) => {
return (
<EuiFlexGroup className="osdDocTable_pagination" alignItems="center" justifyContent="flexEnd">
{endItem >= sampleSize && (
<EuiFlexItem grow={false}>
<EuiTextColor color="subdued">
<FormattedMessage
id="discover.docTable.limitedSearchResultLabel"
defaultMessage="Limited to {sampleSize} results. Refine your search."
values={{ sampleSize }}
/>
</EuiTextColor>
</EuiFlexItem>
)}
<EuiFlexItem grow={false}>
<FormattedMessage
id="discover.docTable.pagerControl.pagesCountLabel"
defaultMessage="{startItem}&ndash;{endItem} of {totalItems}"
values={{
startItem,
endItem,
totalItems,
}}
/>
</EuiFlexItem>
<EuiFlexItem grow={false}>
<EuiPagination
pageCount={pageCount}
activePage={activePage}
onPageClick={(currentPage) => goToPage(currentPage)}
/>
</EuiFlexItem>
</EuiFlexGroup>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export function ContextApp({
appState,
}: Props) {
const { services } = useOpenSearchDashboards<DiscoverViewServices>();
const { uiSettings, storage } = services;
const { uiSettings } = services;
const defaultStepSize = useMemo(() => parseInt(uiSettings.get(CONTEXT_STEP_SETTING), 10), [
uiSettings,
]);
Expand Down Expand Up @@ -111,7 +111,6 @@ export function ContextApp({
displayTimeColumn={displayTimeColumn}
isToolbarVisible={false}
isContextView={true}
storage={storage}
/>
</div>
<ActionBar
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,6 @@ const FieldList = ({
<>
<EuiButtonEmpty
iconSide="right"
iconSize="s"
color="text"
iconType={expanded ? 'arrowDown' : 'arrowRight'}
onClick={() => setExpanded(!expanded)}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

import React, { useCallback, useMemo, useState, useEffect } from 'react';
import React, { useCallback, useMemo } from 'react';
import { DiscoverViewServices } from '../../../build_services';
import { useOpenSearchDashboards } from '../../../../../opensearch_dashboards_react/public';
import { DataGridTable } from '../../components/data_grid/data_grid_table';
Expand Down Expand Up @@ -38,7 +38,6 @@ export const DiscoverTable = ({ rows }: Props) => {
},
capabilities,
indexPatterns,
storage,
} = services;

const { refetch$, indexPattern, savedSearch } = useDiscoverContext();
Expand Down Expand Up @@ -121,7 +120,6 @@ export const DiscoverTable = ({ rows }: Props) => {
displayTimeColumn={displayTimeColumn}
title={savedSearch?.id ? savedSearch.title : ''}
description={savedSearch?.id ? savedSearch.description : ''}
storage={storage}
/>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,17 @@
*/

import { IndexPattern } from '../../../opensearch_dashboards_services';
import { SortOrder } from '../../../saved_searches/types';
// @ts-ignore
import { isSortable } from './get_sort';

export type SortOrder = [string, string];

/**
* use in case the user didn't manually sort.
* the default sort is returned depending of the index pattern
*/
export function getDefaultSort(
indexPattern: IndexPattern,
defaultSortOrder: string = 'desc'
defaultSortOrder: 'asc' | 'desc' = 'desc'
): SortOrder[] {
if (indexPattern.timeFieldName && isSortable(indexPattern.timeFieldName, indexPattern)) {
return [[indexPattern.timeFieldName, defaultSortOrder]];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export interface SearchProps {
onFilter?: (field: IFieldType, value: string[], operator: string) => void;
rows?: any[];
indexPattern?: IndexPattern;
totalHitCount?: number;
hits?: number;
isLoading?: boolean;
displayTimeColumn?: boolean;
services: DiscoverServices;
Expand Down Expand Up @@ -360,7 +360,7 @@ export class SearchEmbeddable
inspectorRequest.stats(getResponseInspectorStats(resp, searchSource)).ok({ json: resp });

this.searchProps!.rows = resp.hits.hits;
this.searchProps!.totalHitCount = resp.hits.total;
this.searchProps!.hits = resp.hits.total;
this.searchProps!.isLoading = false;
} catch (error) {
this.updateOutput({ loading: false, error });
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,19 @@ import {
import { VisualizationNoResults } from '../../../visualizations/public';
import { getServices } from '../opensearch_dashboards_services';
import './search_embeddable.scss';
import { OpenSearchDashboardsContextProvider } from '../../../opensearch_dashboards_react/public';

interface SearchEmbeddableProps {
searchProps: SearchProps;
}
export interface DiscoverEmbeddableProps extends DataGridTableProps {
totalHitCount: number;
}
export type DiscoverEmbeddableProps = DataGridTableProps;

export const DataGridTableMemoized = React.memo((props: DataGridTableProps) => (
<DataGridTable {...props} />
));

export function SearchEmbeddableComponent({ searchProps }: SearchEmbeddableProps) {
const { storage } = getServices();
const services = getServices();
const discoverEmbeddableProps = {
columns: searchProps.columns,
indexPattern: searchProps.indexPattern,
Expand All @@ -42,32 +41,33 @@ export function SearchEmbeddableComponent({ searchProps }: SearchEmbeddableProps
sort: searchProps.sort,
displayTimeColumn: searchProps.displayTimeColumn,
services: searchProps.services,
totalHitCount: searchProps.totalHitCount,
hits: searchProps.hits,
title: searchProps.title,
description: searchProps.description,
storage,
showPagination: true,
} as DiscoverEmbeddableProps;

return (
<I18nProvider>
<EuiFlexGroup
gutterSize="xs"
direction="column"
responsive={false}
data-test-subj="embeddedSavedSearchDocTable"
className="eui-xScrollWithShadows eui-yScrollWithShadows"
>
{discoverEmbeddableProps.totalHitCount !== 0 ? (
<EuiFlexItem style={{ minHeight: 0 }} className="osdDocTable__container">
<DataGridTableMemoized {...discoverEmbeddableProps} />
</EuiFlexItem>
) : (
<EuiFlexItem>
<VisualizationNoResults />
</EuiFlexItem>
)}
</EuiFlexGroup>
<OpenSearchDashboardsContextProvider services={services}>
<EuiFlexGroup
gutterSize="xs"
direction="column"
responsive={false}
data-test-subj="embeddedSavedSearchDocTable"
className="eui-xScrollWithShadows eui-yScrollWithShadows"
>
{discoverEmbeddableProps.hits !== 0 ? (
<EuiFlexItem style={{ minHeight: 0 }} className="osdDocTable__container">
<DataGridTableMemoized {...discoverEmbeddableProps} />
</EuiFlexItem>
) : (
<EuiFlexItem>
<VisualizationNoResults />
</EuiFlexItem>
)}
</EuiFlexGroup>
</OpenSearchDashboardsContextProvider>
</I18nProvider>
);
}
Loading
Loading