From ed849aaaa13e501824f97b0c3cdeb35a856ade30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9?= <583546+oandregal@users.noreply.github.com> Date: Thu, 9 Nov 2023 12:14:19 +0100 Subject: [PATCH] DataViews: document `enableSorting` and `enableHiding` (#55988) --- packages/edit-site/src/components/dataviews/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/edit-site/src/components/dataviews/README.md b/packages/edit-site/src/components/dataviews/README.md index 7a5abc8ad485da..ab077b2c6c30f6 100644 --- a/packages/edit-site/src/components/dataviews/README.md +++ b/packages/edit-site/src/components/dataviews/README.md @@ -145,7 +145,8 @@ Example: return ( ); - } + }, + enableHiding: false }, { id: 'author', @@ -161,6 +162,7 @@ Example: { value: 2, label: 'User' } ] filters: [ 'in' ], + enableSorting: false } ] ``` @@ -171,6 +173,8 @@ Example: - `render`: function that renders the field. - `elements`: the set of valid values for the field's value. - `filters`: what filter operators are available for the user to use over this field. Only `in` available at the moment. +- `enableSorting`: whether the data can be sorted by the given field. True by default. +- `enableHiding`: whether the field can be hidden. True by default. ## Actions