Skip to content

fix(combo): Prevent constant rerender for certain props under React #1660

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

Merged
damyanpetev merged 4 commits into from
Apr 23, 2025
Merged

fix(combo): Prevent constant rerender for certain props under React #1660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18f0717
fix(combo): Prevent constant rerender for certain props under React
rkaraivanov Apr 22, 2025
28db6f7
Merge branch 'master' into rkaraivanov/fix-combo-react-props
rkaraivanov Apr 22, 2025
e1fb1ea
Merge remote-tracking branch 'origin/master' into rkaraivanov/fix-com…
rkaraivanov Apr 23, 2025
f025889
chore: Duplicate utility function
rkaraivanov Apr 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
40 changes: 27 additions & 13 deletions src/components/combo/combo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import {
} from '../common/mixins/forms/form-value.js';
import {
asArray,
equal,
findElementFromEventPath,
first,
isEmpty,
Expand Down Expand Up @@ -163,10 +164,10 @@ export default class IgcComboComponent<
protected _navigation = new NavigationController<T>(this, this._state);

@queryAssignedElements({ slot: 'suffix' })
protected inputSuffix!: Array<HTMLElement>;
protected inputSuffix!: HTMLElement[];

@queryAssignedElements({ slot: 'prefix' })
protected inputPrefix!: Array<HTMLElement>;
protected inputPrefix!: HTMLElement[];

@query('[part="search-input"]')
protected _searchInput!: IgcInputComponent;
Expand Down Expand Up @@ -209,7 +210,11 @@ export default class IgcComboComponent<
*/
@property({ type: Boolean, reflect: true, attribute: 'single-select' })
public set singleSelect(value: boolean) {
this._singleSelect = value;
if (this._singleSelect === Boolean(value)) {
return;
}

this._singleSelect = Boolean(value);
this._selection.clear();
if (this.hasUpdated) {
this.updateValue();
Expand Down Expand Up @@ -300,8 +305,10 @@ export default class IgcComboComponent<
*/
@property({ attribute: 'group-key' })
public set groupKey(value: Keys<T> | undefined) {
this._groupKey = value;
this._state.runPipeline();
if (this._groupKey !== value) {
this._groupKey = value;
this._state.runPipeline();
}
}

public get groupKey() {
Expand All @@ -316,8 +323,10 @@ export default class IgcComboComponent<
*/
@property({ attribute: 'group-sorting' })
public set groupSorting(value: GroupingDirection) {
this._groupSorting = value;
this._state.runPipeline();
if (this._groupSorting !== value) {
this._groupSorting = value;
this._state.runPipeline();
}
}

public get groupSorting() {
Expand All @@ -334,8 +343,11 @@ export default class IgcComboComponent<
*/
@property({ type: Object, attribute: 'filtering-options' })
public set filteringOptions(value: Partial<FilteringOptions<T>>) {
this._filteringOptions = { ...this._filteringOptions, ...value };
this._state.runPipeline();
const options = { ...this._filteringOptions, ...value };
if (!equal(options, this._filteringOptions)) {
this._filteringOptions = options;
this._state.runPipeline();
}
}

public get filteringOptions(): FilteringOptions<T> {
Expand Down Expand Up @@ -443,7 +455,9 @@ export default class IgcComboComponent<

private _rootClickController = addRootClickHandler(this, {
hideCallback: async () => {
if (!this.handleClosing()) return;
if (!this.handleClosing()) {
return;
}
this.open = false;

await this.updateComplete;
Expand Down Expand Up @@ -668,7 +682,7 @@ export default class IgcComboComponent<

/** Shows the list of options. */
public async show(): Promise<boolean> {
return this._show(false);
return await this._show(false);
}

protected async _hide(emitEvent = true) {
Expand All @@ -688,7 +702,7 @@ export default class IgcComboComponent<

/** Hides the list of options. */
public async hide(): Promise<boolean> {
return this._hide(false);
return await this._hide(false);
}

protected _toggle(emit = true) {
Expand All @@ -697,7 +711,7 @@ export default class IgcComboComponent<

/** Toggles the list of options. */
public async toggle(): Promise<boolean> {
return this._toggle(false);
return await this._toggle(false);
}

private _getActiveDescendantId(index: number) {
Expand Down
Loading