Experimental Link creation interface

packages/block-editor/src/components/index.js

@@ -22,6 +22,7 @@ export { default as __experimentalGradientPickerControl } from './gradient-picke
 export { default as InnerBlocks } from './inner-blocks';
 export { default as InspectorAdvancedControls } from './inspector-advanced-controls';
 export { default as InspectorControls } from './inspector-controls';
+export { default as __experimentalLinkControl } from './link-control';
 export { default as MediaPlaceholder } from './media-placeholder';
 export { default as MediaUpload } from './media-upload';
 export { default as MediaUploadCheck } from './media-upload/check';

packages/block-editor/src/components/link-control/README.md

@@ -0,0 +1,50 @@
+# Link Control
+
+## Props
+
+### className
+
+- Type: `String`
+- Required: Yes
+
+### currentLink
+
+- Type: `Object`
+- Required: Yes
+
+### currentSettings
+
+- Type: `Object`
+- Required: Yes
+
+### fetchSearchSuggestions
+
+- Type: `Function`
+- Required: No
+
+## Event handlers
+
+### onClose
+
+- Type: `Function`
+- Required: No
+
+### onKeyDown
+
+- Type: `Function`
+- Required: No
+
+### onKeyPress
+
+- Type: `Function`
+- Required: No
+
+### onLinkChange
+
+- Type: `Function`
+- Required: No
+
+### onSettingChange
+
+- Type: `Function`
+- Required: No

packages/block-editor/src/components/link-control/index.js

@@ -0,0 +1,249 @@
+/**
+ * External dependencies
+ */
+import classnames from 'classnames';
+import { isFunction, noop, startsWith } from 'lodash';
+
+/**
+ * WordPress dependencies
+ */
+import {
+	Button,
+	ExternalLink,
+	Popover,
+} from '@wordpress/components';
+import { __ } from '@wordpress/i18n';
+
+import {
+	useCallback,
+	useState,
+	useEffect,
+	Fragment,
+} from '@wordpress/element';
+
+import {
+	safeDecodeURI,
+	filterURLForDisplay,
+	isURL,
+	prependHTTP,
+	getProtocol,
+} from '@wordpress/url';
+
+import { withInstanceId, compose } from '@wordpress/compose';
+import { withSelect } from '@wordpress/data';
+
+/**
+ * Internal dependencies
+ */
+import LinkControlSettingsDrawer from './settings-drawer';
+import LinkControlSearchItem from './search-item';
+import LinkControlSearchInput from './search-input';
+
+function LinkControl( {
+	className,
+	currentLink,
+	currentSettings,
+	fetchSearchSuggestions,
+	instanceId,
+	onClose = noop,
+	onKeyDown = noop,
+	onKeyPress = noop,
+	onLinkChange = noop,
+	onSettingsChange = { noop },
+} ) {
+	// State
+	const [ inputValue, setInputValue ] = useState( '' );
+	const [ isEditingLink, setIsEditingLink ] = useState( false );
+
+	// Effects
+	useEffect( () => {
+		// If we have a link then stop editing mode
+		if ( currentLink ) {
+			setIsEditingLink( false );
+		} else {
+			setIsEditingLink( true );
+		}
+	}, [ currentLink ] );
+
+	// Handlers
+
+	/**
+	 * onChange LinkControlSearchInput event handler
+	 *
+	 * @param {string} value Current value returned by the search.
+	 */
+	const onInputChange = ( value = '' ) => {
+		setInputValue( value );
+	};
+
+	// Utils
+	const startEditMode = () => {
+		if ( isFunction( onLinkChange ) ) {
+			onLinkChange();
+		}
+	};
+
+	const closeLinkUI = () => {
+		resetInput();
+		onClose();
+	};
+
+	const resetInput = () => {
+		setInputValue( '' );
+	};
+
+	const handleDirectEntry = ( value ) => {
+		let type = 'URL';
+
+		const protocol = getProtocol( value ) || '';
+
+		if ( protocol.includes( 'mailto' ) ) {
+			type = 'mailto';
+		}
+
+		if ( protocol.includes( 'tel' ) ) {
+			type = 'tel';
+		}
+
+		if ( startsWith( value, '#' ) ) {
+			type = 'internal';
+		}
+
+		return Promise.resolve(
+			[ {
+				id: '-1',
+				title: value,
+				url: type === 'URL' ? prependHTTP( value ) : value,
+				type,
+			} ]
+		);
+	};
+
+	const handleEntitySearch = async ( value ) => {
+		const results = await Promise.all( [
+			fetchSearchSuggestions( value ),
+			handleDirectEntry( value ),
+		] );
+
+		const couldBeURL = ! value.includes( ' ' );
+
+		// If it's potentially a URL search then concat on a URL search suggestion
+		// just for good measure. That way once the actual results run out we always
+		// have a URL option to fallback on.
+		return couldBeURL ? results[ 0 ].concat( results[ 1 ] ) : results[ 0 ];
+	};
+
+	// Effects
+	const getSearchHandler = useCallback( ( value ) => {
+		const protocol = getProtocol( value ) || '';
+		const isMailto = protocol.includes( 'mailto' );
+		const isInternal = startsWith( value, '#' );
+		const isTel = protocol.includes( 'tel' );
+
+		const handleManualEntry = isInternal || isMailto || isTel || isURL( value ) || ( value && value.includes( 'www.' ) );
+
+		return ( handleManualEntry ) ? handleDirectEntry( value ) : handleEntitySearch( value );
+	}, [ handleDirectEntry, fetchSearchSuggestions ] );
+
+	// Render Components
+	const renderSearchResults = ( { suggestionsListProps, buildSuggestionItemProps, suggestions, selectedSuggestion, isLoading } ) => {
+		const resultsListClasses = classnames( 'block-editor-link-control__search-results', {
+			'is-loading': isLoading,
+		} );
+
+		const manualLinkEntryTypes = [ 'url', 'mailto', 'tel', 'internal' ];
+
+		return (
+			<div className="block-editor-link-control__search-results-wrapper">
+				<div { ...suggestionsListProps } className={ resultsListClasses }>
+					{ suggestions.map( ( suggestion, index ) => (
+						<LinkControlSearchItem
+							key={ `${ suggestion.id }-${ suggestion.type }` }
+							itemProps={ buildSuggestionItemProps( suggestion, index ) }
+							suggestion={ suggestion }
+							onClick={ () => onLinkChange( suggestion ) }
+							isSelected={ index === selectedSuggestion }
+							isURL={ manualLinkEntryTypes.includes( suggestion.type.toLowerCase() ) }
+							searchTerm={ inputValue }
+						/>
+					) ) }
+				</div>
+			</div>
+		);
+	};
+
+	return (
+		<Popover
+			className={ classnames( 'block-editor-link-control', className ) }
+			onClose={ closeLinkUI }
+			position="bottom center"
+			focusOnMount="firstElement"
+		>
+			<div className="block-editor-link-control__popover-inner">
+				<div className="block-editor-link-control__search">
+
+					{ ( ! isEditingLink && currentLink ) && (
+						<Fragment>
+							<p className="screen-reader-text" id={ `current-link-label-${ instanceId }` }>
+								{ __( 'Currently selected' ) }:
+							</p>
+							<div
+								aria-labelledby={ `current-link-label-${ instanceId }` }
+								aria-selected="true"
+								className={ classnames( 'block-editor-link-control__search-item', {
+									'is-current': true,
+								} ) }
+							>
+								<span className="block-editor-link-control__search-item-header">
+
+									<ExternalLink
+										className="block-editor-link-control__search-item-title"
+										href={ currentLink.url }
+									>
+										{ currentLink.title }
+									</ExternalLink>
+									<span className="block-editor-link-control__search-item-info">{ filterURLForDisplay( safeDecodeURI( currentLink.url ) ) || '' }</span>
+								</span>
+
+								<Button isDefault onClick={ startEditMode } className="block-editor-link-control__search-item-action block-editor-link-control__search-item-action--edit">
+									{ __( 'Change' ) }
+								</Button>
+							</div>
+						</Fragment>
+					) }
+
+					{ isEditingLink && (
+						<LinkControlSearchInput
+							value={ inputValue }
+							onChange={ onInputChange }
+							onSelect={ onLinkChange }
+							renderSuggestions={ renderSearchResults }
+							fetchSuggestions={ getSearchHandler }
+							onReset={ resetInput }
+							onKeyDown={ onKeyDown }
+							onKeyPress={ onKeyPress }
+						/>
+					) }
+
+					{ ! isEditingLink && (
+						<LinkControlSettingsDrawer settings={ currentSettings } onSettingChange={ onSettingsChange } />
+					) }
+				</div>
+			</div>
+		</Popover>
+	);
+}
+
+export default compose(
+	withInstanceId,
+	withSelect( ( select, ownProps ) => {
+		if ( ownProps.fetchSearchSuggestions && isFunction( ownProps.fetchSearchSuggestions ) ) {
+			return;
+		}
+
+		const { getSettings } = select( 'core/block-editor' );
+		return {
+			fetchSearchSuggestions: getSettings().__experimentalFetchLinkSuggestions,
+		};
+	} )
+)( LinkControl );

packages/block-editor/src/components/link-control/search-input.js

@@ -0,0 +1,69 @@
+
+/**
+ * WordPress dependencies
+ */
+import { __ } from '@wordpress/i18n';
+import { IconButton } from '@wordpress/components';
+import { ENTER } from '@wordpress/keycodes';
+
+/**
+ * Internal dependencies
+ */
+import { URLInput } from '../';
+
+const LinkControlSearchInput = ( {
+	value,
+	onChange,
+	onSelect,
+	renderSuggestions,
+	fetchSuggestions,
+	onReset,
+	onKeyDown,
+	onKeyPress,
+} ) => {
+	const selectItemHandler = ( selection, suggestion ) => {
+		onChange( selection );
+
+		if ( suggestion ) {
+			onSelect( suggestion );
+		}
+	};
+
+	const stopFormEventsPropagation = ( event ) => {
+		event.preventDefault();
+		event.stopPropagation();
+	};
+
+	return (
+		<form onSubmit={ stopFormEventsPropagation }>
+			<URLInput
+				className="block-editor-link-control__search-input"
+				value={ value }
+				onChange={ selectItemHandler }
+				onKeyDown={ ( event ) => {
+					if ( event.keyCode === ENTER ) {
+						return;
+					}
+					onKeyDown( event );
+				} }
+				onKeyPress={ onKeyPress }
+				placeholder={ __( 'Search or type url' ) }
+				__experimentalRenderSuggestions={ renderSuggestions }
+				__experimentalFetchLinkSuggestions={ fetchSuggestions }
+				__experimentalHandleURLSuggestions={ true }
+			/>
+
+			<IconButton
+				disabled={ ! value.length }
+				type="reset"
+				label={ __( 'Reset' ) }
+				icon="no-alt"
+				className="block-editor-link-control__search-reset"
+				onClick={ onReset }
+			/>
+
+		</form>
+	);
+};
+
+export default LinkControlSearchInput;