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.

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

DataViews: update filters in view config #55735

Merged
merged 7 commits into from
Nov 2, 2023
Merged

DataViews: update filters in view config #55735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5d3fedb
View config: filters declare their type
oandregal Oct 31, 2023
25524a2
Document filters in view config
oandregal Oct 31, 2023
2dcef9a
Filters always take the field id
oandregal Oct 31, 2023
ea849b7
Fix after rebase
oandregal Nov 2, 2023
eda75a5
Implement review request for filter shape
oandregal Nov 2, 2023
7374414
Update docs
oandregal Nov 2, 2023
d0a33fb
Fix rebase
oandregal Nov 2, 2023
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
31 changes: 20 additions & 11 deletions packages/edit-site/src/components/dataviews/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ Example:
direction: 'desc',
},
search: '',
filters: {
author: 2,
status: 'publish, draft'
},
filters: [
{ field: 'author', operator: 'in', value: 2 },
{ field: 'status', operator: 'in', value: 'publish,draft' }
],
visibleFilters: [ 'author', 'status' ],
hiddenFields: [ 'date', 'featured-image' ],
layout: {},
Expand Down Expand Up @@ -76,17 +76,26 @@ function MyCustomPageList() {
"...": "..."
} );

const queryArgs = useMemo(
() => ( {
const queryArgs = useMemo( () => {
const filters = {};
view.filters.forEach( ( filter ) => {
if ( filter.field === 'status' && filter.operator === 'in' ) {
filters.status = filter.value;
}
if ( filter.field === 'author' && filter.operator === 'in' ) {
filters.author = filter.value;
}
} );
return {
per_page: view.perPage,
page: view.page,
_embed: 'author',
order: view.sort?.direction,
orderby: view.sort?.field
orderby: view.sort?.field,
search: view.search,
...view.filters
} ),
[ view ]
);
...filters,
};
}, [ view ] );

const {
records
Expand Down
3 changes: 1 addition & 2 deletions packages/edit-site/src/components/dataviews/filters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default function Filters( { fields, view, onChangeView } ) {
}

field.filters.forEach( ( filter ) => {
let id = field.id;
const id = field.id;
if ( 'string' === typeof filter ) {
filterIndex[ id ] = {
id,
Expand All @@ -26,7 +26,6 @@ export default function Filters( { fields, view, onChangeView } ) {
}

if ( 'object' === typeof filter ) {
id = filter.id || field.id;
filterIndex[ id ] = {
id,
name: filter.name || field.header,
Expand Down
30 changes: 16 additions & 14 deletions packages/edit-site/src/components/dataviews/in-filter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,17 @@ import {
__experimentalInputControlPrefixWrapper as InputControlPrefixWrapper,
SelectControl,
} from '@wordpress/components';
import { privateApis as blockEditorPrivateApis } from '@wordpress/block-editor';

/**
* Internal dependencies
*/
import { unlock } from '../../lock-unlock';

const { cleanEmptyObject } = unlock( blockEditorPrivateApis );
const OPERATOR_IN = 'in';

export default ( { filter, view, onChangeView } ) => {
const activeValue = view.filters.find(
( f ) => f.field === filter.id && f.operator === OPERATOR_IN
)?.value;

return (
<SelectControl
value={ view.filters[ filter.id ] }
value={ activeValue }
prefix={
<InputControlPrefixWrapper
as="span"
Expand All @@ -28,17 +26,21 @@ export default ( { filter, view, onChangeView } ) => {
}
options={ filter.elements }
onChange={ ( value ) => {
if ( value === '' ) {
value = undefined;
const filters = view.filters.filter(
( f ) => f.field !== filter.id || f.operator !== OPERATOR_IN
);
if ( value !== '' ) {
filters.push( {
field: filter.id,
operator: OPERATOR_IN,
value,
} );
}

onChangeView( ( currentView ) => ( {
...currentView,
page: 1,
filters: cleanEmptyObject( {
...currentView.filters,
[ filter.id ]: value,
} ),
filters,
} ) );
} }
/>
Expand Down
12 changes: 3 additions & 9 deletions packages/edit-site/src/components/page-pages/default-views.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ export const DEFAULT_STATUSES = 'draft,future,pending,private,publish'; // All s
const DEFAULT_PAGE_BASE = {
type: 'list',
search: '',
filters: {
status: DEFAULT_STATUSES,
},
filters: [ { field: 'status', operator: 'in', value: DEFAULT_STATUSES } ],
page: 1,
perPage: 5,
sort: {
Expand All @@ -39,9 +37,7 @@ const DEFAULT_VIEWS = [
slug: 'drafts',
view: {
...DEFAULT_PAGE_BASE,
filters: {
status: 'draft',
},
filters: [ { field: 'status', operator: 'in', value: 'draft' } ],
},
},
{
Expand All @@ -50,9 +46,7 @@ const DEFAULT_VIEWS = [
icon: trash,
view: {
...DEFAULT_PAGE_BASE,
filters: {
status: 'trash',
},
filters: [ { field: 'status', operator: 'in', value: 'trash' } ],
},
},
];
Expand Down
31 changes: 20 additions & 11 deletions packages/edit-site/src/components/page-pages/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,36 @@ export default function PagePages() {
if ( DEFAULT_STATUSES !== defaultStatuses ) {
setView( {
...view,
filters: {
...view.filters,
status: defaultStatuses,
},
filters: [
...view.filters.filter(
( f ) => f.field !== 'status' || f.operator !== 'in'
),
{ field: 'status', operator: 'in', value: defaultStatuses },
],
} );
}
}, [ defaultStatuses ] );

const queryArgs = useMemo(
() => ( {
const queryArgs = useMemo( () => {
const filters = {};
view.filters.forEach( ( filter ) => {
if ( filter.field === 'status' && filter.operator === 'in' ) {
filters.status = filter.value;
}
if ( filter.field === 'author' && filter.operator === 'in' ) {
filters.author = filter.value;
}
} );
return {
per_page: view.perPage,
page: view.page,
_embed: 'author',
order: view.sort?.direction,
orderby: view.sort?.field,
search: view.search,
...view.filters,
} ),
[ view ]
);
...filters,
};
}, [ view ] );
const {
records: pages,
isResolving: isLoadingPages,
Expand Down Expand Up @@ -188,7 +198,6 @@ export default function PagePages() {
filters: [
{
type: 'enumeration',
id: 'status',
resetValue: defaultStatuses,
},
],
Expand Down
Loading