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.

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

[EuiTextArea] Fix consumer onChanges not firing on isClearable button click #7473

Merged
merged 4 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions changelogs/upcoming/7473.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**Bug fixes**

- Fixed `EuiTextArea` to correctly fire `onChange` callbacks on clear button click
41 changes: 32 additions & 9 deletions src/components/form/text_area/text_area.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,46 @@ describe('EuiTextArea', () => {
});

it('works for controlled components', () => {
const onChange = cy.stub();
const ControlledTextArea = ({}) => {
const [value, setValue] = useState('');
return (
<EuiTextArea
value={value}
onChange={(e) => setValue(e.target.value)}
isClearable
/>
);
onChange.callsFake((e) => {
setValue(e.target.value);
});
return <EuiTextArea value={value} onChange={onChange} isClearable />;
};
cy.realMount(<ControlledTextArea />);

cy.get('textarea').type('hello world');
cy.get('textarea').should('have.value', 'hello world');
cy.get('textarea')
.should('have.value', 'hello world')
.then(() => {
expect(onChange).to.have.callCount(11);
});

cy.get('[data-test-subj="clearTextAreaButton"]').click();
cy.get('textarea').should('have.value', '');
cy.get('textarea')
.should('have.value', '')
.then(() => {
expect(onChange).to.have.callCount(12);
});
});

it('manually fires an onInput event', () => {
const onInput = cy.stub();
cy.realMount(<EuiTextArea isClearable onInput={onInput} />);

cy.get('textarea')
.type('1')
.then(() => {
expect(onInput).to.have.callCount(1);
});

cy.get('[data-test-subj="clearTextAreaButton"]')
.click()
.then(() => {
expect(onInput).to.have.callCount(2);
});
});
});
});
13 changes: 11 additions & 2 deletions src/components/form/text_area/text_area.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,22 @@ export const EuiTextArea: FunctionComponent<EuiTextAreaProps> = (props) => {
return {
onClick: () => {
if (ref.current) {
ref.current.value = '';
// Updates the displayed value and fires `onChange` callbacks
// @see https://stackoverflow.com/questions/23892547/what-is-the-best-way-to-trigger-onchange-event-in-react-js
const nativeValueSetter = Object.getOwnPropertyDescriptor(
window.HTMLTextAreaElement.prototype,
'value'
)!.set!;
nativeValueSetter.call(ref.current, '');

const event = new Event('input', {
bubbles: true,
cancelable: false,
});
ref.current.dispatchEvent(event);
ref.current.focus(); // set focus back to the textarea

// Set focus back to the textarea
ref.current.focus();
}
},
'data-test-subj': 'clearTextAreaButton',
Expand Down
Loading