Update/unify link interfaces #6392 #7022
There are no files selected for viewing
This file contains 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 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 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 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 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 |
|---|---|---|
|
|
@@ -11,4 +11,4 @@ | |
| "attrs": {}, | ||
| "innerHTML": "\n" | ||
| } | ||
| ] | ||
This file contains 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 |
|---|---|---|
|
|
@@ -9,39 +9,112 @@ import classnames from 'classnames'; | |
| import './style.scss'; | ||
| import { __ } from '@wordpress/i18n'; | ||
| import { Component } from '@wordpress/element'; | ||
| import { IconButton, ToggleControl, Popover } from '@wordpress/components'; | ||
| import { keycodes } from '@wordpress/utils'; | ||
| import { filterURLForDisplay } from '../../utils/url'; | ||
|
There was a problem hiding this comment. Would you mind putting this into a separate dependencies section labelled "Internal dependencies" ? See: https://github.com/WordPress/gutenberg/blob/master/docs/reference/coding-guidelines.md#imports Notably, this would apply for any imports which are made to a relative path within the same top-level folder. There was a problem hiding this comment. Thank you for the link and my apologies |
||
| import { prependHTTP } from '@wordpress/url'; | ||
|
|
||
| const { ESCAPE, LEFT, RIGHT, UP, DOWN, BACKSPACE, ENTER } = keycodes; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import UrlInput from './'; | ||
| const stopKeyPropagation = ( event ) => event.stopPropagation(); | ||
|
|
||
| class UrlInputButton extends Component { | ||
| constructor() { | ||
| super( ...arguments ); | ||
| this.toggle = this.toggle.bind( this ); | ||
| this.submitLink = this.submitLink.bind( this ); | ||
| this.dropLink = this.dropLink.bind( this ); | ||
| this.toggleLinkSettingsVisibility = this.toggleLinkSettingsVisibility.bind( this ); | ||
| this.setLinkTarget = this.setLinkTarget.bind( this ); | ||
| this.onChangeLinkValue = this.onChangeLinkValue.bind( this ); | ||
| this.onKeyDown = this.onKeyDown.bind( this ); | ||
| this.editLink = this.editLink.bind( this ); | ||
|
|
||
| this.state = { | ||
| expanded: false, | ||
| isEditing: true, | ||
| settingsVisible: false, | ||
| opensInNewWindow: this.props.attributes.target === '_blank' ? true : false, | ||
| linkValue: this.props.url, | ||
| }; | ||
| } | ||
|
|
||
| onKeyDown( event ) { | ||
| if ( event.keyCode === ESCAPE ) { | ||
| this.dropLink(); | ||
| this.toggle(); | ||
| } | ||
| if ( [ LEFT, DOWN, RIGHT, UP, BACKSPACE, ENTER ].indexOf( event.keyCode ) > -1 ) { | ||
| stopKeyPropagation( event ); | ||
| } | ||
| } | ||
|
|
||
| dropLink() { | ||
| this.props.setAttributes( { href: null } ); | ||
| this.setState( { linkValue: '', settingsVisible: false } ); | ||
| } | ||
|
|
||
| editLink() { | ||
| this.setState( { isEditing: ! this.state.isEditing } ); | ||
| } | ||
|
|
||
| toggle() { | ||
| this.setState( { expanded: ! this.state.expanded } ); | ||
| } | ||
|
|
||
| onChangeLinkValue( value ) { | ||
| this.setState( { linkValue: value } ); | ||
| } | ||
|
|
||
| submitLink( event ) { | ||
| event.preventDefault(); | ||
| const value = prependHTTP( this.state.linkValue ); | ||
| this.props.setAttributes( { | ||
| href: value, | ||
| } ); | ||
| this.setState( { isEditing: false, linkValue: value } ); | ||
| } | ||
|
|
||
| toggleLinkSettingsVisibility() { | ||
| this.setState( ( state ) => ( { settingsVisible: ! state.settingsVisible } ) ); | ||
| } | ||
|
|
||
| setLinkTarget( opensInNewWindow ) { | ||
| this.setState( { opensInNewWindow } ); | ||
|
There was a problem hiding this comment. Do we need to track this as part of state? Or can it be inferred from props in const opensInNewWindow = ( this.props.attributes.target === '_blank' );The hope being that we could consolidate to one source of truth (attributes), rather than tracking in two places, which is more prone to falling out of sync. Edit: I see after the fact that this is also how we populate the initial state in the |
||
| if ( opensInNewWindow ) { | ||
| this.props.setAttributes( { | ||
| target: '_blank', | ||
| rel: 'noreferrer noopener', | ||
| } ); | ||
| } else { | ||
| this.props.setAttributes( { | ||
| target: null, | ||
| rel: null, | ||
| } ); | ||
| } | ||
| } | ||
|
|
||
| render() { | ||
| const { url, attributes: { id } } = this.props; | ||
| const { expanded, settingsVisible, opensInNewWindow, linkValue, isEditing } = this.state; | ||
| const buttonLabel = url ? __( 'Edit Link' ) : __( 'Insert Link' ); | ||
|
|
||
| const linkSettings = settingsVisible && ( | ||
| <div className="editor-format-toolbar__link-modal-line editor-format-toolbar__link-settings"> | ||
|
There was a problem hiding this comment. The coding guidelines for CSS naming is written such that this is not a valid class name to assign to this component. It's reflective of the fact that components are meant to compose one another, and shouldn't be inheriting behaviors, since it can lead to accidental breakage if a change to the format toolbar inadvertently affects this component. Isolating components to silo their behavior / silos helps prevent this. What I'd like to see instead, and what seemed to be hinted by the idea of "unifying" in the original pull request, is that instead of duplicating what already exists elsewhere, we ought to consider creating a new, separate component which contains the shared behavior (of link management), then use that both here and in other existing usage. |
||
| <ToggleControl | ||
| label={ __( 'Open in new window' ) } | ||
| checked={ opensInNewWindow } | ||
| onChange={ this.setLinkTarget } | ||
| /> | ||
| </div> | ||
| ); | ||
|
|
||
| return ( | ||
| <div className="editor-url-input__button" > | ||
| <IconButton | ||
| icon="admin-links" | ||
| label={ buttonLabel } | ||
|
|
@@ -50,28 +123,73 @@ class UrlInputButton extends Component { | |
| 'is-active': url, | ||
| } ) } | ||
| /> | ||
| { | ||
| expanded && ( | ||
| <Popover | ||
| position="bottom center" | ||
| focusOnMount={ true } | ||
| key={ id } | ||
| > | ||
| { isEditing && ( | ||
| // Disable reason: KeyPress must be suppressed so the block doesn't hide the toolbar | ||
| /* eslint-disable jsx-a11y/no-noninteractive-element-interactions */ | ||
| <form | ||
| className="editor-url-input__button-modal" | ||
| onSubmit={ this.submitLink } | ||
| onKeyPress={ stopKeyPropagation } | ||
| onKeyDown={ this.onKeyDown } | ||
| > | ||
| <div className="editor-url-input__button-modal-line"> | ||
| <UrlInput value={ linkValue } onKeyPress={ stopKeyPropagation } onChange={ this.onChangeLinkValue } data-test="UrlInput" /> | ||
| <IconButton | ||
| icon="editor-break" | ||
| label={ __( 'Submit' ) } | ||
| type="submit" | ||
| /> | ||
| <IconButton | ||
| className="editor-format-toolbar__link-settings-toggle" | ||
| icon="ellipsis" | ||
| label={ __( 'Link Settings' ) } | ||
| onClick={ this.toggleLinkSettingsVisibility } | ||
| aria-expanded={ settingsVisible } | ||
| /> | ||
| </div> | ||
| { linkSettings } | ||
| </form> | ||
| ) } | ||
|
|
||
| { ! isEditing && ( | ||
| // Disable reason: KeyPress must be suppressed so the block doesn't hide the toolbar | ||
| /* eslint-disable jsx-a11y/no-static-element-interactions */ | ||
| <div | ||
| className="editor-format-toolbar__link-modal" | ||
| onKeyPress={ stopKeyPropagation } | ||
| > | ||
| <div className="editor-format-toolbar__link-modal-line"> | ||
| <a | ||
| className="editor-format-toolbar__link-value" | ||
| href={ url } | ||
| target="_blank" | ||
| > | ||
| { url && filterURLForDisplay( decodeURI( url ) ) } | ||
| </a> | ||
| <IconButton icon="edit" label={ __( 'Edit' ) } onClick={ this.editLink } /> | ||
| <IconButton | ||
| className="editor-format-toolbar__link-settings-toggle" | ||
| icon="ellipsis" | ||
| label={ __( 'Link Settings' ) } | ||
| onClick={ this.toggleLinkSettingsVisibility } | ||
| aria-expanded={ settingsVisible } | ||
| /> | ||
| </div> | ||
| { linkSettings } | ||
| </div> | ||
| /* eslint-enable jsx-a11y/no-static-element-interactions */ | ||
| ) } | ||
| </Popover> | ||
| ) | ||
| } | ||
| </div > | ||
|
There was a problem hiding this comment. This change, while not explicitly part of the coding standards, does not seem necessary and is in contrast with style convention of JSX used elsewhere in the codebase. |
||
| ); | ||
| } | ||
| } | ||
|
|
||
This file contains 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 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 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
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.
Can you explain why we need the
defaultvalue?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.
It was because I kept receiving this error when running tests. I wasn't exactly sure what to do so please feel free to suggest and I'll look into it!