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.

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

Site Tagline Block #23788

Merged
merged 6 commits into from
Jul 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions docs/designers-developers/developers/themes/theme-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ Each block will declare which style properties it exposes. This has been coined
| Columns | Yes | Yes | Yes | Yes |
| Media & text | Yes | Yes | Yes | Yes |
| Site Title | Yes | Yes | - | Yes |
| Site Tagline | Yes | Yes | - | Yes |

[1] The heading block represents 6 distinct HTML elements: H1-H6. It comes with selectors to target each individual element (ex: core/heading/h1 for H1, etc).

Expand All @@ -182,6 +183,7 @@ Each block will declare which style properties it exposes. This has been coined
| Columns | - | - |
| Media & text | - | - |
| Site Title | Yes | Yes |
| Site Tagline | Yes | Yes |

[1] The heading block represents 6 distinct HTML elements: H1-H6. It comes with selectors to target each individual element (ex: core/heading/h1 for H1, etc).

Expand Down Expand Up @@ -394,6 +396,19 @@ The list of features that are currently supported are:
"lineHeight": <value>
}
}
},
"core/site-tagline": {
"styles": {
"color": {
"background": <value>,
"gradient": <value>,
"text": <value>
},
"typography": {
"fontSize": <value>,
"lineHeight": <value>
}
}
}
}
```
1 change: 1 addition & 0 deletions lib/blocks.php
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ function gutenberg_reregister_core_block_types() {
'query-loop.php' => 'core/query-loop',
'query-pagination.php' => 'core/query-pagination',
'site-logo.php' => 'core/site-logo',
'site-tagline.php' => 'core/site-tagline',
'site-title.php' => 'core/site-title',
'template-part.php' => 'core/template-part',
)
Expand Down
4 changes: 3 additions & 1 deletion packages/block-library/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ import * as widgetArea from './widget-area';

// Full Site Editing Blocks
import * as siteLogo from './site-logo';
import * as siteTagline from './site-tagline';
import * as siteTitle from './site-title';
import * as templatePart from './template-part';
import * as query from './query';
Expand Down Expand Up @@ -199,8 +200,9 @@ export const __experimentalRegisterExperimentalCoreBlocks =
// Register Full Site Editing Blocks.
...( __experimentalEnableFullSiteEditing
? [
siteTitle,
siteLogo,
siteTagline,
siteTitle,
templatePart,
query,
queryLoop,
Expand Down
18 changes: 18 additions & 0 deletions packages/block-library/src/site-tagline/block.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "core/site-tagline",
"category": "design",
"attributes": {
"align": {
"type": "string"
}
},
"supports": {
"html": false,
"lightBlockWrapper": true,
"__experimentalColor": {
"gradients": true
},
"__experimentalFontSize": true,
"__experimentalLineHeight": true
}
}
49 changes: 49 additions & 0 deletions packages/block-library/src/site-tagline/edit.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* External dependencies
*/
import classnames from 'classnames';

/**
* WordPress dependencies
*/
import { useEntityProp } from '@wordpress/core-data';
import {
AlignmentToolbar,
__experimentalBlock as Block,
BlockControls,
RichText,
} from '@wordpress/block-editor';
import { __ } from '@wordpress/i18n';

export default function SiteTaglineEdit( { attributes, setAttributes } ) {
const { align } = attributes;
const [ siteTagline, setSiteTagline ] = useEntityProp(
'root',
'site',
'description'
);

return (
<>
<BlockControls>
<AlignmentToolbar
onChange={ ( newAlign ) =>
setAttributes( { align: newAlign } )
}
value={ align }
/>
</BlockControls>

<RichText
allowedFormats={ [] }
className={ classnames( {
[ `has-text-align-${ align }` ]: align,
} ) }
onChange={ setSiteTagline }
placeholder={ __( 'Site Tagline' ) }
tagName={ Block.p }
value={ siteTagline }
/>
</>
);
}
11 changes: 11 additions & 0 deletions packages/block-library/src/site-tagline/icon.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/**
* WordPress dependencies
*/
import { SVG, Path } from '@wordpress/components';

export default (
<SVG xmlns="http://www.w3.org/2000/svg" width="24" height="24">
<Path fill="none" d="M0 0h24v24H0z" />
<Path d="M4 9h16v2H4V9zm0 4h10v2H4v-2z" />
</SVG>
);
21 changes: 21 additions & 0 deletions packages/block-library/src/site-tagline/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';

/**
* Internal dependencies
*/
import metadata from './block.json';
import edit from './edit';
import icon from './icon';

const { name } = metadata;
export { metadata, name };

export const settings = {
title: __( 'Site Tagline' ),
keywords: [ __( 'description' ) ],
icon,
edit,
};
36 changes: 36 additions & 0 deletions packages/block-library/src/site-tagline/index.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?php
/**
* Server-side rendering of the `core/site-tagline` block.
*
* @package WordPress
*/

/**
* Renders the `core/site-tagline` block on the server.
*
* @param array $attributes The block attributes.
*
* @return string The render.
*/
function render_block_core_site_tagline( $attributes ) {
$align_class_name = empty( $attributes['align'] ) ? '' : ' ' . "has-text-align-{$attributes['align']}";

return sprintf(
'<p class="%1$s">%2$s</p>',
'wp-block-site-tagline' . esc_attr( $align_class_name ),
get_bloginfo( 'description' )
);
}

/**
* Registers the `core/site-tagline` block on the server.
*/
function register_block_core_site_tagline() {
register_block_type_from_metadata(
__DIR__ . '/site-tagline',
array(
'render_callback' => 'render_block_core_site_tagline',
)
);
}
add_action( 'init', 'register_block_core_site_tagline' );
4 changes: 4 additions & 0 deletions packages/e2e-tests/fixtures/block-transforms.js
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,10 @@ export const EXPECTED_TRANSFORMS = {
originalBlock: 'Shortcode',
availableTransforms: [ 'Group' ],
},
'core__site-tagline': {
availableTransforms: [ 'Group' ],
originalBlock: 'Site Tagline',
},
'core__site-title': {
availableTransforms: [ 'Group' ],
originalBlock: 'Site Title',
Expand Down
1 change: 1 addition & 0 deletions packages/e2e-tests/fixtures/blocks/core__site-tagline.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- wp:site-tagline /-->
10 changes: 10 additions & 0 deletions packages/e2e-tests/fixtures/blocks/core__site-tagline.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[
{
"clientId": "_clientId_0",
"name": "core/site-tagline",
"isValid": true,
"attributes": {},
"innerBlocks": [],
"originalContent": ""
}
]
18 changes: 18 additions & 0 deletions packages/e2e-tests/fixtures/blocks/core__site-tagline.parsed.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[
{
"blockName": "core/site-tagline",
"attrs": {},
"innerBlocks": [],
"innerHTML": "",
"innerContent": []
},
{
"blockName": null,
"attrs": {},
"innerBlocks": [],
"innerHTML": "\n",
"innerContent": [
"\n"
]
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- wp:site-tagline /-->