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

feat: add internal has-input-value-changed event (CP: 14) #618

Merged
merged 4 commits into from
Apr 24, 2023
Merged

feat: add internal has-input-value-changed event (CP: 14) #618

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70cb3e9
added has-input-value-changed event
mukherjeesudebi Apr 21, 2023
d01e027
removed nextFrame
mukherjeesudebi Apr 24, 2023
2706e48
Update test/.eslintrc.json
vursen Apr 24, 2023
3d52210
removed helpers import
mukherjeesudebi Apr 24, 2023
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
45 changes: 44 additions & 1 deletion src/vaadin-text-field-mixin.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,16 @@
notify: true
},

/**
* When true, the input element has a non-empty value entered by the user.
* @protected
*/
_hasInputValue: {
type: Boolean,
value: false,
observer: '_hasInputValueChanged',
},

/**
* This property is set to true when the control value is invalid.
* @type {boolean}
Expand Down Expand Up @@ -406,6 +416,28 @@
this._createMethodObserver('_constraintsChanged(required, minlength, maxlength, pattern)');
}

/**
* Sets the `_hasInputValue` property based on the `input` event.
*
* @param {InputEvent} event
* @protected
*/
_setHasInputValue(event) {
this._hasInputValue = event.target.value.length > 0;
}

/**
* An input event listener used to update `_hasInputValue` property.
* Do not override this method.
*
* @param {Event} event
* @private
*/
__onInput(event) {
this._setHasInputValue(event);
this._onInput(event);
}

/** @private */
_onInput(e) {
if (this.__preventInput) {
Expand Down Expand Up @@ -452,6 +484,17 @@
}
}

/**
* Observer to notify about the change of private property.
*
* @private
*/
_hasInputValueChanged(hasValue, oldHasValue) {
if (hasValue || oldHasValue) {
this.dispatchEvent(new CustomEvent('has-input-value-changed'));
}
}

/**
* @param {!Event} e
* @protected
Expand Down Expand Up @@ -666,7 +709,7 @@

this._createConstraintsObserver();

this._boundOnInput = this._onInput.bind(this);
this._boundOnInput = this.__onInput.bind(this);
this._boundOnChange = this._onChange.bind(this);
this._boundOnBlur = this._onBlur.bind(this);
this._boundOnFocus = this._onFocus.bind(this);
Expand Down
3 changes: 2 additions & 1 deletion test/.eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"animationFrameFlush": false,
"listenOnce": false,
"oneEvent": false,
"nextRender": false
"nextRender": false,
"nextFrame": false
vursen marked this conversation as resolved.
Show resolved Hide resolved
}
}
61 changes: 61 additions & 0 deletions test/email-field-events.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!doctype html>

<head>
<meta charset="UTF-8">
<title>vaadin-email-field events tests</title>

<script src="../../web-component-tester/browser.js"></script>
<script src="../../webcomponentsjs/webcomponents-lite.js"></script>
<link rel="import" href="../vaadin-email-field.html">
<link rel="import" href="helpers.html">
<link rel="import" href="../../test-fixture/test-fixture.html">
</head>

<body>
<test-fixture id="email-field">
<template>
<vaadin-email-field></vaadin-email-field>
</template>
</test-fixture>
<script>
vursen marked this conversation as resolved.
Show resolved Hide resolved
describe('events', () => {
let emailField, input;

describe('has-input-value-changed event', () => {
beforeEach(async() => {
emailField = fixture('email-field');
input = emailField.inputElement;
});

it('should fire the event on input value presence change', async() => {
const hasInputValueChangedSpy = sinon.spy();
emailField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = 'foo';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;

hasInputValueChangedSpy.reset();
input.value = '';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;
});

it('should not fire the event on input if input value presence has not changed', async() => {
const hasInputValueChangedSpy = sinon.spy();
emailField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = 'foo';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
hasInputValueChangedSpy.reset();

input.value = 'foobar';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.called).to.be.false;
});
});
});
</script>
</body>
6 changes: 6 additions & 0 deletions test/helpers.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,11 @@
Polymer.RenderStatus.afterNextRender(element, resolve);
});
};

window.nextFrame = (element) => {
return new Promise(resolve =>
requestAnimationFrame(resolve));
};

</script>
</body>
61 changes: 61 additions & 0 deletions test/integer-field-events.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!doctype html>

<head>
<meta charset="UTF-8">
<title>vaadin-integer-field events tests</title>

<script src="../../web-component-tester/browser.js"></script>
<script src="../../webcomponentsjs/webcomponents-lite.js"></script>
<link rel="import" href="../vaadin-integer-field.html">
<link rel="import" href="helpers.html">
<link rel="import" href="../../test-fixture/test-fixture.html">
</head>

<body>
<test-fixture id="integer-field">
<template>
<vaadin-integer-field></vaadin-integer-field>
</template>
</test-fixture>
<script>
describe('events', () => {
let integerField, input;

describe('has-input-value-changed event', () => {
beforeEach(async() => {
integerField = fixture('integer-field');
input = integerField.inputElement;
});

it('should fire the event on input value presence change', async() => {
const hasInputValueChangedSpy = sinon.spy();
integerField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = '5';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
vursen marked this conversation as resolved.
Show resolved Hide resolved
expect(hasInputValueChangedSpy.calledOnce).to.be.true;

hasInputValueChangedSpy.reset();
input.value = '';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;
});

it('should not fire the event on input if input value presence has not changed', async() => {
const hasInputValueChangedSpy = sinon.spy();
integerField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = '5';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
hasInputValueChangedSpy.reset();

input.value = '56';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.called).to.be.false;
});
});
});
</script>
</body>
61 changes: 61 additions & 0 deletions test/number-field-events.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!doctype html>

<head>
<meta charset="UTF-8">
<title>vaadin-number-field events tests</title>

<script src="../../web-component-tester/browser.js"></script>
<script src="../../webcomponentsjs/webcomponents-lite.js"></script>
<link rel="import" href="../vaadin-number-field.html">
<link rel="import" href="helpers.html">
<link rel="import" href="../../test-fixture/test-fixture.html">
</head>

<body>
<test-fixture id="number-field">
<template>
<vaadin-number-field></vaadin-number-field>
</template>
</test-fixture>
<script>
describe('events', () => {
let numberField, input;

describe('has-input-value-changed event', () => {
beforeEach(async() => {
numberField = fixture('number-field');
input = numberField.inputElement;
});

it('should fire the event on input value presence change', async() => {
const hasInputValueChangedSpy = sinon.spy();
numberField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = '5';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;

hasInputValueChangedSpy.reset();
input.value = '';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;
});

it('should not fire the event on input if input value presence has not changed', async() => {
const hasInputValueChangedSpy = sinon.spy();
numberField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = '5';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
hasInputValueChangedSpy.reset();

input.value = '56';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.called).to.be.false;
});
});
});
</script>
</body>
61 changes: 61 additions & 0 deletions test/password-field-events.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!doctype html>

<head>
<meta charset="UTF-8">
<title>vaadin-password-field events tests</title>

<script src="../../web-component-tester/browser.js"></script>
<script src="../../webcomponentsjs/webcomponents-lite.js"></script>
<link rel="import" href="../vaadin-password-field.html">
<link rel="import" href="helpers.html">
<link rel="import" href="../../test-fixture/test-fixture.html">
</head>

<body>
<test-fixture id="password-field">
<template>
<vaadin-password-field></vaadin-password-field>
</template>
</test-fixture>
<script>
describe('events', () => {
let passwordField, input;

describe('has-input-value-changed event', () => {
beforeEach(async() => {
passwordField = fixture('password-field');
input = passwordField.inputElement;
});

it('should fire the event on input value presence change', async() => {
const hasInputValueChangedSpy = sinon.spy();
passwordField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = 'foo';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;

hasInputValueChangedSpy.reset();
input.value = '';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.calledOnce).to.be.true;
});

it('should not fire the event on input if input value presence has not changed', async() => {
const hasInputValueChangedSpy = sinon.spy();
passwordField.addEventListener('has-input-value-changed', hasInputValueChangedSpy);
input.value = 'foo';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
hasInputValueChangedSpy.reset();

input.value = 'foobar';
input.dispatchEvent(new CustomEvent('input'));
await nextFrame();
expect(hasInputValueChangedSpy.called).to.be.false;
});
});
});
</script>
</body>
8 changes: 7 additions & 1 deletion test/test-suites.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,11 @@ window.VaadinTextFieldSuites = [
'number-field-validation.html',
'integer-field-validation.html',
'password-field-validation.html',
'email-field-validation.html'
'email-field-validation.html',
'text-field-events.html',
'text-area-events.html',
'password-field-events.html',
'integer-field-events.html',
'number-field-events.html',
'email-field-events.html'
];
Loading