Site Tagline: Add example so that it will display in style book (#48300)

* Site Tagline: Add example so that it will display in style book * Add placeholder attribute
WordPress · Feb 27, 2023 · efc8ad9 · efc8ad9
1 parent 82549ea
commit efc8ad9
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/docs/reference-guides/core-blocks.md b/docs/reference-guides/core-blocks.md
@@ -744,7 +744,7 @@ Describe in a few words what the site is about. The tagline can be used in searc
 -	**Name:** core/site-tagline
 -	**Category:** theme
 -	**Supports:** align (full, wide), anchor, color (background, gradients, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~
--	**Attributes:** textAlign
+-	**Attributes:** placeholder, textAlign
 
 ## Site Title
 

diff --git a/packages/block-library/src/site-tagline/block.json b/packages/block-library/src/site-tagline/block.json
@@ -8,6 +8,9 @@
 	"keywords": [ "description" ],
 	"textdomain": "default",
 	"attributes": {
+		"placeholder": {
+			"type": "string"
+		},
 		"textAlign": {
 			"type": "string"
 		}

diff --git a/packages/block-library/src/site-tagline/edit.js b/packages/block-library/src/site-tagline/edit.js
@@ -22,7 +22,7 @@ export default function SiteTaglineEdit( {
 	setAttributes,
 	insertBlocksAfter,
 } ) {
-	const { textAlign } = attributes;
+	const { placeholder, textAlign } = attributes;
 	const { canUserEdit, tagline } = useSelect( ( select ) => {
 		const { canUser, getEntityRecord, getEditedEntityRecord } =
 			select( coreStore );
@@ -57,7 +57,7 @@ export default function SiteTaglineEdit( {
 			allowedFormats={ [] }
 			onChange={ setTagline }
 			aria-label={ __( 'Site tagline text' ) }
-			placeholder={ __( 'Write site tagline…' ) }
+			placeholder={ placeholder || __( 'Write site tagline…' ) }
 			tagName="p"
 			value={ tagline }
 			disableLineBreaks

diff --git a/packages/block-library/src/site-tagline/index.js b/packages/block-library/src/site-tagline/index.js
@@ -1,3 +1,8 @@
+/**
+ * WordPress dependencies
+ */
+import { __ } from '@wordpress/i18n';
+
 /**
  * Internal dependencies
  */
@@ -13,6 +18,11 @@ export { metadata, name };
 export const settings = {
 	icon,
 	edit,
+	example: {
+		attributes: {
+			placeholder: __( 'A site tagline.' ),
+		},
+	},
 	deprecated,
 };