Skip to content

fix(ui5-multi-input): fix arrow left key behavior #13468

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

Open
nikoletavnv wants to merge 1 commit into
base: main
Choose a base branch
from
+189 −11
Open

fix(ui5-multi-input): fix arrow left key behavior #13468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
139 changes: 139 additions & 0 deletions packages/main/cypress/specs/MultiInput.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1502,6 +1502,145 @@ describe("Keyboard handling", () => {
cy.get("@changeSpy")
.should("have.been.calledOnce");
});

it("should focus last token on ArrowLeft at start of input, keep suggestions open, and not fire change event", () => {
cy.mount(
<MultiInput showSuggestions>
<Token slot="tokens" text="Amet"></Token>
<SuggestionItem text="Bulgaria"></SuggestionItem>
<SuggestionItem text="Brazil"></SuggestionItem>
</MultiInput>
);

const changeSpy = cy.stub().as("changeSpy");

cy.get("[ui5-multi-input]")
.then(multiInput => {
multiInput[0].addEventListener("ui5-change", changeSpy);
});

cy.get("[ui5-multi-input]")
.shadow()
.find("input")
.as("input");

cy.get("@input")
.realClick();

cy.realType("a");

cy.get("[ui5-multi-input]")
.shadow()
.find<ResponsivePopover>("[ui5-responsive-popover]")
.ui5ResponsivePopoverOpened();

cy.realPress("ArrowLeft"); // cursor: pos 1 → pos 0
cy.realPress("ArrowLeft"); // cursor at pos 0 → focuses last token

cy.get("[ui5-token]")
.should("have.length", 1);

cy.get("[ui5-token]")
.should("be.focused");

cy.get("[ui5-multi-input]")
.shadow()
.find<ResponsivePopover>("[ui5-responsive-popover]")
.ui5ResponsivePopoverOpened();

cy.get("@changeSpy")
.should("not.have.been.called");
});

it("should fire change event when returning from tokenizer to input via ArrowRight and pressing Tab", () => {
cy.mount(
<MultiInput showSuggestions>
<Token slot="tokens" text="Amet"></Token>
<SuggestionItem text="Bulgaria"></SuggestionItem>
<SuggestionItem text="Brazil"></SuggestionItem>
</MultiInput>
);

const changeSpy = cy.stub().as("changeSpy");

cy.get("[ui5-multi-input]")
.then(multiInput => {
multiInput[0].addEventListener("ui5-change", changeSpy);
});

cy.get("[ui5-multi-input]")
.shadow()
.find("input")
.as("input");

cy.get("@input")
.realClick();

cy.realType("a");

// focus last token
cy.realPress("ArrowLeft");
cy.realPress("ArrowLeft");

cy.get("[ui5-token]")
.should("be.focused");

// return to input
cy.realPress("ArrowRight");

cy.get("[ui5-multi-input]")
.should("be.focused");

cy.realPress("Tab");

cy.get("@changeSpy")
.should("have.been.calledOnce");
});

it("should fire change event when returning from tokenizer to input via Tab and pressing Enter", () => {
cy.mount(
<MultiInput showSuggestions noTypeahead>
<Token slot="tokens" text="Amet"></Token>
<SuggestionItem text="Bulgaria"></SuggestionItem>
<SuggestionItem text="Brazil"></SuggestionItem>
</MultiInput>
);

const changeSpy = cy.stub().as("changeSpy");

cy.get("[ui5-multi-input]")
.then(multiInput => {
multiInput[0].addEventListener("ui5-change", changeSpy);
});

cy.get("[ui5-multi-input]")
.shadow()
.find("input")
.as("input");

cy.get("@input")
.realClick();

cy.realType("b");

// focus last token
cy.realPress("ArrowLeft");
cy.realPress("ArrowLeft");

cy.get("[ui5-token]")
.should("be.focused");

// return to input
cy.realPress("Tab");

cy.get("[ui5-multi-input]")
.should("be.focused");

cy.realPress("Enter");

cy.get("@changeSpy")
.should("have.been.calledOnce");
});
});

describe("MultiInput Composition", () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/main/src/Input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,8 +631,8 @@ class Input extends UI5Element implements SuggestionComponent, IFormInputElement
previousValue: string;
firstRendering: boolean;
typedInValue: string;
lastConfirmedValue: string
isTyping: boolean
lastConfirmedValue: string;
isTyping: boolean;
_handleResizeBound: ResizeObserverCallback;
_shouldAutocomplete?: boolean;
_enterKeyDown?: boolean;
Expand Down
57 changes: 48 additions & 9 deletions packages/main/src/MultiInput.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import {
isHome,
isEnd,
isDown,

isEnter,
isTabNext,
} from "@ui5/webcomponents-base/dist/Keys.js";
import { isPhone } from "@ui5/webcomponents-base/dist/Device.js";
import type { ITabbable } from "@ui5/webcomponents-base/dist/delegate/ItemNavigation.js";
Expand Down Expand Up @@ -153,6 +154,8 @@ class MultiInput extends Input implements IFormInputElement {

_skipOpenSuggestions: boolean;
_valueHelpIconPressed: boolean;
_focusInTokenizer: boolean;
_returningFromTokenizer: boolean;

get formValidityMessage() {
return MultiInput.i18nBundle.getText(FORM_MIXED_TEXTFIELD_REQUIRED);
Expand Down Expand Up @@ -188,6 +191,8 @@ class MultiInput extends Input implements IFormInputElement {
// Prevent suggestions' opening.
this._skipOpenSuggestions = false;
this._valueHelpIconPressed = false;
this._focusInTokenizer = false;
this._returningFromTokenizer = false;
}

valueHelpPress() {
Expand Down Expand Up @@ -225,6 +230,10 @@ class MultiInput extends Input implements IFormInputElement {
if (!this.contains(e.relatedTarget as HTMLElement) && !this.shadowRoot!.contains(e.relatedTarget as HTMLElement)) {
this.tokenizer._tokens.forEach(token => { token.selected = false; });
}
if (this.shadowRoot!.contains(e.relatedTarget as HTMLElement)) {
this._returningFromTokenizer = true;
}
this._focusInTokenizer = false;
}

valueHelpMouseUp() {
Expand All @@ -248,6 +257,7 @@ class MultiInput extends Input implements IFormInputElement {

_onkeydown(e: KeyboardEvent) {
!this._isComposing && super._onkeydown(e);
this._isKeyNavigation = true;

const target = e.target as HTMLInputElement;
const isHomeInBeginning = isHome(e) && target.selectionStart === 0;
Expand All @@ -269,9 +279,16 @@ class MultiInput extends Input implements IFormInputElement {

this._skipOpenSuggestions = false;

if ((isEnter(e) || isTabNext(e)) && this.previousValue !== this.value) {
this._handleChange();
return;
}

if (isShow(e)) {
this.valueHelpPress();
}

this._isKeyNavigation = false;
}

_onTokenizerKeydown(e: KeyboardEvent) {
Expand All @@ -281,6 +298,7 @@ class MultiInput extends Input implements IFormInputElement {
const lastTokenIndex = this.tokens.length - 1;

if (e.target === this.tokens[lastTokenIndex] && this.tokens[lastTokenIndex] === document.activeElement) {
this._returningFromTokenizer = true;
setTimeout(() => {
this.focus();
}, 0);
Expand All @@ -296,9 +314,25 @@ class MultiInput extends Input implements IFormInputElement {
// selectionStart property applies only to inputs of types text, search, URL, tel, and password
if (((cursorPosition === null && !this.value) || cursorPosition === 0) && lastToken) {
e.preventDefault();
lastToken.focus();
this.tokenizer._itemNav.setCurrentItem(lastToken);
this._focusToken(lastToken);
}
}

_focusToken(tokenToFocus: IToken) {
this._focusInTokenizer = true;
tokenToFocus.focus();
this.tokenizer._itemNav.setCurrentItem(tokenToFocus);
}

/**
* @override
*/
_handleChange() {
if (this._focusInTokenizer) {
return;
}

super._handleChange();
}

_handleBackspace(e: KeyboardEvent) {
Expand All @@ -308,8 +342,7 @@ class MultiInput extends Input implements IFormInputElement {
// Only move focus to the last token if the input is empty
if (!this.value && lastToken) {
e.preventDefault();
lastToken.focus();
this.tokenizer._itemNav.setCurrentItem(lastToken);
this._focusToken(lastToken);
}
}

Expand All @@ -319,9 +352,7 @@ class MultiInput extends Input implements IFormInputElement {

if (firstToken) {
e.preventDefault();

firstToken.focus();
this.tokenizer._itemNav.setCurrentItem(firstToken);
this._focusToken(firstToken);
}
}

Expand All @@ -347,7 +378,15 @@ class MultiInput extends Input implements IFormInputElement {
const inputDomRef = this.getInputDOMRef();

if (e.target === inputDomRef) {
super._onfocusin(e);
if (this._returningFromTokenizer) {
this._returningFromTokenizer = false;
this.focused = true;
this.open = true;
this._inputIconFocused = false;
this._focusedAfterClear = false;
} else {
super._onfocusin(e);
}
}
}

Expand Down
Loading