Skip to content

fix(ui5-multi-combobox): handle composition with validation #12501

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(ui5-multi-combobox): handle composition with validation #12501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23a708f
fix(ui5-multi-combobox): handle composition with validation
aleksandar-terziev Oct 17, 2025
22a20fa
Merge branch 'main' into multi-combo-ime-validation
aleksandar-terziev Oct 22, 2025
29e2d56
Merge branch 'main' into multi-combo-ime-validation
ilhan007 Oct 23, 2025
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
243 changes: 102 additions & 141 deletions packages/main/cypress/specs/MultiComboBox.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4153,180 +4153,141 @@ describe("Keyboard Handling", () => {
});

describe("MultiComboBox Composition", () => {
it("should handle Korean composition correctly", () => {
const mountMultiComboBox = (children: any, id: string, placeholder: string = "") => {
cy.mount(
<MultiComboBox
id="multicombobox-composition-korean"
placeholder="Type in Korean ..."
>
<MultiComboBoxItem text="안녕하세요" />
<MultiComboBoxItem text="고맙습니다" />
<MultiComboBoxItem text="사랑" />
<MultiComboBoxItem text="한국" />
<MultiComboBox id={id} placeholder={placeholder}>
{children}
</MultiComboBox>
);

cy.get("[ui5-multi-combobox]")
.as("multicombobox")
.realClick();

cy.get("@multicombobox")
.shadow()
.find("input")
.as("nativeInput")
.focus();

cy.get("@nativeInput").trigger("compositionstart", { data: "" });

cy.get("@multicombobox").should("have.prop", "_isComposing", true);

cy.get("@nativeInput").trigger("compositionupdate", { data: "사랑" });

cy.get("@multicombobox").should("have.prop", "_isComposing", true);

cy.get("@nativeInput").trigger("compositionend", { data: "사랑" });

cy.get("@nativeInput")
.invoke("val", "사랑")
cy.get("[ui5-multi-combobox]").as("mcb").realClick();
cy.get("@mcb").shadow().find("input").as("input").focus();
};

const simulateCompositionStages = (stages: string[], final: string) => {
cy.get("@input").trigger("compositionstart", { data: "" });
stages.forEach(stage => {
cy.get("@input")
.invoke("val", stage)
.trigger("input", { inputType: "insertCompositionText" })
.trigger("compositionupdate", { data: stage });

cy.get("@mcb").should("have.prop", "_isComposing", true);
cy.get("@input").should("have.value", stage);
cy.get("@mcb").should("have.attr", "value", stage);
cy.get("@mcb").should("have.attr", "value-state", "None");
});
cy.get("@input")
.trigger("compositionend", { data: final })
.invoke("val", final)
.trigger("input", { inputType: "insertCompositionText" });
cy.get("@mcb").should("have.prop", "_isComposing", false);
};

cy.get("@multicombobox").should("have.prop", "_isComposing", false);
it("IME Korean matching suggestion", () => {
mountMultiComboBox([
<MultiComboBoxItem key="1" text="사랑" />,
<MultiComboBoxItem key="2" text="사랑해요" />,
<MultiComboBoxItem key="3" text="한국" />,
], "mcb-korean", "Type in Korean ...");

cy.get("@multicombobox").should("have.attr", "value", "사랑");
simulateCompositionStages(["ㅅ", "사", "사랑"], "사랑");

cy.get("@multicombobox")
cy.get("@mcb")
.shadow()
.find<ResponsivePopover>("[ui5-responsive-popover]")
.as("popover")
.find<ResponsivePopover>("ui5-responsive-popover")
.ui5ResponsivePopoverOpened();

cy.get("@multicombobox")
.realPress("Enter");

cy.get("@multicombobox")
cy.get("@mcb").realPress("Enter");
cy.get("@mcb")
.shadow()
.find("[ui5-tokenizer]")
.find("[ui5-token]")
.find("[ui5-tokenizer] [ui5-token]")
.should("have.length", 1);

cy.get("@multicombobox").should("have.attr", "value", "");
cy.get("@mcb").should("have.attr", "value", "");
});

it("should handle Japanese composition correctly", () => {
cy.mount(
<MultiComboBox
id="multicombobox-composition-japanese"
placeholder="Type in Japanese ..."
>
<MultiComboBoxItem text="こんにちは" />
<MultiComboBoxItem text="ありがとう" />
<MultiComboBoxItem text="東京" />
<MultiComboBoxItem text="日本" />
</MultiComboBox>
);
it("IME Korean non-matching – error state after commit", () => {
mountMultiComboBox([
<MultiComboBoxItem key="1" text="사랑" />,
<MultiComboBoxItem key="2" text="한국" />,
], "mcb-ko-non", "Type in Korean ...");

cy.get("[ui5-multi-combobox]")
.as("multicombobox")
.realClick();
simulateCompositionStages(["ㄲ", "ㄲㅏ"], "까");

cy.get("@multicombobox")
cy.get("@mcb").should("have.attr", "value-state", "Negative");
cy.get("@input").should("have.value", "");
cy.get("@mcb")
.shadow()
.find("input")
.as("nativeInput")
.focus();

cy.get("@nativeInput").trigger("compositionstart", { data: "" });

cy.get("@multicombobox").should("have.prop", "_isComposing", true);

cy.get("@nativeInput").trigger("compositionupdate", { data: "ありがとう" });

cy.get("@multicombobox").should("have.prop", "_isComposing", true);

cy.get("@nativeInput").trigger("compositionend", { data: "ありがとう" });

cy.get("@nativeInput")
.invoke("val", "ありがとう")
.trigger("input", { inputType: "insertCompositionText" });

cy.get("@multicombobox").should("have.prop", "_isComposing", false);
.find("[ui5-tokenizer] [ui5-token]")
.should("have.length", 0);
});

cy.get("@multicombobox").should("have.attr", "value", "ありがとう");
it("IME Japanese matching – multi-stage selection", () => {
mountMultiComboBox([
<MultiComboBoxItem key="1" text="ありがとう" />,
<MultiComboBoxItem key="2" text="こんにちは" />,
<MultiComboBoxItem key="3" text="東京" />,
], "mcb-ja", "Type in Japanese ...");

cy.get("@multicombobox")
simulateCompositionStages(["あ", "あり", "ありが", "ありがとう"], "ありがとう");
cy.get("@mcb")
.shadow()
.find<ResponsivePopover>("[ui5-responsive-popover]")
.as("popover")
.find<ResponsivePopover>("ui5-responsive-popover")
.ui5ResponsivePopoverOpened();

cy.get("@multicombobox")
.realPress("Enter");

cy.get("@multicombobox")
cy.get("@mcb").realPress("Enter");
cy.get("@mcb")
.shadow()
.find("[ui5-tokenizer]")
.find("[ui5-token]")
.find("[ui5-tokenizer] [ui5-token]")
.should("have.length", 1);

cy.get("@multicombobox").should("have.attr", "value", "");
});

it("should handle Chinese composition correctly", () => {
cy.mount(
<MultiComboBox
id="multicombobox-composition-chinese"
placeholder="Type in Chinese ..."
>
<MultiComboBoxItem text="你好" />
<MultiComboBoxItem text="谢谢" />
<MultiComboBoxItem text="北京" />
<MultiComboBoxItem text="中国" />
</MultiComboBox>
);
it("IME Japanese non-matching – error state after commit", () => {
mountMultiComboBox([
<MultiComboBoxItem key="1" text="ありがとう" />,
<MultiComboBoxItem key="2" text="こんにちは" />,
], "mcb-ja-non", "Type in Japanese ...");

cy.get("[ui5-multi-combobox]")
.as("multicombobox")
.realClick();

cy.get("@multicombobox")
simulateCompositionStages(["ず", "ずx"], "ずx");
cy.get("@mcb").should("have.attr", "value-state", "Negative");
cy.get("@input").should("have.value", "");
cy.get("@mcb")
.shadow()
.find("input")
.as("nativeInput")
.focus();

cy.get("@nativeInput").trigger("compositionstart", { data: "" });

cy.get("@multicombobox").should("have.prop", "_isComposing", true);

cy.get("@nativeInput").trigger("compositionupdate", { data: "谢谢" });

cy.get("@multicombobox").should("have.prop", "_isComposing", true);

cy.get("@nativeInput").trigger("compositionend", { data: "谢谢" });

cy.get("@nativeInput")
.invoke("val", "谢谢")
.trigger("input", { inputType: "insertCompositionText" });

cy.get("@multicombobox").should("have.prop", "_isComposing", false);
.find("[ui5-tokenizer] [ui5-token]")
.should("have.length", 0);
});

cy.get("@multicombobox").should("have.attr", "value", "谢谢");
it("IME Chinese matching – preserves pinyin stages & selects", () => {
mountMultiComboBox([
<MultiComboBoxItem key="1" text="你好" />,
<MultiComboBoxItem key="2" text="谢谢" />,
<MultiComboBoxItem key="3" text="谢谢你" />,
<MultiComboBoxItem key="4" text="北京" />,
], "mcb-zh", "Type in Chinese ...");

cy.get("@multicombobox")
simulateCompositionStages(["x", "xi", "xie", "xiex", "xiexie"], "谢谢");
cy.get("@mcb")
.shadow()
.find<ResponsivePopover>("[ui5-responsive-popover]")
.as("popover")
.find<ResponsivePopover>("ui5-responsive-popover")
.ui5ResponsivePopoverOpened();

cy.get("@multicombobox")
.realPress("Enter");

cy.get("@multicombobox")
cy.get("@mcb").realPress("Enter");
cy.get("@mcb")
.shadow()
.find("[ui5-tokenizer]")
.find("[ui5-token]")
.find("[ui5-tokenizer] [ui5-token]")
.should("have.length", 1);
cy.get("@mcb").should("have.attr", "value", "");
});

it("IME Chinese non-matching – error state after commit", () => {
mountMultiComboBox([
<MultiComboBoxItem key="1" text="你好" />,
<MultiComboBoxItem key="2" text="谢谢" />,
], "mcb-zh-non", "Type in Chinese ...");

cy.get("@multicombobox").should("have.attr", "value", "");
simulateCompositionStages(["p", "pi", "pin"], "品味");
cy.get("@mcb").should("have.attr", "value-state", "Negative");
cy.get("@input").should("have.value", "");
cy.get("@mcb")
.shadow()
.find("[ui5-tokenizer] [ui5-token]")
.should("have.length", 0);
});
});
13 changes: 7 additions & 6 deletions packages/main/src/MultiComboBox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,7 @@ class MultiComboBox extends UI5Element implements IFormInputElement {

this._effectiveValueState = this.valueState;

if (!filteredItems.length && value && !this.noValidation) {
if (!this._isComposing && !filteredItems.length && value && !this.noValidation) {
const newValue = this.valueBeforeAutoComplete || this._inputLastValue;

input.value = newValue;
Expand All @@ -742,7 +742,10 @@ class MultiComboBox extends UI5Element implements IFormInputElement {
return;
}

this._inputLastValue = input.value;
if (!this._isComposing) {
this._inputLastValue = input.value;
}

this.value = input.value;
this._filteredItems = filteredItems;

Expand Down Expand Up @@ -1749,8 +1752,6 @@ class MultiComboBox extends UI5Element implements IFormInputElement {

this._effectiveShowClearIcon = (this.showClearIcon && !!this.value && !this.readonly && !this.disabled);

this._inputLastValue = value;

if (input && !input.value) {
this.valueBeforeAutoComplete = "";
this._filteredItems = this._getItems();
Expand All @@ -1773,10 +1774,10 @@ class MultiComboBox extends UI5Element implements IFormInputElement {
if (this._shouldAutocomplete && !isAndroid()) {
const item = this._getFirstMatchingItem(value);

// Keep the original typed in text intact
this.valueBeforeAutoComplete = value;
// Prevent typeahead during composition to avoid interfering with the composition process
if (!this._isComposing && item) {
// Keep the original typed in text intact
this.valueBeforeAutoComplete = value;
this._handleTypeAhead(item, value);
}
}
Expand Down
24 changes: 24 additions & 0 deletions packages/main/test/pages/MultiComboBox.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,18 @@ <h3>MultiComboBox Composition</h3>
</ui5-multi-combobox>
</div>

<div class="demo-section">
<span>MultiComboBox Composition Korean with Validation</span>

<br>
<ui5-multi-combobox placeholder="Type in Korean ..." id="mcb-composition-korean">
<ui5-mcb-item text="안녕하세요"></ui5-mcb-item>
<ui5-mcb-item text="고맙습니다"></ui5-mcb-item>
<ui5-mcb-item text="사랑"></ui5-mcb-item>
<ui5-mcb-item text="한국"></ui5-mcb-item>
</ui5-multi-combobox>
</div>

<div class="demo-section">
<span>MultiComboBox Composition Japanese</span>

Expand All @@ -349,6 +361,18 @@ <h3>MultiComboBox Composition</h3>
</ui5-multi-combobox>
</div>

<div class="demo-section">
<span>MultiComboBox Composition Chinese with Validation</span>

<br>
<ui5-multi-combobox placeholder="Type in Chinese ..." id="mcb-composition-chinese">
<ui5-mcb-item text="你好"></ui5-mcb-item>
<ui5-mcb-item text="謝謝"></ui5-mcb-item>
<ui5-mcb-item text="北京"></ui5-mcb-item>
<ui5-mcb-item text="上海"></ui5-mcb-item>
</ui5-multi-combobox>
</div>

</section>

<div class="demo-section">
Expand Down
Loading