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.

Sign up for GitHub

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

Make sure autocompleted values make it into the block's saved content #7486

Merged
merged 3 commits into from
Jul 5, 2018
Merged

Make sure autocompleted values make it into the block's saved content #7486

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76193e4
Dispatch input event on insertCompletion
notnownikki Jun 26, 2018
fd62aed
Import closest polyfill
notnownikki Jun 27, 2018
86e6638
Avoid redisplaying menu due to completion events
brandonpayton Jul 4, 2018
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
25 changes: 22 additions & 3 deletions components/autocomplete/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*/
import classnames from 'classnames';
import { escapeRegExp, find, filter, map, debounce } from 'lodash';
import 'element-closest';

/**
* WordPress dependencies
Expand Down Expand Up @@ -243,6 +244,16 @@ export class Autocomplete extends Component {
range.setStartAfter( child );
}
range.deleteContents();

let inputEvent;
if ( undefined !== window.InputEvent ) {
inputEvent = new window.InputEvent( 'input', { bubbles: true, cancelable: false } );
} else {
// IE11 doesn't provide an InputEvent constructor.
inputEvent = document.createEvent( 'UIEvent' );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honest question: what makes UIEvent more apt than Event? Can we document that choice?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was following @brandonpayton's lead on this... but looking at it, for consistency, shouldn't it be an InputEvent?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps. :) Since this is an IE quirk, I don't know. I brought up Event because the typical examples out there on how to "deal with IE" use it instead of other event types.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, InputEvent is not supported at all, even with the fallback interface. It has to be either Event or UIEvent.

Copy link
Member

@brandonpayton brandonpayton Jun 27, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we would be fine using Event, but my reason is that the InputEvent interface is based on UIEvent in the spec:
https://w3c.github.io/uievents/#idl-inputevent

inputEvent.initEvent( 'input', true /* bubbles */, false /* cancelable */ );
}
range.commonAncestorContainer.closest( '[contenteditable=true]' ).dispatchEvent( inputEvent );
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be strict, the polyfill for Element#closest should be imported at the top of this module:

gutenberg/editor/utils/dom.js

Line 4 in 5a57e6f

import 'element-closest';

}

select( option ) {
Expand All @@ -254,8 +265,6 @@ export class Autocomplete extends Component {
return;
}

this.reset();

if ( getOptionCompletion ) {
const completion = getOptionCompletion( option.value, range, query );

Expand All @@ -278,10 +287,20 @@ export class Autocomplete extends Component {
}
}
}

// Reset autocomplete state after insertion rather than before
// so insertion events don't cause the completion menu to redisplay.
this.reset();
}

reset() {
this.setState( this.constructor.getInitialState() );
const isMounted = !! this.node;

// Autocompletions may replace the block containing this component,
// so we make sure it is mounted before resetting the state.
if ( isMounted ) {
this.setState( this.constructor.getInitialState() );
}
}

resetWhenSuppressed() {
Expand Down