@wordpress/dataviews 10.3.0 → 10.3.1-next.16d95556a.0

package/CHANGELOG.md

@@ -6,6 +6,7 @@
 
 ### Enhancements
 
+- Improve docs for Edit component. [#73202](https://github.com/WordPress/gutenberg/pull/73202)
 - DataForm: add new details layout. [#72355](https://github.com/WordPress/gutenberg/pull/72355)
 - DatViews list layout: remove link variant from primary actions's button. [#72920](https://github.com/WordPress/gutenberg/pull/72920)
 - DataForm: simplify form normalization. [#72848](https://github.com/WordPress/gutenberg/pull/72848)

package/README.md

@@ -1302,7 +1302,7 @@ Example:
 
 React component that renders the control to edit the field.
 
--   Type: React component | `string`. If it's a string, it needs to be one of `array`, `checkbox`, `color`, `datetime`, `date`, `email`, `telephone`, `url`, `integer`, `number`, `password`, `radio`, `select`, `text`, `toggle`, `textarea`, `toggleGroup`.
+-   Type: `string` | `object` | React component.
 -   Required by DataForm. Optional if the field provided a `type`.
 -   Props:
     -   `data`: the item to be processed
@@ -1311,25 +1311,18 @@ React component that renders the control to edit the field.
     -   `hideLabelFromVision`: boolean representing if the label should be hidden
 -   Returns a React element to edit the field's value.
 
-Example:
+Fields that provide a `type` will have a default Edit control:
 
 ```js
-// A custom control defined by the field.
+// Edit is optional when field's type is present.
+// The field will use the default Edit function for text.
 {
-	Edit: ( { data, field, onChange, hideLabelFromVision } ) => {
-		const value = field.getValue( { item: data } );
-
-		return (
-			<CustomTimePicker
-				value={ value }
-				onChange={ onChange }
-				hideLabelFromVision
-			/>
-		);
-	};
+	type: 'text';
 }
 ```
 
+Field authors can override the default Edit control by providing a string that maps to one of the bundled UI controls: `array`, `checkbox`, `color`, `date`, `datetime`, `email`, `integer`, `number`, `password`, `radio`, `select`, `telephone`, `text`, `textarea`, `toggle`, `toggleGroup`, or `url`.
+
 ```js
 // Use one of the core controls.
 {
@@ -1337,13 +1330,6 @@ Example:
 }
 ```
 
-```js
-// Edit is optional when field's type is present.
-// The field will use the default Edit function for text.
-{
-	type: 'text';
-}
-```
 
 ```js
 // Edit can be provided even if field's type is present.
@@ -1354,6 +1340,51 @@ Example:
 }
 ```
 
+Additionally, some of the bundled Edit controls are configurable via a config object:
+
+- `textarea` configuration:
+
+```js
+{
+	Edit: {
+		control: 'textarea',
+		rows: 5
+	}
+}
+```
+
+- `text` configuration:
+
+```js
+{
+	Edit: {
+		control: 'text',
+		prefix: ReactComponent,
+		suffix: ReactComponent,
+	}
+}
+```
+
+Finally, the field author can always provide its own custom control:
+
+```js
+// A custom control defined by the field.
+{
+	Edit: ( { data, field, onChange, hideLabelFromVision } ) => {
+		const value = field.getValue( { item: data } );
+
+		return (
+			<CustomTimePicker
+				value={ value }
+				onChange={ onChange }
+				hideLabelFromVision
+			/>
+		);
+	};
+}
+```
+
+
 ### `sort`
 
 Function to sort the records.

package/build-wp/index.js

@@ -11593,6 +11593,7 @@ var CORE_MODULES_USING_PRIVATE_APIS = [
   "@wordpress/patterns",
   "@wordpress/preferences",
   "@wordpress/reusable-blocks",
+  "@wordpress/route",
   "@wordpress/router",
   "@wordpress/routes",
   "@wordpress/sync",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/dataviews",
-	"version": "10.3.0",
+	"version": "10.3.1-next.16d95556a.0",
 	"description": "DataViews is a component that provides an API to render datasets using different types of layouts (table, grid, list, etc.).",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -44,19 +44,19 @@
 	"sideEffects": false,
 	"dependencies": {
 		"@ariakit/react": "^0.4.15",
-		"@wordpress/base-styles": "^6.11.0",
-		"@wordpress/components": "^30.8.0",
-		"@wordpress/compose": "^7.35.0",
-		"@wordpress/data": "^10.35.0",
-		"@wordpress/date": "^5.35.0",
-		"@wordpress/element": "^6.35.0",
-		"@wordpress/i18n": "^6.8.0",
-		"@wordpress/icons": "^11.2.0",
-		"@wordpress/keycodes": "^4.35.0",
-		"@wordpress/primitives": "^4.35.0",
-		"@wordpress/private-apis": "^1.35.0",
-		"@wordpress/url": "^4.35.0",
-		"@wordpress/warning": "^3.35.0",
+		"@wordpress/base-styles": "^6.11.1-next.16d95556a.0",
+		"@wordpress/components": "^30.8.1-next.16d95556a.0",
+		"@wordpress/compose": "^7.35.1-next.16d95556a.0",
+		"@wordpress/data": "^10.35.1-next.16d95556a.0",
+		"@wordpress/date": "^5.35.1-next.16d95556a.0",
+		"@wordpress/element": "^6.35.1-next.16d95556a.0",
+		"@wordpress/i18n": "^6.8.1-next.16d95556a.0",
+		"@wordpress/icons": "^11.2.1-next.16d95556a.0",
+		"@wordpress/keycodes": "^4.35.1-next.16d95556a.0",
+		"@wordpress/primitives": "^4.35.1-next.16d95556a.0",
+		"@wordpress/private-apis": "^1.35.1-next.16d95556a.0",
+		"@wordpress/url": "^4.35.1-next.16d95556a.0",
+		"@wordpress/warning": "^3.35.1-next.16d95556a.0",
 		"clsx": "^2.1.1",
 		"colord": "^2.7.0",
 		"date-fns": "^4.1.0",
@@ -74,5 +74,5 @@
 	"scripts": {
 		"build:wp": "node build"
 	},
-	"gitHead": "77aa1f194edceafe8ac2a1b9438bf84b557e76e3"
+	"gitHead": "59a9383612bbe16e21af84d13b035bfbca7fe833"
 }