Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Raw Handling: allow list attributes #17144

Merged
merged 1 commit into from
Oct 28, 2019
Merged

Raw Handling: allow list attributes #17144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/block-library/src/list/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
"__unstableMultilineWrapperTags": [ "ol", "ul" ],
"default": ""
},
"type": {
"type": "string"
},
"start": {
"type": "number"
},
Expand Down
3 changes: 2 additions & 1 deletion packages/block-library/src/list/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default function ListEdit( {
onReplace,
className,
} ) {
const { ordered, values, reversed, start } = attributes;
const { ordered, values, type, reversed, start } = attributes;
const tagName = ordered ? 'ol' : 'ul';

const controls = ( { value, onChange } ) => (
Expand Down Expand Up @@ -130,6 +130,7 @@ export default function ListEdit( {
onRemove={ () => onReplace( [] ) }
start={ start }
reversed={ reversed }
type={ type }
>
{ controls }
</RichText>
Expand Down
3 changes: 2 additions & 1 deletion packages/block-library/src/list/save.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
import { RichText } from '@wordpress/block-editor';

export default function save( { attributes } ) {
const { ordered, values, reversed, start } = attributes;
const { ordered, values, type, reversed, start } = attributes;
const tagName = ordered ? 'ol' : 'ul';

return (
<RichText.Content
tagName={ tagName }
value={ values }
type={ type }
reversed={ reversed }
start={ start }
multiline="li"
Expand Down
35 changes: 29 additions & 6 deletions packages/block-library/src/list/transforms.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {
const listContentSchema = {
...getPhrasingContentSchema(),
ul: {},
ol: { attributes: [ 'type' ] },
ol: { attributes: [ 'type', 'start', 'reversed' ] },
};

// Recursion is needed.
Expand Down Expand Up @@ -77,12 +77,35 @@ const transforms = {
ul: listContentSchema.ul,
},
transform( node ) {
return createBlock( 'core/list', {
...getBlockAttributes(
'core/list',
node.outerHTML
),
const attributes = {
ordered: node.nodeName === 'OL',
};

if ( attributes.ordered ) {
const type = node.getAttribute( 'type' );

if ( type ) {
attributes.type = type;
}

if ( node.getAttribute( 'reversed' ) !== null ) {
attributes.reversed = true;
}

const start = parseInt( node.getAttribute( 'start' ), 10 );

if (
! isNaN( start ) &&
// start=1 only makes sense if the list is reversed.
( start !== 1 || attributes.reversed )
) {
attributes.start = start;
}
}

return createBlock( 'core/list', {
...getBlockAttributes( 'core/list', node.outerHTML ),
...attributes,
} );
},
},
Expand Down
10 changes: 10 additions & 0 deletions test/integration/__snapshots__/blocks-raw-handling.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,13 @@ exports[`rawHandler should convert a caption shortcode with link 1`] = `
<figure class=\\"wp-block-image alignnone\\"><a href=\\"http://build.wordpress-develop.test/wp-content/uploads/2011/07/100_5478.jpg\\"><img src=\\"http://build.wordpress-develop.test/wp-content/uploads/2011/07/100_5478.jpg?w=604\\" alt=\\"Bell on Wharf\\" class=\\"wp-image-754\\"/></a><figcaption>Bell on wharf in San Francisco</figcaption></figure>
<!-- /wp:image -->"
`;

exports[`rawHandler should convert a list with attributes 1`] = `
"<!-- wp:list {\\"ordered\\":true,\\"type\\":\\"i\\",\\"start\\":2,\\"reversed\\":true} -->
<ol type=\\"i\\" reversed start=\\"2\\"><li>1
<ol start=\\"2\\" reversed=\\"\\" type=\\"i\\">
<li>1</li>
</ol>
</li></ol>
<!-- /wp:list -->"
`;
5 changes: 5 additions & 0 deletions test/integration/blocks-raw-handling.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,4 +287,9 @@ describe( 'rawHandler', () => {
const HTML = readFile( path.join( __dirname, 'fixtures/shortcode-caption-with-caption-link.html' ) );
expect( serialize( rawHandler( { HTML } ) ) ).toMatchSnapshot();
} );

it( 'should convert a list with attributes', () => {
const HTML = readFile( path.join( __dirname, 'fixtures/list-with-attributes.html' ) );
expect( serialize( rawHandler( { HTML } ) ) ).toMatchSnapshot();
} );
} );
7 changes: 7 additions & 0 deletions test/integration/fixtures/list-with-attributes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<ol start="2" reversed type="i">
<li>1
<ol start="2" reversed type="i">
<li>1</li>
</ol>
</li>
</ol>
4 changes: 2 additions & 2 deletions test/integration/fixtures/ms-word-out.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ <h2>This is a heading level 2</h2>
<ul><li>A</li><li>Bulleted<ul><li>Indented</li></ul></li><li>List</li></ul>
<!-- /wp:list -->

<!-- wp:list {"ordered":true} -->
<ol><li>One</li><li>Two</li><li>Three</li></ol>
<!-- wp:list {"ordered":true,"type":"1"} -->
<ol type="1"><li>One</li><li>Two</li><li>Three</li></ol>
<!-- /wp:list -->

<!-- wp:table -->
Expand Down