Repository navigation
feat: clarify label & add help text with link #70451
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,6 +27,7 @@ import { | |
| TextControl, | ||
| ToolbarButton, | ||
| Popover, | ||
| ExternalLink, | ||
| __experimentalToolsPanel as ToolsPanel, | ||
| __experimentalToolsPanelItem as ToolsPanelItem, | ||
| __experimentalToggleGroupControl as ToggleGroupControl, | ||
|
|
@@ -474,7 +475,17 @@ function ButtonEdit( props ) { | |
| <TextControl | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| label={ __( 'Link Relation' ) } | ||
| help={ | ||
| <> | ||
| { __( | ||
| 'The Link Relation attribute defines the relationship between a linked resource and the current document.' | ||
|
Contributor
There was a problem hiding this comment. I'd like to avoid using meaningless link text like "Learn more". Can we instead place the link on the word "link relation attribute"?
Contributor
Author
There was a problem hiding this comment. Thanks @joedolson. I'd incorporate those changes. Btw, what do you think about the sentence case thing suggested by @Mamaduka earlier?
Contributor
Author
There was a problem hiding this comment. 
@Mamaduka @joedolson I have got the link inline with element interpolation. From what I think, now it makes sense to keep the casings as it is since now "Link Relation" is a term that we refer externally directly by clicking on it. I am not sure though and not aware if any guidelines are there for such a case. What do you think?
Member
There was a problem hiding this comment. Don't have a strong opinion here; I usually follow the text copy guidelines. We could keep casing in the help text, but let's fix it for the label.
Contributor
Author
There was a problem hiding this comment. Do you mean the label above the input box? That is capitalized automatically. All labels are like that. |
||
| ) }{ ' ' } | ||
| <ExternalLink href="https://developer.mozilla.org/docs/Web/HTML/Attributes/rel"> | ||
| { __( 'Learn more.' ) } | ||
| </ExternalLink> | ||
| </> | ||
| } | ||
| value={ rel || '' } | ||
| onChange={ ( newRel ) => | ||
| setAttributes( { rel: newRel } ) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -180,7 +180,7 @@ function ButtonEdit( props ) { | |
| label: __( 'Open in new tab' ), | ||
| }, | ||
| linkRel: { | ||
| label: __( 'Link Relation' ), | ||
| placeholder: _x( 'None', 'Link rel attribute value placeholder' ), | ||
| }, | ||
| }; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -147,7 +147,7 @@ function LinkSettings( { | |
| label: __( 'Open in new tab' ), | ||
| }, | ||
| linkRel: { | ||
| label: __( 'Link Relation' ), | ||
| placeholder: _x( 'None', 'Link rel attribute value placeholder' ), | ||
| }, | ||
| }; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,7 @@ import { | |
| Button, | ||
| Spinner, | ||
| TextControl, | ||
| ExternalLink, | ||
| __experimentalToolsPanel as ToolsPanel, | ||
| __experimentalToolsPanelItem as ToolsPanelItem, | ||
| } from '@wordpress/components'; | ||
|
|
@@ -316,7 +317,7 @@ export default function PostFeaturedImageEdit( { | |
| ) } | ||
| { isLink && ( | ||
| <ToolsPanelItem | ||
| label={ __( 'Link Relation' ) } | ||
| isShownByDefault | ||
| hasValue={ () => !! rel } | ||
| onDeselect={ () => | ||
|
|
@@ -328,7 +329,17 @@ export default function PostFeaturedImageEdit( { | |
| <TextControl | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| label={ __( 'Link Relation' ) } | ||
| help={ | ||
| <> | ||
| { __( | ||
| 'The Link Relation attribute defines the relationship between a linked resource and the current document.' | ||
|
|
||
| ) }{ ' ' } | ||
| <ExternalLink href="https://developer.mozilla.org/docs/Web/HTML/Attributes/rel"> | ||
| { __( 'Learn more.' ) } | ||
| </ExternalLink> | ||
| </> | ||
| } | ||
| value={ rel } | ||
| onChange={ ( newRel ) => | ||
| setAttributes( { rel: newRel } ) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ import { | |
| import { | ||
| ToggleControl, | ||
| TextControl, | ||
| ExternalLink, | ||
| __experimentalToolsPanel as ToolsPanel, | ||
| __experimentalToolsPanelItem as ToolsPanelItem, | ||
| } from '@wordpress/components'; | ||
|
|
@@ -205,7 +206,7 @@ export default function PostTitleEdit( { | |
| /> | ||
| </ToolsPanelItem> | ||
| <ToolsPanelItem | ||
| label={ __( 'Link Relation' ) } | ||
| isShownByDefault | ||
| hasValue={ () => !! rel } | ||
| onDeselect={ () => | ||
|
|
@@ -215,7 +216,17 @@ export default function PostTitleEdit( { | |
| <TextControl | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| label={ __( 'Link Relation' ) } | ||
| help={ | ||
| <> | ||
| { __( | ||
| 'The Link Relation attribute defines the relationship between a linked resource and the current document.' | ||
|
|
||
| ) }{ ' ' } | ||
| <ExternalLink href="https://developer.mozilla.org/docs/Web/HTML/Attributes/rel"> | ||
| { __( 'Learn more.' ) } | ||
| </ExternalLink> | ||
| </> | ||
| } | ||
| value={ rel } | ||
| onChange={ ( newRel ) => | ||
| setAttributes( { rel: newRel } ) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,6 +14,7 @@ import { | |
| ToggleControl, | ||
| ToolbarGroup, | ||
| TextControl, | ||
| ExternalLink, | ||
| __experimentalInputControl as InputControl, | ||
| __experimentalToolsPanel as ToolsPanel, | ||
| __experimentalToolsPanelItem as ToolsPanelItem, | ||
|
|
@@ -301,7 +302,17 @@ export default function RSSEdit( { attributes, setAttributes } ) { | |
| <TextControl | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| label={ __( 'Link Relation' ) } | ||
| help={ | ||
| <> | ||
| { __( | ||
| 'The Link Relation attribute defines the relationship between a linked resource and the current document.' | ||
|
|
||
| ) }{ ' ' } | ||
| <ExternalLink href="https://developer.mozilla.org/docs/Web/HTML/Attributes/rel"> | ||
| { __( 'Learn more.' ) } | ||
| </ExternalLink> | ||
| </> | ||
| } | ||
| value={ rel || '' } | ||
| onChange={ ( value ) => setAttributes( { rel: value } ) } | ||
| /> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ import { | |
| Dropdown, | ||
| TextControl, | ||
| ToolbarButton, | ||
| ExternalLink, | ||
| __experimentalToolsPanel as ToolsPanel, | ||
| __experimentalToolsPanelItem as ToolsPanelItem, | ||
| __experimentalInputControlSuffixWrapper as InputControlSuffixWrapper, | ||
|
|
@@ -243,7 +244,17 @@ const SocialLinkEdit = ( { | |
| <TextControl | ||
| __next40pxDefaultSize | ||
| __nextHasNoMarginBottom | ||
| label={ __( 'Link Relation' ) } | ||
| help={ | ||
| <> | ||
| { __( | ||
| 'The Link Relation attribute defines the relationship between a linked resource and the current document.' | ||
|
|
||
| ) }{ ' ' } | ||
| <ExternalLink href="https://developer.mozilla.org/docs/Web/HTML/Attributes/rel"> | ||
| { __( 'Learn more.' ) } | ||
| </ExternalLink> | ||
| </> | ||
| } | ||
| value={ rel || '' } | ||
| onChange={ ( value ) => setAttributes( { rel: value } ) } | ||
| /> | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think similar labels use sentence case. See: https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/documentation/copy-guide.md#five-pay-attention-to-capitalization