@wordpress/block-library 7.9.0 → 7.12.0

package/src/list/test/edit.native.js

@@ -1,16 +1,520 @@
 /**
  * External dependencies
  */
-import { render } from 'test/helpers';
+import {
+	changeTextOfRichText,
+	fireEvent,
+	getEditorHtml,
+	initializeEditor,
+	waitFor,
+	within,
+} from 'test/helpers';
 
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
-import ListEdit from '../edit';
+import { getBlockTypes, unregisterBlockType } from '@wordpress/blocks';
+import { registerCoreBlocks } from '@wordpress/block-library';
 
-describe( 'ListEdit component', () => {
-	it( 'renders without crashing', () => {
-		const screen = render( <ListEdit attributes={ {} } /> );
-		expect( screen.container ).toBeTruthy();
+describe( 'List block', () => {
+	beforeAll( () => {
+		// Register all core blocks
+		registerCoreBlocks( {
+			__experimentalEnableListBlockV2: false,
+		} );
+	} );
+
+	afterAll( () => {
+		// Clean up registered blocks
+		getBlockTypes().forEach( ( block ) => {
+			unregisterBlockType( block.name );
+		} );
+	} );
+
+	it( 'inserts block', async () => {
+		const { getByA11yLabel, getByTestId, getByText } =
+			await initializeEditor();
+
+		fireEvent.press( getByA11yLabel( 'Add block' ) );
+
+		const blockList = getByTestId( 'InserterUI-Blocks' );
+		// onScroll event used to force the FlatList to render all items
+		fireEvent.scroll( blockList, {
+			nativeEvent: {
+				contentOffset: { y: 0, x: 0 },
+				contentSize: { width: 100, height: 100 },
+				layoutMeasurement: { width: 100, height: 100 },
+			},
+		} );
+
+		fireEvent.press( await waitFor( () => getByText( 'List' ) ) );
+
+		expect( getByA11yLabel( /List Block\. Row 1/ ) ).toBeVisible();
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'renders a list with a few items', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><li>Item 1</li><li>Item 2</li><li>Item 3</li></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+		fireEvent.press( listBlock );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+} );
+
+describe( 'List V2 block', () => {
+	beforeAll( () => {
+		// Register all core blocks
+		registerCoreBlocks( {
+			__experimentalEnableListBlockV2: true,
+		} );
+	} );
+
+	afterAll( () => {
+		// Clean up registered blocks
+		getBlockTypes().forEach( ( block ) => {
+			unregisterBlockType( block.name );
+		} );
+	} );
+
+	it( 'inserts block', async () => {
+		const { getByA11yLabel, getByTestId, getByText } =
+			await initializeEditor();
+
+		fireEvent.press( getByA11yLabel( 'Add block' ) );
+
+		const blockList = getByTestId( 'InserterUI-Blocks' );
+		// onScroll event used to force the FlatList to render all items
+		fireEvent.scroll( blockList, {
+			nativeEvent: {
+				contentOffset: { y: 0, x: 0 },
+				contentSize: { width: 100, height: 100 },
+				layoutMeasurement: { width: 100, height: 100 },
+			},
+		} );
+
+		fireEvent.press( await waitFor( () => getByText( 'List' ) ) );
+
+		expect( getByA11yLabel( /List Block\. Row 1/ ) ).toBeVisible();
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'adds one item to the list', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li></li><!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Select List Item block
+		const listItemBlock = getByA11yLabel( /List item Block\. Row 1/ );
+		fireEvent.press( listItemBlock );
+
+		const listItemField =
+			within( listBlock ).getByPlaceholderText( 'List' );
+		changeTextOfRichText( listItemField, 'First list item' );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'shows different indentation levels', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>List item 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>List item 2<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>List item nested 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>List item nested 2<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Extra item 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>Extra item 2</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list --></li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list --></li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>List item 3</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Select List Item block
+		const firstNestedLevelBlock = within( listBlock ).getByA11yLabel(
+			/List item Block\. Row 2/
+		);
+
+		fireEvent(
+			within( firstNestedLevelBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 350,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( firstNestedLevelBlock );
+
+		// Select second level list
+		const secondNestedLevelBlock = within(
+			firstNestedLevelBlock
+		).getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( secondNestedLevelBlock ).getByTestId(
+				'block-list-wrapper'
+			),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( secondNestedLevelBlock );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'changes the indentation level', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Item 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>Item 2</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Select Secont List Item block
+		const listItemBlock = getByA11yLabel( /List item Block\. Row 2/ );
+		fireEvent.press( listItemBlock );
+
+		// Update indentation
+		const indentButton = getByA11yLabel( 'Indent' );
+		fireEvent.press( indentButton );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'removes the indentation level', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Item 1<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Item 2</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list --></li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Select List Item block
+		const firstNestedLevelBlock = within( listBlock ).getByA11yLabel(
+			/List item Block\. Row 1/
+		);
+
+		fireEvent(
+			within( firstNestedLevelBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 350,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( firstNestedLevelBlock );
+
+		// Select Inner block List
+		const innerBlockList = within( firstNestedLevelBlock ).getByA11yLabel(
+			/List Block\. Row 1/
+		);
+
+		fireEvent(
+			within( innerBlockList ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		// Select nested List Item block
+		const listItemBlock = within( innerBlockList ).getByA11yLabel(
+			/List item Block\. Row 1/
+		);
+		fireEvent.press( listItemBlock );
+
+		// Update indentation
+		const outdentButton = getByA11yLabel( 'Outdent' );
+		fireEvent.press( outdentButton );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'changes to ordered list', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Item 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>Item 2</li>
+		<!-- /wp:list-item -->	
+		<!-- wp:list-item -->
+		<li>Item 3</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Update to ordered list
+		const orderedButton = getByA11yLabel( 'Ordered' );
+		fireEvent.press( orderedButton );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'changes to reverse ordered list', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Item 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>Item 2</li>
+		<!-- /wp:list-item -->	
+		<!-- wp:list-item -->
+		<li>Item 3</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel, getByTestId } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Update to ordered list
+		const orderedButton = getByA11yLabel( 'Ordered' );
+		fireEvent.press( orderedButton );
+
+		// Set order to reverse
+
+		// Open block settings
+		fireEvent.press( getByA11yLabel( 'Open Settings' ) );
+		await waitFor(
+			() => getByTestId( 'block-settings-modal' ).props.isVisible
+		);
+
+		const reverseButton = getByA11yLabel( /Reverse list numbering\. Off/ );
+		fireEvent.press( reverseButton );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
+	} );
+
+	it( 'sets a start value to an ordered list', async () => {
+		const initialHtml = `<!-- wp:list -->
+		<ul><!-- wp:list-item -->
+		<li>Item 1</li>
+		<!-- /wp:list-item -->
+		<!-- wp:list-item -->
+		<li>Item 2</li>
+		<!-- /wp:list-item -->	
+		<!-- wp:list-item -->
+		<li>Item 3</li>
+		<!-- /wp:list-item --></ul>
+		<!-- /wp:list -->`;
+
+		const { getByA11yLabel, getByTestId } = await initializeEditor( {
+			initialHtml,
+		} );
+
+		// Select List block
+		const listBlock = getByA11yLabel( /List Block\. Row 1/ );
+
+		fireEvent(
+			within( listBlock ).getByTestId( 'block-list-wrapper' ),
+			'layout',
+			{
+				nativeEvent: {
+					layout: {
+						width: 100,
+						height: 50,
+					},
+				},
+			}
+		);
+
+		fireEvent.press( listBlock );
+
+		// Update to ordered list
+		const orderedButton = getByA11yLabel( 'Ordered' );
+		fireEvent.press( orderedButton );
+
+		// Set order to reverse
+
+		// Open block settings
+		fireEvent.press( getByA11yLabel( 'Open Settings' ) );
+		await waitFor(
+			() => getByTestId( 'block-settings-modal' ).props.isVisible
+		);
+
+		const startValueButton = getByA11yLabel( /Start value\. Empty/ );
+		fireEvent.press( startValueButton );
+		const startValueInput =
+			within( startValueButton ).getByDisplayValue( '' );
+		fireEvent.changeText( startValueInput, '25' );
+
+		expect( getEditorHtml() ).toMatchSnapshot();
 	} );
 } );

package/src/list/transforms.js

@@ -65,19 +65,6 @@ const transforms = {
 				} );
 			},
 		},
-		{
-			type: 'block',
-			blocks: [ 'core/quote', 'core/pullquote' ],
-			transform: ( { value, anchor } ) => {
-				return createBlock( 'core/list', {
-					values: toHTMLString( {
-						value: create( { html: value, multilineTag: 'p' } ),
-						multilineTag: 'li',
-					} ),
-					anchor,
-				} );
-			},
-		},
 		{
 			type: 'raw',
 			selector: 'ol,ul',
@@ -174,40 +161,6 @@ const transforms = {
 					} )
 				),
 		},
-		{
-			type: 'block',
-			blocks: [ 'core/quote' ],
-			transform: ( { values, anchor } ) => {
-				return createBlock( 'core/quote', {
-					value: toHTMLString( {
-						value: create( {
-							html: values,
-							multilineTag: 'li',
-							multilineWrapperTags: [ 'ul', 'ol' ],
-						} ),
-						multilineTag: 'p',
-					} ),
-					anchor,
-				} );
-			},
-		},
-		{
-			type: 'block',
-			blocks: [ 'core/pullquote' ],
-			transform: ( { values, anchor } ) => {
-				return createBlock( 'core/pullquote', {
-					value: toHTMLString( {
-						value: create( {
-							html: values,
-							multilineTag: 'li',
-							multilineWrapperTags: [ 'ul', 'ol' ],
-						} ),
-						multilineTag: 'p',
-					} ),
-					anchor,
-				} );
-			},
-		},
 		{
 			type: 'block',
 			blocks: [ 'core/table-of-contents' ],

package/src/list/v2/edit.js

@@ -24,7 +24,7 @@ import {
 	formatOutdentRTL,
 } from '@wordpress/icons';
 import { createBlock } from '@wordpress/blocks';
-import { useCallback, useEffect } from '@wordpress/element';
+import { useCallback, useEffect, Platform } from '@wordpress/element';
 import deprecated from '@wordpress/deprecated';
 
 /**
@@ -32,8 +32,10 @@ import deprecated from '@wordpress/deprecated';
  */
 import OrderedListSettings from '../ordered-list-settings';
 import { migrateToListV2 } from './migrate';
+import TagName from './tag-name';
 
 const TEMPLATE = [ [ 'core/list-item' ] ];
+const NATIVE_MARGIN_SPACING = 8;
 
 /**
  * At the moment, deprecations don't handle create blocks from attributes
@@ -126,16 +128,21 @@ function IndentUI( { clientId } ) {
 	);
 }
 
-function Edit( { attributes, setAttributes, clientId } ) {
-	const blockProps = useBlockProps();
+function Edit( { attributes, setAttributes, clientId, style } ) {
+	const blockProps = useBlockProps( {
+		...( Platform.isNative && { style } ),
+	} );
 	const innerBlocksProps = useInnerBlocksProps( blockProps, {
 		allowedBlocks: [ 'core/list-item' ],
 		template: TEMPLATE,
 		templateInsertUpdatesSelection: true,
+		...( Platform.isNative && {
+			marginVertical: NATIVE_MARGIN_SPACING,
+			marginHorizontal: NATIVE_MARGIN_SPACING,
+		} ),
 	} );
 	useMigrateOnLoad( attributes, clientId );
 	const { ordered, reversed, start } = attributes;
-	const TagName = ordered ? 'ol' : 'ul';
 
 	const controls = (
 		<BlockControls group="block">
@@ -164,6 +171,7 @@ function Edit( { attributes, setAttributes, clientId } ) {
 	return (
 		<>
 			<TagName
+				ordered={ ordered }
 				reversed={ reversed }
 				start={ start }
 				{ ...innerBlocksProps }

package/src/list/v2/tag-name.js

@@ -0,0 +1,13 @@
+/**
+ * WordPress dependencies
+ */
+import { forwardRef } from '@wordpress/element';
+
+function TagName( props, ref ) {
+	const { ordered, ...extraProps } = props;
+	const Tag = ordered ? 'ol' : 'ul';
+
+	return <Tag ref={ ref } { ...extraProps } />;
+}
+
+export default forwardRef( TagName );

package/src/list/v2/tag-name.native.js

@@ -0,0 +1,12 @@
+/**
+ * WordPress dependencies
+ */
+import { forwardRef } from '@wordpress/element';
+import { View } from '@wordpress/primitives';
+
+function TagName( props, ref ) {
+	const { start, ...extraProps } = props;
+	return <View ref={ ref } { ...extraProps } />;
+}
+
+export default forwardRef( TagName );