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

fix(ui5-input): remove the 'submit' event #2855

Merged
merged 4 commits into from
Mar 2, 2021
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
20 changes: 1 addition & 19 deletions packages/main/src/Input.js
Original file line number Diff line number Diff line change
Expand Up @@ -372,18 +372,6 @@ const metadata = {
*/
input: {},

/**
* Fired when user presses Enter key on the <code>ui5-input</code>.
* <br><br>
* <b>Note:</b> The event is fired independent of whether there was a change before or not.
* If change was performed, the event is fired after the change event.
* The event is also fired when an item of the select list is selected by pressing Enter.
*
* @event
* @public
*/
submit: {},

/**
* Fired when a suggestion item, that is displayed in the suggestion popup, is selected.
*
Expand Down Expand Up @@ -520,7 +508,6 @@ class Input extends UI5Element {
this.highlightValue = "";

// all sementic events
this.EVENT_SUBMIT = "submit";
this.EVENT_CHANGE = "change";
this.EVENT_INPUT = "input";
this.EVENT_SUGGESTION_ITEM_SELECT = "suggestion-item-select";
Expand Down Expand Up @@ -884,7 +871,6 @@ class Input extends UI5Element {
}

const inputValue = await this.getInputValue();
const isSubmit = action === this.ACTION_ENTER;
const isUserInput = action === this.ACTION_USER_INPUT;

const input = await this.getInputDOMRef();
Expand All @@ -909,13 +895,9 @@ class Input extends UI5Element {
return;
}

if (isSubmit) { // submit
this.fireEvent(this.EVENT_SUBMIT);
}

// In IE, pressing the ENTER does not fire change
const valueChanged = (this.previousValue !== undefined) && (this.previousValue !== this.value);
if (isIE() && isSubmit && valueChanged) {
if (isIE() && action === this.ACTION_ENTER && valueChanged) {
this.fireEvent(this.EVENT_CHANGE);
}
}
Expand Down
1 change: 0 additions & 1 deletion packages/main/src/StepInput.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@
._inputAccInfo ="{{accInfo}}"
._nativeInputAttributes="{{inputAttributes}}"
@ui5-change="{{_onInputChange}}"
@ui5-submit="{{_onInputChange}}"
@focusout="{{_onInputFocusOut}}"
@focusin="{{_onInputFocusIn}}"
>
Expand Down
6 changes: 6 additions & 0 deletions packages/main/src/StepInput.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
isPageUpShift,
isPageDownShift,
isEscape,
isEnter,
} from "@ui5/webcomponents-base/dist/Keys.js";
import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
Expand Down Expand Up @@ -566,6 +567,11 @@ class StepInput extends UI5Element {
return;
}

if (isEnter(event)) {
this._onInputChange();
return;
}

if (isUp(event)) {
// step up
this._modifyValue(this.step);
Expand Down
37 changes: 28 additions & 9 deletions packages/main/test/pages/Input.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
<h3> Input with suggestions: type 'a'</h3>
<ui5-label id="myLabel">Event [suggestionItemSelect] :: N/A</ui5-label><br/>
<ui5-label id="myLabelChange">Event [change] :: N/A</ui5-label><br/>
<ui5-label id="myLabelSubmit">Event [submit] :: N/A</ui5-label><br/>
<ui5-label id="myLabelLiveChange">Event [input] :: N/A</ui5-label><br/>

<div>
Expand Down Expand Up @@ -220,6 +219,11 @@ <h3> Input with multiple icons</h3>
<ui5-icon slot="icon" name="decline" style="padding-left: 8px; padding-right: 8px"></ui5-icon>
</ui5-input>

<h3> Input firing submit event and submit action on 'ENTER' in a form</h3>
<form id="submit-form">
<ui5-input id="submit-input" name="my-submit-input" placeholder="Type something and press 'ENTER' ..."></ui5-input>
</form>

<h3> Test scroll pos</h3>
<ui5-input id="scrollInput" show-suggestions>
<ui5-li>Cozy</ui5-li>
Expand Down Expand Up @@ -318,6 +322,29 @@ <h3>Short Input With Centered Text</h3>
</style>

<script>
document.getElementById("submit-input").addEventListener("keypress", function(event) {
if (event.key === 'Enter') {
var formToSubmit = document.getElementById("submit-form");
var submitEvent = new Event('submit');

/* The old way - supported by all browsers:
The submit method of the form won't trigger
a submit event by itself, dispatch it manually */

// formToSubmit.dispatchEvent(submitEvent);
// formToSubmit.submit();

// Fires submit event and submits
// No MS IE11 & Safari support yet
formToSubmit.requestSubmit()
}
});

document.getElementById("submit-form").addEventListener("submit", function(event) {
event.preventDefault();
alert("Submitted");
});

btnOpenDialog.addEventListener("click", function () {
dialog.open();
});
Expand All @@ -335,7 +362,6 @@ <h3>Short Input With Centered Text</h3>
var label = document.getElementById('myLabel');
var labelChange = document.getElementById('myLabelChange');
var labelLiveChange = document.getElementById('myLabelLiveChange');
var labelSubmit = document.getElementById('myLabelSubmit');

var suggestionSelectedCounterWithGrouping = 0;

Expand Down Expand Up @@ -390,10 +416,6 @@ <h3>Short Input With Centered Text</h3>
labelChange.innerHTML = "Event [change] :: " + event.target.value;
});

input.addEventListener("ui5-submit", function (event) {
labelSubmit.innerHTML = "Event [submit] :: " + event.target.value;
});

var changeCounter = 0;
var inputCounter = 0;
var suggestionSelectedCounter = 0;
Expand All @@ -416,9 +438,6 @@ <h3>Short Input With Centered Text</h3>

var inputChangeResultCounter = 0;

inputChange.addEventListener("ui5-submit", function (event) {
inputChange.value = "Changed via API";
});
inputChange.addEventListener("ui5-change", function (event) {
inputChangeResult.value = ++inputChangeResultCounter;
});
Expand Down