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

Autocomplete: Add position prop #2846

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Autocomplete: Add position prop #2846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bb1645e
Update with position prop
ElishaSamPeterPrabhu Sep 11, 2024
17f51ad
Update test cases
ElishaSamPeterPrabhu Sep 11, 2024
8604b9d
Update animation for scrolling
ElishaSamPeterPrabhu Sep 12, 2024
91c383e
Update with position prop
ElishaSamPeterPrabhu Sep 11, 2024
fcb33fb
Update test cases
ElishaSamPeterPrabhu Sep 11, 2024
d6ba058
Update animation for scrolling
ElishaSamPeterPrabhu Sep 12, 2024
bb2dc2d
Merge branch '2801-autocomplete-add-position-property-to-control-comp…
ElishaSamPeterPrabhu Sep 13, 2024
ec9a0b4
Update autocomplete logic
ElishaSamPeterPrabhu Sep 16, 2024
62e6c89
Revert "Update autocomplete logic"
ElishaSamPeterPrabhu Sep 16, 2024
5b9d336
Set width
ElishaSamPeterPrabhu Sep 19, 2024
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
7 changes: 6 additions & 1 deletion stencil-workspace/src/components/modus-autocomplete/modus-autocomplete.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,12 @@
margin: 0;
padding: 0;
position: absolute;
width: 100%;
width: auto;

&[data-popper-reference-hidden] {
pointer-events: none;
visibility: hidden;
}

.icon-check {
display: inline-flex;
Expand Down
4 changes: 2 additions & 2 deletions stencil-workspace/src/components/modus-autocomplete/modus-autocomplete.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ describe('modus-autocomplete', () => {
<modus-text-input aria-autocomplete="list" aria-controls="${listId}" class="input" role="combobox" autocomplete="off" size="medium" type="search" value=""></modus-text-input>
</div>
<div class="error"></div>
<div class="options-container" style="max-height: 300px; z-index: 1; overflow-y: auto;">
<div class="options-container" part="options-container" style="max-height: 300px; z-index: 1; overflow-y: auto; position: absolute; left: 0; top: 0; margin: 0;">
<ul aria-label="options" id="${listId}" role="listbox"></ul>
</div>
<div style="display: none;">
Expand Down Expand Up @@ -57,7 +57,7 @@ describe('modus-autocomplete', () => {
<modus-text-input aria-autocomplete="list" aria-controls="${listId}" class="input" role="combobox" autocomplete="off" size="medium" type="search" value=""></modus-text-input>
</div>
<div class="error"></div>
<div class="options-container" style="max-height: 300px; z-index: 1; overflow-y: auto;">
<div class="options-container" part="options-container" style="max-height: 300px; z-index: 1; overflow-y: auto; position: absolute; left: 0; top: 0; margin: 0;">
<ul aria-label="options" id="${listId}" role="listbox"></ul>
</div>
<div style="display: none;">
Expand Down
45 changes: 44 additions & 1 deletion stencil-workspace/src/components/modus-autocomplete/modus-autocomplete.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
import { IconSearch } from '../../icons/svgs/icon-search';
import { generateElementId } from '../../utils/utils';
import { IconCheck } from '../../icons/generated-icons/IconCheck';
import { createPopper, Instance, Placement } from '@popperjs/core';

export interface ModusAutocompleteOption {
id: string;
Expand Down Expand Up @@ -74,6 +75,9 @@ export class ModusAutocomplete {
/** A promise that returns the filtered options. */
@Prop() filterOptions: (search: string) => Promise<ModusAutocompleteOption[] | string[]>;

/** (optional) The placement of the options */
@Prop() position: Placement = 'bottom-start';

/** An array to hold the selected chips. */
@State() selectedChips: ModusAutocompleteOption[] = [];

Expand All @@ -86,6 +90,8 @@ export class ModusAutocomplete {
/** Whether to show autocomplete's options when focus. */
@Prop() showOptionsOnFocus: boolean;

private popperInstance: Instance;

@Watch('options')
watchOptions() {
this.convertOptions();
Expand Down Expand Up @@ -138,6 +144,42 @@ export class ModusAutocomplete {
@State() ShowItemsOnKeyDown = false;
private listId = generateElementId() + '_list';

componentDidLoad(): void {
this.convertOptions();
if (this.multiple) {
this.initializeSelectedChips();
}
this.initializePopper();
}

disconnectedCallback(): void {
if (this.popperInstance) {
this.popperInstance.destroy();
}
}

initializePopper(): void {
const optionsContainer = this.el.shadowRoot.querySelector(`.options-container`) as HTMLElement;
const referenceElement = this.el.shadowRoot.querySelector(`.chips-container`) as HTMLElement;

this.popperInstance = createPopper(referenceElement, optionsContainer, {
placement: 'bottom-start',
strategy: this.position === 'auto' ? 'fixed' : 'absolute',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a comment about why we use fixed strategy for auto position

Copy link
Collaborator

@prashanth-offcl prashanth-offcl Sep 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also if I set position to auto, options container width is not restricted to the input width.
image

modifiers: [
{
name: 'offset',
options: {
offset: [0, 2],
},
},
],
});

if (referenceElement && optionsContainer) {
optionsContainer.style.width = `${referenceElement.offsetWidth}px`;
}
}

componentWillLoad(): void {
this.convertOptions();
if (this.multiple) {
Expand Down Expand Up @@ -477,7 +519,7 @@ export class ModusAutocomplete {
const selectedOption = optionList.querySelector('li.selected') as HTMLElement;

if (selectedOption) {
selectedOption.scrollIntoView({ behavior: 'smooth', inline: 'nearest' });
selectedOption.scrollIntoView({ behavior: 'smooth', block: 'nearest' });
}
};

Expand Down Expand Up @@ -527,6 +569,7 @@ export class ModusAutocomplete {
<div class={'error'}>{this.errorText ? <label class="sub-text error">{this.errorText}</label> : null}</div>
<div
class="options-container"
part="options-container"
style={{ maxHeight: this.dropdownMaxHeight, zIndex: this.dropdownZIndex, overflowY: 'auto' }}>
<ul id={this.listId} aria-label="options" role="listbox">
{this.displayOptions() &&
Expand Down
Loading
Loading