DataViews: document enableSorting and enableHiding (#55988)

WordPress · Nov 9, 2023 · e726f25 · e726f25 · github-actions · Nov 9, 2023
1 parent 09c50a2
commit e726f25
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/packages/edit-site/src/components/dataviews/README.md b/packages/edit-site/src/components/dataviews/README.md
@@ -145,7 +145,8 @@ Example:
 			return (
 				<time>{ getFormattedDate( item.date ) }</time>
 			);
-		}
+		},
+		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