@wordpress/components 19.13.0 → 19.16.0

package/src/v-stack/README.md

@@ -29,9 +29,7 @@ function Example() {
 
 ## Props
 
-##### alignment
-
-**Type**: `HStackAlignment`,`CSS['alignItems']`
+##### `alignment`: `HStackAlignment | CSSProperties['alignItems']`
 
 Determines how the child elements are aligned.
 
@@ -47,35 +45,25 @@ Determines how the child elements are aligned.
 -   `edge`: Aligns content to the edges of the container.
 -   `stretch`: Stretches content to the edges of the container.
 
-##### direction
-
-**Type**: `FlexDirection`
+##### `direction`: `FlexDirection`
 
 The direction flow of the children content can be adjusted with `direction`. `column` will align children vertically and `row` will align children horizontally.
 
-##### expanded
-
-**Type**: `boolean`
+##### `expanded`: `boolean`
 
 Expands to the maximum available width (if horizontal) or height (if vertical).
 
-##### justify
-
-**Type**: `CSS['justifyContent']`
+##### `justify`: `CSSProperties['justifyContent']`
 
 Horizontally aligns content if the `direction` is `row`, or vertically aligns content if the `direction` is `column`.
 In the example below, `flex-start` will align the children content to the left.
 
-##### spacing
-
-**Type**: `CSS['width']`
+##### `spacing`: `CSSProperties['width']`
 
 The amount of space between each child element. Spacing in between each child can be adjusted by using `spacing`.
 The value of `spacing` works as a multiplier to the library's grid system (base of `4px`).
 
-##### wrap
-
-**Type**: `boolean`
+##### `wrap`: `boolean`
 
 Determines if children should wrap.
 

package/src/v-stack/{component.js → component.tsx}

@@ -1,26 +1,31 @@
+/**
+ * External dependencies
+ */
+import type { ForwardedRef } from 'react';
+
 /**
  * Internal dependencies
  */
-import { contextConnect } from '../ui/context';
+import { contextConnect, WordPressComponentProps } from '../ui/context';
 import { View } from '../view';
 import { useVStack } from './hook';
+import type { VStackProps } from './types';
 
-/**
- * @param {import('../ui/context').WordPressComponentProps<import('./types').Props, 'div'>} props
- * @param {import('react').ForwardedRef<any>}                                               forwardedRef
- */
-function VStack( props, forwardedRef ) {
+function UnconnectedVStack(
+	props: WordPressComponentProps< VStackProps, 'div' >,
+	forwardedRef: ForwardedRef< any >
+) {
 	const vStackProps = useVStack( props );
 
 	return <View { ...vStackProps } ref={ forwardedRef } />;
 }
 
 /**
- * `VStack` (or Vertical Stack) is a layout component that arranges child elements in a vertical line.
+ * `VStack` (or Vertical Stack) is a layout component that arranges child
+ * elements in a vertical line.
  *
  * `VStack` can render anything inside.
  *
- * @example
  * ```jsx
  * import {
  * 	__experimentalText as Text,
@@ -38,6 +43,6 @@ function VStack( props, forwardedRef ) {
  * }
  * ```
  */
-const ConnectedVStack = contextConnect( VStack, 'VStack' );
+export const VStack = contextConnect( UnconnectedVStack, 'VStack' );
 
-export default ConnectedVStack;
+export default VStack;

package/src/v-stack/{hook.js → hook.ts}

@@ -1,14 +1,13 @@
 /**
  * Internal dependencies
  */
-import { useContextSystem } from '../ui/context';
+import { useContextSystem, WordPressComponentProps } from '../ui/context';
 import { useHStack } from '../h-stack';
+import type { VStackProps } from './types';
 
-/**
- *
- * @param {import('../ui/context').WordPressComponentProps<import('./types').Props, 'div'>} props
- */
-export function useVStack( props ) {
+export function useVStack(
+	props: WordPressComponentProps< VStackProps, 'div' >
+) {
 	const { expanded = false, ...otherProps } = useContextSystem(
 		props,
 		'VStack'

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

@@ -0,0 +1,41 @@
+/**
+ * External dependencies
+ */
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
+
+/**
+ * Internal dependencies
+ */
+import { View } from '../../view';
+import { VStack } from '..';
+
+const meta: ComponentMeta< typeof VStack > = {
+	component: VStack,
+	title: 'Components (Experimental)/VStack',
+	argTypes: {
+		alignment: { control: { type: 'text' } },
+		as: { control: { type: 'text' } },
+		direction: { control: { type: 'text' } },
+		justify: { control: { type: 'text' } },
+		spacing: { control: { type: 'text' } },
+	},
+	parameters: {
+		controls: { expanded: true },
+		docs: { source: { state: 'open' } },
+	},
+};
+export default meta;
+
+const Template: ComponentStory< typeof VStack > = ( props ) => {
+	return (
+		<VStack { ...props }>
+			<View>One</View>
+			<View>Two</View>
+			<View>Three</View>
+			<View>Four</View>
+			<View>Five</View>
+		</VStack>
+	);
+};
+
+export const Default = Template.bind( {} );

package/src/v-stack/types.ts

@@ -8,7 +8,27 @@ import type { CSSProperties } from 'react';
  */
 import type { HStackAlignment, Props as HStackProps } from '../h-stack/types';
 
-export type Props = HStackProps & {
+export type VStackProps = HStackProps & {
+	/**
+	 * Determines how the child elements are aligned.
+	 *
+	 * -   `top`: Aligns content to the top.
+	 * -   `topLeft`: Aligns content to the top/left.
+	 * -   `topRight`: Aligns content to the top/right.
+	 * -   `left`: Aligns content to the left.
+	 * -   `center`: Aligns content to the center.
+	 * -   `right`: Aligns content to the right.
+	 * -   `bottom`: Aligns content to the bottom.
+	 * -   `bottomLeft`: Aligns content to the bottom/left.
+	 * -   `bottomRight`: Aligns content to the bottom/right.
+	 * -   `edge`: Aligns content to the edges of the container.
+	 * -   `stretch`: Stretches content to the edges of the container.
+	 */
 	alignment?: HStackAlignment | CSSProperties[ 'alignItems' ];
+	/**
+	 * The amount of space between each child element. Spacing in between each
+	 * child can be adjusted by using `spacing`. The value of `spacing` works as
+	 * a multiplier to the library's grid system (base of `4px`).
+	 */
 	spacing?: CSSProperties[ 'width' ];
 };

package/src/visually-hidden/{component.js → component.tsx}

@@ -1,15 +1,24 @@
+/**
+ * External dependencies
+ */
+import type { ForwardedRef } from 'react';
+
 /**
  * Internal dependencies
  */
-import { useContextSystem, contextConnect } from '../ui/context';
+import {
+	useContextSystem,
+	contextConnect,
+	WordPressComponentProps,
+} from '../ui/context';
 import { visuallyHidden } from './styles';
 import { View } from '../view';
+import type { VisuallyHiddenProps } from './types';
 
-/**
- * @param {import('../ui/context').WordPressComponentProps<{ children: import('react').ReactNode }, 'div'>} props
- * @param {import('react').ForwardedRef<any>}                                                               forwardedRef
- */
-function VisuallyHidden( props, forwardedRef ) {
+function UnconnectedVisuallyHidden(
+	props: WordPressComponentProps< VisuallyHiddenProps, 'div' >,
+	forwardedRef: ForwardedRef< any >
+) {
 	const { style: styleProp, ...contextProps } = useContextSystem(
 		props,
 		'VisuallyHidden'
@@ -27,22 +36,21 @@ function VisuallyHidden( props, forwardedRef ) {
  * `VisuallyHidden` is a component used to render text intended to be visually
  * hidden, but will show for alternate devices, for example a screen reader.
  *
- * @example
  * ```jsx
  * import { VisuallyHidden } from `@wordpress/components`;
  *
  * function Example() {
- * 	return (
- * 		<VisuallyHidden>
- * 			<label>Code is Poetry</label>
- * 		</VisuallyHidden>
- * 	);
+ *   return (
+ *     <VisuallyHidden>
+ *       <label>Code is Poetry</label>
+ *     </VisuallyHidden>
+ *   );
  * }
  * ```
  */
-const ConnectedVisuallyHidden = contextConnect(
-	VisuallyHidden,
+export const VisuallyHidden = contextConnect(
+	UnconnectedVisuallyHidden,
 	'VisuallyHidden'
 );
 
-export default ConnectedVisuallyHidden;
+export default VisuallyHidden;

package/src/visually-hidden/stories/index.tsx

@@ -0,0 +1,66 @@
+/**
+ * External dependencies
+ */
+import type { ComponentMeta, ComponentStory } from '@storybook/react';
+
+/**
+ * Internal dependencies
+ */
+import { VisuallyHidden } from '..';
+
+const meta: ComponentMeta< typeof VisuallyHidden > = {
+	component: VisuallyHidden,
+	title: 'Components/VisuallyHidden',
+	argTypes: {
+		children: { control: { type: null } },
+		as: { control: { type: 'text' } },
+	},
+	parameters: {
+		controls: {
+			expanded: true,
+		},
+		docs: { source: { state: 'open' } },
+	},
+};
+export default meta;
+
+export const Default: ComponentStory< typeof VisuallyHidden > = ( args ) => (
+	<>
+		<VisuallyHidden as="span" { ...args }>
+			This should not show.
+		</VisuallyHidden>
+		<div>
+			This text will{ ' ' }
+			<VisuallyHidden as="span" { ...args }>
+				but not inline{ ' ' }
+			</VisuallyHidden>{ ' ' }
+			always show.
+		</div>
+	</>
+);
+
+export const WithForwardedProps: ComponentStory< typeof VisuallyHidden > = (
+	args
+) => (
+	<>
+		Additional props can be passed to VisuallyHidden and are forwarded to
+		the rendered element.{ ' ' }
+		<VisuallyHidden as="span" data-id="test" { ...args }>
+			Check out my data attribute!{ ' ' }
+		</VisuallyHidden>
+		Inspect the HTML to see!
+	</>
+);
+
+export const WithAdditionalClassNames: ComponentStory<
+	typeof VisuallyHidden
+> = ( args ) => (
+	<>
+		Additional class names passed to VisuallyHidden extend the component
+		class name.{ ' ' }
+		<VisuallyHidden as="label" className="test-input" { ...args }>
+			Check out my class!{ ' ' }
+		</VisuallyHidden>
+		Inspect the HTML to see!
+	</>
+);

package/src/visually-hidden/{styles.js → styles.ts}

@@ -1,5 +1,9 @@
-/** @type {import('react').CSSProperties} */
-export const visuallyHidden = {
+/**
+ * External dependencies
+ */
+import type { CSSProperties } from 'react';
+
+export const visuallyHidden: CSSProperties = {
 	border: 0,
 	clip: 'rect(1px, 1px, 1px, 1px)',
 	WebkitClipPath: 'inset( 50% )',

package/src/visually-hidden/test/index.tsx

@@ -0,0 +1,17 @@
+/**
+ * External dependencies
+ */
+import { render, screen } from '@testing-library/react';
+
+/**
+ * Internal dependencies
+ */
+import { VisuallyHidden } from '..';
+
+describe( 'VisuallyHidden', () => {
+	it( 'should render correctly', () => {
+		const text = 'This is hidden';
+		render( <VisuallyHidden>{ text }</VisuallyHidden> );
+		expect( screen.getByText( text ) ).toMatchSnapshot();
+	} );
+} );

package/src/visually-hidden/types.ts

@@ -0,0 +1,11 @@
+/**
+ * External dependencies
+ */
+import type { ReactNode } from 'react';
+
+export type VisuallyHiddenProps = {
+	/**
+	 * The children elements.
+	 */
+	children: ReactNode;
+};

package/tsconfig.json

@@ -57,6 +57,7 @@
 		"src/external-link/**/*",
 		"src/flex/**/*",
 		"src/form-group/**/*",
+		"src/form-toggle/**/*",
 		"src/form-token-field/**/*",
 		"src/grid/**/*",
 		"src/h-stack/**/*",
@@ -86,6 +87,7 @@
 		"src/surface/**/*",
 		"src/text/**/*",
 		"src/text-control/**/*",
+		"src/text-highlight/**/*",
 		"src/textarea-control/**/*",
 		"src/tip/**/*",
 		"src/toggle-group-control/**/*",