Skip to content

Support iframes (nested browsing contexts) in selection event handling #9184

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

Closed
acusti wants to merge 24 commits into from
Closed

Support iframes (nested browsing contexts) in selection event handling #9184

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e1d4110
Use event target doc as getActiveElement context
acusti Oct 24, 2017
ed0cc8a
Use node’s window and document when possible
acusti Oct 30, 2017
8f11b2c
Make getting/setting selection check iframe contents
acusti Oct 4, 2016
83cfb55
Add tests for ReactInputSelection
acusti Nov 1, 2017
374d525
Adapt restoreSelection to work for all activeElements
acusti Oct 10, 2016
f6f9e35
Tests for getting / restoring selections across iframes
acusti Oct 11, 2016
6ac703f
Add guards for Firefox and Safari compatibility
acusti Mar 15, 2017
cec8c3f
Prettier
acusti Nov 1, 2017
0163795
Update test file header
acusti Nov 1, 2017
d777546
Avoid causing focus/blur issues from restoreSelection
acusti Nov 1, 2017
7c59a77
Add early return for restoring selection common case
acusti Nov 1, 2017
131357e
Merge remote-tracking branch 'upstream/master' into iframes
acusti Nov 3, 2017
2d4ac46
Prefer active element as element with selection
acusti Nov 16, 2017
5755556
Merge branch 'master' into iframes
acusti Nov 16, 2017
b3998eb
Prettier
acusti Nov 16, 2017
174375c
Prevent restoreSelection overwriting active element
acusti Nov 17, 2017
39a9589
Code review-based cleanup and improvements
acusti Nov 17, 2017
82443f7
Detect all valid selection-capable input types
acusti Nov 19, 2017
b25279d
Merge branch 'master' into iframes
acusti Nov 19, 2017
026e8f0
Merge branch 'master' into iframes
acusti Nov 28, 2017
689d7c1
Merge branch 'master' into iframes
acusti Dec 30, 2017
074ff51
Guard against null (based on failing test)
acusti Dec 30, 2017
0744710
Linting (var :arrow_right: const)
acusti Dec 31, 2017
c71601b
Merge branch 'master' into iframes
acusti Jan 7, 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
Prev Previous commit
Next Next commit
Linting (var ➡️ const)
  • Loading branch information
@acusti
acusti committed Dec 31, 2017
commit 07447109230c452c6e87a656e6d94fcbbfe28ce1
66 changes: 33 additions & 33 deletions packages/react-dom/src/__tests__/ReactInputSelection-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@

'use strict';

var React = require('react');
var ReactDOM = require('react-dom');
var ReactTestUtils = require('react-dom/test-utils');
var ReactInputSelection = require('../client/ReactInputSelection');
const React = require('react');
const ReactDOM = require('react-dom');
const ReactTestUtils = require('react-dom/test-utils');
const ReactInputSelection = require('../client/ReactInputSelection');

describe('ReactInputSelection', () => {
var textValue = 'the text contents';
var createAndMountElement = (type, props, children) => {
var element = React.createElement(type, props, children);
var instance = ReactTestUtils.renderIntoDocument(element);
const textValue = 'the text contents';
const createAndMountElement = (type, props, children) => {
const element = React.createElement(type, props, children);
const instance = ReactTestUtils.renderIntoDocument(element);
return ReactDOM.findDOMNode(instance);
};
var makeGetSelection = (win = window) => () => ({
const makeGetSelection = (win = window) => () => ({
anchorNode: win.document.activeElement,
focusNode: win.document.activeElement,
anchorOffset:
Expand All @@ -32,7 +32,7 @@ describe('ReactInputSelection', () => {

describe('hasSelectionCapabilities', () => {
it('returns true for textareas', () => {
var textarea = document.createElement('textarea');
const textarea = document.createElement('textarea');
expect(ReactInputSelection.hasSelectionCapabilities(textarea)).toBe(true);
});

Expand All @@ -56,7 +56,7 @@ describe('ReactInputSelection', () => {
expect(ReactInputSelection.hasSelectionCapabilities(input)).toBe(true);
});

var inputReadOnly = document.createElement('input');
const inputReadOnly = document.createElement('input');
inputReadOnly.readOnly = 'true';
expect(ReactInputSelection.hasSelectionCapabilities(inputReadOnly)).toBe(
true,
Expand All @@ -83,13 +83,13 @@ describe('ReactInputSelection', () => {
});
Copy link
Contributor

@nhunzaker nhunzaker Nov 16, 2017

Choose a reason for hiding this comment

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

These feel like they could be separate tests.

Also: Why do email, password, and number return false? Is this because they don't support the text selection api?

Copy link
Contributor Author

@acusti acusti Nov 17, 2017

Choose a reason for hiding this comment

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

That’s a great question! That’s what the existing function enforces, so I figured I’d capture that behavior in the tests:

  return (
    nodeName &&
    ((nodeName === 'input' && elem.type === 'text') ||
      nodeName === 'textarea' ||
      elem.contentEditable === 'true')
  );

But I’m not sure it’s desired, because those input types can definitely have selections. The hasSelectionCapabilities check could be changed to something like:

  return (
    nodeName &&
    ((nodeName === 'input' && ['text', 'email', 'number', 'password'].includes(elem.type)) ||
      nodeName === 'textarea' ||
      elem.contentEditable === 'true')
  );


it('returns true for contentEditable elements', () => {
var div = document.createElement('div');
const div = document.createElement('div');
div.contentEditable = 'true';
var body = document.createElement('body');
const body = document.createElement('body');
body.contentEditable = 'true';
var input = document.createElement('input');
const input = document.createElement('input');
input.contentEditable = 'true';
Copy link
Contributor

@nhunzaker nhunzaker Nov 16, 2017

Choose a reason for hiding this comment

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

Huh. I didn't know you could do this.

Copy link
Contributor

@nhunzaker nhunzaker Nov 16, 2017

Choose a reason for hiding this comment

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

screen shot 2017-11-16 at 4 39 22 pm

How fun.

var select = document.createElement('select');
const select = document.createElement('select');
select.contentEditable = 'true';

expect(ReactInputSelection.hasSelectionCapabilities(div)).toBe(true);
Expand All @@ -99,8 +99,8 @@ describe('ReactInputSelection', () => {
});

it('returns false for any other type of HTMLElement', () => {
var select = document.createElement('select');
var iframe = document.createElement('iframe');
const select = document.createElement('select');
const iframe = document.createElement('iframe');

expect(ReactInputSelection.hasSelectionCapabilities(select)).toBe(false);
expect(ReactInputSelection.hasSelectionCapabilities(iframe)).toBe(false);
Expand All @@ -109,14 +109,14 @@ describe('ReactInputSelection', () => {

describe('getSelection', () => {
it('gets selection offsets from a textarea or input', () => {
var input = createAndMountElement('input', {defaultValue: textValue});
const input = createAndMountElement('input', {defaultValue: textValue});
input.setSelectionRange(6, 11);
expect(ReactInputSelection.getSelection(input)).toEqual({
start: 6,
end: 11,
});

var textarea = createAndMountElement('textarea', {
const textarea = createAndMountElement('textarea', {
defaultValue: textValue,
});
textarea.setSelectionRange(6, 11);
Expand All @@ -127,7 +127,7 @@ describe('ReactInputSelection', () => {
});

it('gets selection offsets from a contentEditable element', () => {
var node = createAndMountElement('div', null, textValue);
const node = createAndMountElement('div', null, textValue);
node.selectionStart = 6;
node.selectionEnd = 11;
expect(ReactInputSelection.getSelection(node)).toEqual({
Expand All @@ -137,7 +137,7 @@ describe('ReactInputSelection', () => {
});

it('gets selection offsets as start: 0, end: 0 if no selection', () => {
var node = createAndMountElement('select');
const node = createAndMountElement('select');
expect(ReactInputSelection.getSelection(node)).toEqual({
start: 0,
end: 0,
Expand All @@ -160,12 +160,12 @@ describe('ReactInputSelection', () => {

describe('setSelection', () => {
it('sets selection offsets on textareas and inputs', () => {
var input = createAndMountElement('input', {defaultValue: textValue});
const input = createAndMountElement('input', {defaultValue: textValue});
ReactInputSelection.setSelection(input, {start: 1, end: 10});
expect(input.selectionStart).toEqual(1);
expect(input.selectionEnd).toEqual(10);

var textarea = createAndMountElement('textarea', {
const textarea = createAndMountElement('textarea', {
defaultValue: textValue,
});
ReactInputSelection.setSelection(textarea, {start: 1, end: 10});
Expand All @@ -190,15 +190,15 @@ describe('ReactInputSelection', () => {
describe('getSelectionInformation/restoreSelection', () => {
it('gets and restores selection for inputs that get remounted', () => {
// Mock window getSelection if needed
var originalGetSelection = window.getSelection;
const originalGetSelection = window.getSelection;
window.getSelection = window.getSelection || makeGetSelection(window);
var input = document.createElement('input');
const input = document.createElement('input');
input.value = textValue;
document.body.appendChild(input);
input.focus();
input.selectionStart = 1;
input.selectionEnd = 10;
var selectionInfo = ReactInputSelection.getSelectionInformation();
const selectionInfo = ReactInputSelection.getSelectionInformation();
expect(selectionInfo.activeElement).toBe(input);
expect(selectionInfo.elementSelections[0].element).toBe(input);
expect(selectionInfo.elementSelections[0].selectionRange).toEqual({
Expand All @@ -222,24 +222,24 @@ describe('ReactInputSelection', () => {
});

it('gets and restores selection for inputs in an iframe that get remounted', () => {
var iframe = document.createElement('iframe');
const iframe = document.createElement('iframe');
document.body.appendChild(iframe);
var iframeDoc = iframe.contentDocument;
var iframeWin = iframeDoc.defaultView;
const iframeDoc = iframe.contentDocument;
const iframeWin = iframeDoc.defaultView;
// Mock window and iframe getSelection if needed
var originalGetSelection = window.getSelection;
var originalIframeGetSelection = iframeWin.getSelection;
const originalGetSelection = window.getSelection;
const originalIframeGetSelection = iframeWin.getSelection;
window.getSelection = window.getSelection || makeGetSelection(window);
iframeWin.getSelection =
iframeWin.getSelection || makeGetSelection(iframeWin);

var input = document.createElement('input');
const input = document.createElement('input');
input.value = textValue;
iframeDoc.body.appendChild(input);
input.focus();
input.selectionStart = 1;
input.selectionEnd = 10;
var selectionInfo = ReactInputSelection.getSelectionInformation();
const selectionInfo = ReactInputSelection.getSelectionInformation();
expect(selectionInfo.activeElement === input).toBe(true);
expect(selectionInfo.elementSelections[0].selectionRange).toEqual({
start: 1,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-dom/src/client/ReactDOMSelection.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ export function getModernOffsetsFromPoints(
* @param {object} offsets
*/
export function setOffsets(node, offsets) {
var doc = node.ownerDocument || document;
const doc = node.ownerDocument || document;

if (!doc.defaultView.getSelection) {
return;
Expand Down
2 changes: 1 addition & 1 deletion packages/react-dom/src/events/SelectEventPlugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ function constructSelectEvent(nativeEvent, nativeEventTarget) {
// selection (this matches native `select` event behavior). In HTML5, select
// fires only on input and textarea thus if there's no focused element we
// won't dispatch.
var doc = getEventTargetDocument(nativeEventTarget);
const doc = getEventTargetDocument(nativeEventTarget);

if (
mouseDown ||
Expand Down