Skip to content

DataViews: support the "Minimal UI" story by using DataViews.Footer #71276

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.

Sign up for GitHub

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

Merged
oandregal merged 2 commits into from
Aug 26, 2025
Merged

DataViews: support the "Minimal UI" story by using DataViews.Footer #71276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03954d1
Update MinimalUI story
oandregal Aug 20, 2025
bad6ff2
Use DataViews.Footer instead of config false to hide view config
oandregal Aug 20, 2025
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
4 changes: 4 additions & 0 deletions packages/dataviews/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Breaking changes

- Revert the ability to hide the view config via `config` prop and export a `DataViews.Footer` component to support the "Minimal UI" story. [#71276](https://github.com/WordPress/gutenberg/pull/71276)

### Bug Fixes

- DataViews: Fix incorrect documentation for `defaultLayouts` prop. [#71334](https://github.com/WordPress/gutenberg/pull/71334)
Expand Down
4 changes: 2 additions & 2 deletions packages/dataviews/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,9 +416,9 @@ The component receives the following props:

React component to be rendered next to the view config button.

#### `config`: false | { perPageSizes: number[] }
#### `config`: { perPageSizes: number[] }

Optional. Set it to `false` to hide the view config control entirely. Pass an object with a list of `perPageSizes` to control the available item counts per page (defaults to `[10, 20, 50, 100]`). `perPageSizes` needs to have a minimum of 2 items and a maximum of 6, otherwise the UI component won't be displayed.
Optional. Pass an object with a list of `perPageSizes` to control the available item counts per page (defaults to `[10, 20, 50, 100]`). `perPageSizes` needs to have a minimum of 2 items and a maximum of 6, otherwise the UI component won't be displayed.

#### `empty`: React node

Expand Down
2 changes: 1 addition & 1 deletion packages/dataviews/src/components/dataviews-context/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ type DataViewsContextType< Item > = {
filters: NormalizedFilter[];
isShowingFilter: boolean;
setIsShowingFilter: ( value: boolean ) => void;
config: false | { perPageSizes: number[] };
config: { perPageSizes: number[] };
empty?: ReactNode;
hasInfiniteScrollHandler: boolean;
};
Expand Down
30 changes: 14 additions & 16 deletions packages/dataviews/src/components/dataviews/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,9 @@ type DataViewsProps< Item > = {
header?: ReactNode;
getItemLevel?: ( item: Item ) => number;
children?: ReactNode;
config?:
| false
| {
perPageSizes: number[];
};
config?: {
perPageSizes: number[];
};
empty?: ReactNode;
} & ( Item extends ItemWithId
? { getItemId?: ( item: Item ) => string }
Expand All @@ -90,7 +88,7 @@ function DefaultUI( {
search = true,
searchLabel = undefined,
}: DefaultUIProps ) {
const { isShowingFilter, config } = useContext( DataViewsContext );
const { isShowingFilter } = useContext( DataViewsContext );
return (
<>
<HStack
Expand All @@ -107,16 +105,14 @@ function DefaultUI( {
{ search && <DataViewsSearch label={ searchLabel } /> }
<FiltersToggle />
</HStack>
{ ( config || header ) && (
<HStack
spacing={ 1 }
expanded={ false }
style={ { flexShrink: 0 } }
>
config && <DataViewsViewConfig />
{ header }
</HStack>
) }
<HStack
spacing={ 1 }
expanded={ false }
style={ { flexShrink: 0 } }
>
<DataViewsViewConfig />
{ header }
</HStack>
</HStack>
{ isShowingFilter && (
<DataViewsFilters className="dataviews-filters__container" />
Expand Down Expand Up @@ -282,6 +278,7 @@ const DataViewsSubComponents = DataViews as typeof DataViews & {
Pagination: typeof DataViewsPagination;
Search: typeof DataViewsSearch;
ViewConfig: typeof DataviewsViewConfigDropdown;
Footer: typeof DataViewsFooter;
};

DataViewsSubComponents.BulkActionToolbar = BulkActionsFooter;
Expand All @@ -292,5 +289,6 @@ DataViewsSubComponents.LayoutSwitcher = ViewTypeMenu;
DataViewsSubComponents.Pagination = DataViewsPagination;
DataViewsSubComponents.Search = DataViewsSearch;
DataViewsSubComponents.ViewConfig = DataviewsViewConfigDropdown;
DataViewsSubComponents.Footer = DataViewsFooter;
Copy link
Member Author

@oandregal oandregal Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've exported Footer as a subcomponent, as Jay suggested. I don't think I have a calibrated instinct to say if this is a good idea or not. It's better than having to use the classes, agree to that. Though I'm not sure at which point we stop making DataViews components public API. All things considered, I'm fine with going ahead with this.


export default DataViewsSubComponents;
34 changes: 27 additions & 7 deletions packages/dataviews/src/components/dataviews/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,11 @@ export const CustomEmpty = () => {
);
};

export const MinimalUI = () => {
const MinimalUIComponent = ( {
layout = 'table',
}: {
layout: 'table' | 'list' | 'grid';
} ) => {
const [ view, setView ] = useState< View >( {
...DEFAULT_VIEW,
fields: [ 'title', 'description', 'categories' ],
Expand All @@ -165,22 +169,38 @@ export const MinimalUI = () => {
filterBy: false,
} ) );

useEffect( () => {
setView( {
...view,
type: layout as any,
} );
}, [ layout ] );

return (
<DataViews
getItemId={ ( item ) => item.id.toString() }
paginationInfo={ paginationInfo }
data={ shownData }
view={ view }
fields={ _fields }
config={ false }
search={ false }
onChangeView={ setView }
defaultLayouts={ {
table: {},
} }
/>
defaultLayouts={ { [ layout ]: {} } }
>
<DataViews.Layout />
<DataViews.Footer />
</DataViews>
);
};
export const MinimalUI = {
render: MinimalUIComponent,
argTypes: {
layout: {
control: 'select',
options: [ 'table', 'list', 'grid' ],
defaultValue: 'table',
},
},
};

/**
* Custom composition example
Expand Down
Loading