@wordpress/components 19.12.0 → 19.13.0

package/src/tools-panel/tools-panel/hook.ts

@@ -165,10 +165,8 @@ export function useToolsPanel(
 	// in order to later determine if the panel display is empty and handle
 	// conditional display of a plus icon to indicate the presence of further
 	// menu items.
-	const [
-		areAllOptionalControlsHidden,
-		setAreAllOptionalControlsHidden,
-	] = useState( false );
+	const [ areAllOptionalControlsHidden, setAreAllOptionalControlsHidden ] =
+		useState( false );
 
 	useEffect( () => {
 		if (

package/src/tools-panel/tools-panel-header/hook.ts

@@ -33,11 +33,8 @@ export function useToolsPanelHeader(
 		return cx( styles.ToolsPanelHeading );
 	}, [ cx ] );
 
-	const {
-		menuItems,
-		hasMenuItems,
-		areAllOptionalControlsHidden,
-	} = useToolsPanelContext();
+	const { menuItems, hasMenuItems, areAllOptionalControlsHidden } =
+		useToolsPanelContext();
 
 	return {
 		...otherProps,

package/src/tooltip/index.js

@@ -65,6 +65,7 @@ const addPopoverToGrandchildren = ( {
 				aria-hidden="true"
 				animate={ false }
 				offset={ 12 }
+				__unstableShift
 			>
 				{ text }
 				<Shortcut

package/src/tree-grid/roving-tab-index-item.js

@@ -14,10 +14,8 @@ export default forwardRef( function RovingTabIndexItem(
 ) {
 	const localRef = useRef();
 	const ref = forwardedRef || localRef;
-	const {
-		lastFocusedElement,
-		setLastFocusedElement,
-	} = useRovingTabIndexContext();
+	const { lastFocusedElement, setLastFocusedElement } =
+		useRovingTabIndexContext();
 	let tabIndex;
 
 	if ( lastFocusedElement ) {

package/src/tree-grid/test/index.js

@@ -35,9 +35,8 @@ describe( 'TreeGrid', () => {
 	] );
 
 	beforeAll( () => {
-		window.Element.prototype.getClientRects = jest.fn(
-			mockedGetClientRects
-		);
+		window.Element.prototype.getClientRects =
+			jest.fn( mockedGetClientRects );
 	} );
 
 	afterAll( () => {

package/src/tree-select/README.md

@@ -80,12 +80,12 @@ A function that receives the id of the new node element that is being selected.
 
 The id of the currently selected node.
 
--   Type: `Object`
+-   Type: `string` | `string[]`
 -   Required: No
 
 ### tree
 
 An array containing the tree objects with the possible nodes the user can select.
 
--   Type: `String`
+-   Type: `Object[]`
 -   Required: No

package/src/tree-select/index.tsx

@@ -0,0 +1,99 @@
+/**
+ * External dependencies
+ */
+import { unescape as unescapeString, repeat, flatMap, compact } from 'lodash';
+
+/**
+ * WordPress dependencies
+ */
+import { useMemo } from '@wordpress/element';
+/**
+ * Internal dependencies
+ */
+import { SelectControl } from '../select-control';
+import type { TreeSelectProps, Tree, SelectOptions } from './types';
+
+function getSelectOptions( tree: Tree[], level = 0 ): SelectOptions {
+	return flatMap( tree, ( treeNode ) => [
+		{
+			value: treeNode.id,
+			label:
+				repeat( '\u00A0', level * 3 ) + unescapeString( treeNode.name ),
+		},
+		...getSelectOptions( treeNode.children || [], level + 1 ),
+	] );
+}
+
+/**
+ * TreeSelect component is used to generate select input fields.
+ *
+ * @example
+ * ```jsx
+ * import { TreeSelect } from '@wordpress/components';
+ * import { useState } from '@wordpress/element';
+ *
+ * const MyTreeSelect = () => {
+ * 	const [ page, setPage ] = useState( 'p21' );
+ *
+ * 	return (
+ * 		<TreeSelect
+ * 			label="Parent page"
+ * 			noOptionLabel="No parent page"
+ * 			onChange={ ( newPage ) => setPage( newPage ) }
+ * 			selectedId={ page }
+ * 			tree={ [
+ * 				{
+ * 					name: 'Page 1',
+ * 					id: 'p1',
+ * 					children: [
+ * 						{ name: 'Descend 1 of page 1', id: 'p11' },
+ * 						{ name: 'Descend 2 of page 1', id: 'p12' },
+ * 					],
+ * 				},
+ * 				{
+ * 					name: 'Page 2',
+ * 					id: 'p2',
+ * 					children: [
+ * 						{
+ * 							name: 'Descend 1 of page 2',
+ * 							id: 'p21',
+ * 							children: [
+ * 								{
+ * 									name: 'Descend 1 of Descend 1 of page 2',
+ * 									id: 'p211',
+ * 								},
+ * 							],
+ * 						},
+ * 					],
+ * 				},
+ * 			] }
+ * 		/>
+ * 	);
+ * }
+ * ```
+ */
+export function TreeSelect( {
+	label,
+	noOptionLabel,
+	onChange,
+	selectedId,
+	tree = [],
+	...props
+}: TreeSelectProps ) {
+	const options = useMemo( () => {
+		return compact( [
+			noOptionLabel && { value: '', label: noOptionLabel },
+			...getSelectOptions( tree ),
+		] );
+	}, [ noOptionLabel, tree ] );
+
+	return (
+		<SelectControl
+			{ ...{ label, options, onChange } }
+			value={ selectedId }
+			{ ...props }
+		/>
+	);
+}
+
+export default TreeSelect;

package/src/tree-select/stories/index.tsx

@@ -0,0 +1,80 @@
+/**
+ * External dependencies
+ */
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
+import type { ComponentProps } from 'react';
+/**
+ * WordPress dependencies
+ */
+import { useState } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import TreeSelect from '../';
+
+const meta: ComponentMeta< typeof TreeSelect > = {
+	title: 'Components/TreeSelect',
+	component: TreeSelect,
+	argTypes: {
+		help: { control: { type: 'text' } },
+		label: { control: { type: 'text' } },
+		prefix: { control: { type: 'text' } },
+		suffix: { control: { type: 'text' } },
+		selectedId: { control: { type: null } },
+	},
+	parameters: {
+		controls: {
+			expanded: true,
+		},
+		docs: { source: { state: 'open' } },
+	},
+};
+
+export default meta;
+
+const TreeSelectWithState: ComponentStory< typeof TreeSelect > = ( props ) => {
+	const [ selection, setSelection ] =
+		useState< ComponentProps< typeof TreeSelect >[ 'selectedId' ] >();
+
+	return (
+		<TreeSelect
+			{ ...props }
+			onChange={ setSelection }
+			selectedId={ selection }
+		/>
+	);
+};
+
+export const Default = TreeSelectWithState.bind( {} );
+Default.args = {
+	label: 'Label Text',
+	noOptionLabel: 'No parent page',
+	help: 'Help text to explain the select control.',
+	tree: [
+		{
+			name: 'Page 1',
+			id: 'p1',
+			children: [
+				{ name: 'Descend 1 of page 1', id: 'p11' },
+				{ name: 'Descend 2 of page 1', id: 'p12' },
+			],
+		},
+		{
+			name: 'Page 2',
+			id: 'p2',
+			children: [
+				{
+					name: 'Descend 1 of page 2',
+					id: 'p21',
+					children: [
+						{
+							name: 'Descend 1 of Descend 1 of page 2',
+							id: 'p211',
+						},
+					],
+				},
+			],
+		},
+	],
+};

package/src/tree-select/types.ts

@@ -0,0 +1,35 @@
+/**
+ * External dependencies
+ */
+import type { ComponentProps } from 'react';
+
+/**
+ * Internal dependencies
+ */
+import type SelectControl from '../select-control';
+import type { SelectControlProps } from '../select-control/types';
+
+export type SelectOptions = Required<
+	ComponentProps< typeof SelectControl >
+>[ 'options' ];
+
+export interface Tree {
+	id: string;
+	name: string;
+	children?: Tree[];
+}
+
+export interface TreeSelectProps extends Omit< SelectControlProps, 'value' > {
+	/**
+	 * If this property is added, an option will be added with this label to represent empty selection.
+	 */
+	noOptionLabel?: string;
+	/**
+	 * An array containing the tree objects with the possible nodes the user can select.
+	 */
+	tree?: Tree[];
+	/**
+	 * The id of the currently selected node.
+	 */
+	selectedId?: ComponentProps< typeof SelectControl >[ 'value' ];
+}

package/src/ui/context/wordpress-component.ts

@@ -47,8 +47,7 @@ export type WordPressComponent<
 	selector: `.${ string }`;
 };
 
-export type WordPressComponentFromProps<
-	Props
-> = Props extends WordPressComponentProps< infer P, infer T, infer I >
-	? WordPressComponent< T, P, I >
-	: never;
+export type WordPressComponentFromProps< Props > =
+	Props extends WordPressComponentProps< infer P, infer T, infer I >
+		? WordPressComponent< T, P, I >
+		: never;

package/src/ui/form-group/form-group-content.js

@@ -26,10 +26,10 @@ function FormGroupContent( {
 	truncate,
 	...props
 } ) {
-	const contextProps = useMemo( () => ( { id, horizontal } ), [
-		id,
-		horizontal,
-	] );
+	const contextProps = useMemo(
+		() => ( { id, horizontal } ),
+		[ id, horizontal ]
+	);
 
 	const content = help ? (
 		<VStack expanded={ false } spacing={ spacing }>

package/src/unit-control/index.tsx

@@ -160,15 +160,13 @@ function UnforwardedUnitControl(
 			refParsedQuantity.current = undefined;
 			return;
 		}
-		const [
-			validParsedQuantity,
-			validParsedUnit,
-		] = getValidParsedQuantityAndUnit(
-			event.currentTarget.value,
-			units,
-			parsedQuantity,
-			unit
-		);
+		const [ validParsedQuantity, validParsedUnit ] =
+			getValidParsedQuantityAndUnit(
+				event.currentTarget.value,
+				units,
+				parsedQuantity,
+				unit
+			);
 
 		refParsedQuantity.current = validParsedQuantity;
 

package/src/unit-control/stories/index.tsx

@@ -67,9 +67,8 @@ const DefaultTemplate: ComponentStory< typeof UnitControl > = ( {
 	);
 };
 
-export const Default: ComponentStory<
-	typeof UnitControl
-> = DefaultTemplate.bind( {} );
+export const Default: ComponentStory< typeof UnitControl > =
+	DefaultTemplate.bind( {} );
 Default.args = {
 	label: 'Label',
 };
@@ -79,9 +78,8 @@ Default.args = {
  * will not fire while a new value is typed in the input field (you can verify this
  * behavior by inspecting the console's output).
  */
-export const PressEnterToChange: ComponentStory<
-	typeof UnitControl
-> = DefaultTemplate.bind( {} );
+export const PressEnterToChange: ComponentStory< typeof UnitControl > =
+	DefaultTemplate.bind( {} );
 PressEnterToChange.args = {
 	...Default.args,
 	isPressEnterToChange: true,
@@ -95,9 +93,8 @@ PressEnterToChange.args = {
  * Most of `NumberControl`'s props can be passed to `UnitControl`, and they will
  * affect its numeric input field.
  */
-export const TweakingTheNumberInput: ComponentStory<
-	typeof UnitControl
-> = DefaultTemplate.bind( {} );
+export const TweakingTheNumberInput: ComponentStory< typeof UnitControl > =
+	DefaultTemplate.bind( {} );
 TweakingTheNumberInput.args = {
 	...Default.args,
 	min: 0,
@@ -109,9 +106,8 @@ TweakingTheNumberInput.args = {
 /**
  * When only one unit is available, the unit selection dropdown becomes static text.
  */
-export const WithSingleUnit: ComponentStory<
-	typeof UnitControl
-> = DefaultTemplate.bind( {} );
+export const WithSingleUnit: ComponentStory< typeof UnitControl > =
+	DefaultTemplate.bind( {} );
 WithSingleUnit.args = {
 	...Default.args,
 	units: CSS_UNITS.slice( 0, 1 ),

package/src/unit-control/test/index.tsx

@@ -39,9 +39,8 @@ const ControlledSyncUnits = () => {
 		fieldName: 'valueA' | 'valueB',
 		newValue?: string | number
 	) => {
-		const parsedQuantityAndUnit = parseQuantityAndUnitFromRawValue(
-			newValue
-		);
+		const parsedQuantityAndUnit =
+			parseQuantityAndUnitFromRawValue( newValue );
 		const quantity = parsedQuantityAndUnit[ 0 ];
 
 		if ( ! Number.isFinite( quantity ) ) {
@@ -56,10 +55,8 @@ const ControlledSyncUnits = () => {
 		};
 
 		Object.entries( state ).forEach( ( [ stateProp, stateValue ] ) => {
-			const [
-				stateQuantity,
-				stateUnit,
-			] = parseQuantityAndUnitFromRawValue( stateValue );
+			const [ stateQuantity, stateUnit ] =
+				parseQuantityAndUnitFromRawValue( stateValue );
 
 			if ( stateProp !== fieldName && stateUnit !== newUnit ) {
 				nextState[

package/src/utils/hooks/stories/use-cx.js

@@ -33,19 +33,20 @@ const ExampleWithUseMemoWrong = ( { serializedStyles, children } ) => {
 	const cx = useCx();
 	// Wrong: using 'useMemo' without adding 'cx' to the dependency list.
 	// eslint-disable-next-line react-hooks/exhaustive-deps
-	const classes = useMemo( () => cx( serializedStyles ), [
-		serializedStyles,
-	] );
+	const classes = useMemo(
+		() => cx( serializedStyles ),
+		[ serializedStyles ]
+	);
 	return <span className={ classes }>{ children }</span>;
 };
 
 const ExampleWithUseMemoRight = ( { serializedStyles, children } ) => {
 	const cx = useCx();
 	// Right: using 'useMemo' with 'cx' listed as a dependency.
-	const classes = useMemo( () => cx( serializedStyles ), [
-		cx,
-		serializedStyles,
-	] );
+	const classes = useMemo(
+		() => cx( serializedStyles ),
+		[ cx, serializedStyles ]
+	);
 	return <span className={ classes }>{ children }</span>;
 };
 

package/src/utils/hooks/test/use-controlled-state.js

@@ -2,13 +2,14 @@
  * External dependencies
  */
 import { render, fireEvent, screen } from '@testing-library/react';
-import { noop } from 'lodash';
 
 /**
  * Internal dependencies
  */
 import useControlledState from '../use-controlled-state';
 
+const noop = () => {};
+
 describe( 'hooks', () => {
 	const getInput = () => screen.getByTestId( 'input' );
 

package/src/utils/unit-values.ts

@@ -1,4 +1,5 @@
-const UNITED_VALUE_REGEX = /^([\d.\-+]*)\s*(fr|cm|mm|Q|in|pc|pt|px|em|ex|ch|rem|lh|vw|vh|vmin|vmax|%|cap|ic|rlh|vi|vb|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?$/;
+const UNITED_VALUE_REGEX =
+	/^([\d.\-+]*)\s*(fr|cm|mm|Q|in|pc|pt|px|em|ex|ch|rem|lh|vw|vh|vmin|vmax|%|cap|ic|rlh|vi|vb|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?$/;
 
 /**
  * Parses a number and unit from a value.

package/src/utils/values.js

@@ -88,9 +88,8 @@ export function isValueNumeric( value, locale = window.navigator.language ) {
 		}
 	}
 
-	const [ delimiterRegexp, decimalRegexp ] = getDelimiterAndDecimalRegex(
-		locale
-	);
+	const [ delimiterRegexp, decimalRegexp ] =
+		getDelimiterAndDecimalRegex( locale );
 	const valueToCheck =
 		typeof value === 'string'
 			? value

package/src/z-stack/README.md

@@ -26,16 +26,27 @@ function Example() {
 
 ### `isLayered`: `boolean`
 
-When `true`, the children are stacked on top of each other. When `false`, the children follow the normal flow of the layout. Defaults to `true`.
+Layers children elements on top of each other (first: highest z-index, last: lowest z-index).
+
+-   Required: No
+-   Default: `true`
 
 ### `isReversed`: `boolean`
 
-Reverse the layer ordering. When `true`, the first child has the lowest `z-index` and the last child has the highest `z-index`. When `false`, the first child has the highest `z-index` and the last child has the lowest `z-index`. Defaults to `false`.
+Reverse the layer ordering (first: lowest z-index, last: highest z-index).
+
+-   Required: No
+-   Default: `false`
 
 ### `offset`: `number`
 
-The amount of space between each child element. Defaults to `0`. Its value is automatically inverted (i.e. from positive to negative, and viceversa) when switching from LTR to RTL.
+The amount of space between each child element. Its value is automatically inverted (i.e. from positive to negative, and viceversa) when switching from LTR to RTL.
+
+-   Required: No
+-   Default: `0`
 
 ### `children`: `ReactNode`
 
 The children to stack.
+
+-   Required: Yes

package/src/z-stack/component.tsx

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import type { ForwardedRef, ReactNode } from 'react';
+import type { ForwardedRef } from 'react';
 
 /**
  * WordPress dependencies
@@ -13,35 +13,11 @@ import { isValidElement } from '@wordpress/element';
  */
 import { getValidChildren } from '../ui/utils/get-valid-children';
 import { contextConnect, useContextSystem } from '../ui/context';
-import type { WordPressComponentProps } from '../ui/context';
 import { ZStackView, ZStackChildView } from './styles';
+import type { ZStackProps } from './types';
+import type { WordPressComponentProps } from '../ui/context';
 
-export interface ZStackProps {
-	/**
-	 * Layers children elements on top of each other (first: highest z-index, last: lowest z-index).
-	 *
-	 * @default true
-	 */
-	isLayered?: boolean;
-	/**
-	 * Reverse the layer ordering (first: lowest z-index, last: highest z-index).
-	 *
-	 * @default false
-	 */
-	isReversed?: boolean;
-	/**
-	 * The amount of offset between each child element. The amount of space between each child element. Defaults to `0`. Its value is automatically inverted (i.e. from positive to negative, and viceversa) when switching from LTR to RTL.
-	 *
-	 * @default 0
-	 */
-	offset?: number;
-	/**
-	 * Child elements.
-	 */
-	children: ReactNode;
-}
-
-function ZStack(
+function UnconnectedZStack(
 	props: WordPressComponentProps< ZStackProps, 'div' >,
 	forwardedRef: ForwardedRef< any >
 ) {
@@ -86,4 +62,23 @@ function ZStack(
 	);
 }
 
-export default contextConnect( ZStack, 'ZStack' );
+/**
+ * `ZStack` allows you to stack things along the Z-axis.
+ *
+ * ```jsx
+ * import { __experimentalZStack as ZStack } from '@wordpress/components';
+ *
+ * function Example() {
+ *   return (
+ *     <ZStack offset={ 20 } isLayered>
+ *       <ExampleImage />
+ *       <ExampleImage />
+ *       <ExampleImage />
+ *     </ZStack>
+ *   );
+ * }
+ * ```
+ */
+export const ZStack = contextConnect( UnconnectedZStack, 'ZStack' );
+
+export default ZStack;

package/src/z-stack/stories/index.tsx

@@ -0,0 +1,76 @@
+/**
+ * External dependencies
+ */
+import type { CSSProperties } from 'react';
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
+
+/**
+ * Internal dependencies
+ */
+import { Elevation } from '../../elevation';
+import { HStack } from '../../h-stack';
+import { View } from '../../view';
+import { ZStack } from '..';
+
+const meta: ComponentMeta< typeof ZStack > = {
+	component: ZStack,
+	title: 'Components (Experimental)/ZStack',
+	argTypes: {
+		as: { control: { type: 'text' } },
+		children: { control: { type: null } },
+	},
+	parameters: {
+		controls: {
+			expanded: true,
+		},
+		docs: { source: { state: 'open' } },
+	},
+};
+export default meta;
+
+const Avatar = ( {
+	backgroundColor,
+}: {
+	backgroundColor: CSSProperties[ 'backgroundColor' ];
+} ) => {
+	return (
+		<View>
+			<View
+				style={ {
+					border: '3px solid black',
+					borderRadius: '9999px',
+					height: '48px',
+					width: '48px',
+					backgroundColor,
+				} }
+			/>
+			<Elevation
+				borderRadius={ 9999 }
+				isInteractive={ false }
+				value={ 3 }
+			/>
+		</View>
+	);
+};
+
+const Template: ComponentStory< typeof ZStack > = ( args ) => {
+	return (
+		<View>
+			<HStack>
+				<View>
+					<ZStack { ...args }>
+						<Avatar backgroundColor="#444" />
+						<Avatar backgroundColor="#777" />
+						<Avatar backgroundColor="#aaa" />
+						<Avatar backgroundColor="#fff" />
+					</ZStack>
+				</View>
+			</HStack>
+		</View>
+	);
+};
+
+export const Default: ComponentStory< typeof ZStack > = Template.bind( {} );
+Default.args = {
+	offset: 20,
+};