@postnord/web-components
Version:
PostNord Web Components
1,056 lines (1,055 loc) • 45.6 kB
JavaScript
/*!
* Built with Stencil
* By PostNord.
*/
import { h, Host } from "@stencil/core";
import { translations } from "./translations";
import { close, alert_exclamation_circle, angle_down } from "pn-design-assets/pn-assets/icons.js";
import { uuidv4, awaitTopbar, ripple, en, getTotalHeightOffset } from "../../../index";
/**
* The `pn-multiselect` gets its options via javascript.
*
* Native HTML does not accept arrays of objects. Most frameworks solves this automatically (Vue, react, etc...),
* but keep this in mind if you use this component outside of a framework environment.
*
* @nativeChange The `pn-multiselect` is built with `input[type=checkbox]` elements, so the `change` event works. However, we recommend the customEvents described above.
*
* @see {@link https://portal.postnord.com/web-components/?path=/docs/components-input-multiselect--docs#pn-multiselect%20(options) Options documentation}
*/
export class PnMultiselect {
constructor() {
this.isSearching = false;
this.open = false;
this.moving = false;
this.upwards = false;
this.srMessage = undefined;
this.label = undefined;
this.helpertext = undefined;
this.placeholder = undefined;
this.name = undefined;
this.selectId = this.id;
this.selectName = undefined;
this.icon = undefined;
this.language = null;
this.options = undefined;
this.selectAll = false;
this.allValue = 'pn_multiselect_all';
this.search = false;
this.searchQuery = '';
this.itemCount = 5;
this.maxHeight = undefined;
this.top = false;
this.bottom = false;
this.required = false;
this.disabled = false;
this.invalid = false;
this.error = undefined;
}
id = `pn-multiselect-${uuidv4()}`;
idLegend = `${this.id}-legend`;
idButton = `${this.id}-button`;
idOptions = `${this.id}-options`;
idHelper = `${this.id}-text`;
idChips = `${this.id}-chips`;
idSr = `${this.id}-sr`;
elGroup;
elButton;
elInput;
elList;
elChips;
movingTimer;
srTimer;
hostElement;
handleOpen() {
this.handleMoving();
if (this.open) {
this.handleDirection();
this.handleMaxHeight();
this.handleWidth();
}
}
handleSearch() {
if (!this.search)
this.options = [
...this.options.map(option => {
const item = {
...option,
hide: false,
};
if (item?.group?.length)
item.group.map(opt => ({ ...opt, hide: false }));
return item;
}),
];
}
handleSearchQuery() {
if (this.search && typeof this.searchQuery === 'string')
this.handleInputSearch();
}
handleSelectId() {
const id = this.selectId;
this.idLegend = `${id}-legend`;
this.idButton = `${id}-button`;
this.idOptions = `${id}-options`;
this.idHelper = `${id}-text`;
this.idChips = `${id}-chips`;
this.idSr = `${id}-sr`;
}
/**
* If the select is open and you resize the window.
* Remove all css props and disable the animations entierly.
**/
handleResize({ type }) {
if (!this.open)
return;
this.toggleOpen(false);
this.moving = type === 'resize';
this.elList.style.removeProperty('--pn-select-options-width');
this.elList.style.removeProperty('--pn-select-max-height');
}
/** Dispatched everytime the multiselect is opened or closed. */
toggleSelect;
/** This event contains the entire options array with the new props. Dispatched everytime you make changes to any option. */
allOptions;
/** Dispatched when you toggle an option. Includes all the props of the option. */
selectedOption;
/**
* This event is dispatched when the user toggles the "Choose all options" box.
* Also triggers when you click the "Select {number} options" if you are performing a search at the same time.
**/
selectedAllOptions;
/**
* Contains the search text and the options found for that query.
* Dispacthed everytime you change the search query.
**/
searchInput;
async componentWillLoad() {
this.handleSelectId();
if (this.language === null)
await awaitTopbar(this.hostElement);
}
componentDidLoad() {
if (!!this.searchQuery?.length)
this.handleSearchQuery();
}
emitEvents(option, all) {
this.allOptions.emit(this.options);
if (option)
return this.selectedOption.emit(option);
const data = {
checked: all,
searching: this.isSearching,
};
if (this.search && this.optionsTotal() !== this.optionsSearch().length) {
data.query = this.searchQuery;
data.found = this.optionsSearch();
}
this.selectedAllOptions.emit(data);
}
optionsChecked() {
const list = this.options?.reduce((sum, item) => {
const subgroup = item.group ? [...item.group.filter(({ checked }) => checked)] : [];
if (item.checked)
sum.push(item);
if (subgroup?.length)
sum.push(...subgroup);
return sum;
}, []);
return list;
}
optionsTotal() {
return this.options?.reduce((sum, item) => sum + (item?.group?.length ? item.group.length + 1 : 1), 0);
}
optionsIndex(val) {
const findNested = ({ group = [] }) => group?.findIndex(({ value }) => value === val);
const indexGroup = this.options.findIndex(option => option.value === val || findNested(option) !== -1);
const indexNested = findNested(this.options?.[indexGroup]);
return {
indexGroup,
indexNested,
};
}
optionsCheckedTotal() {
return this.optionsChecked()?.length;
}
optionsCheckedPreview() {
return this.optionsChecked()?.slice(0, this.itemCount);
}
optionsCheckedLabels() {
return this.optionsChecked()
?.map(({ label }) => label)
?.join(', ');
}
optionsSearch() {
const list = this.options?.reduce((sum, item) => {
const subgroup = item.group ? [...item.group.filter(({ hide }) => !hide)] : [];
if (!item.hide)
sum.push(item);
if (subgroup?.length)
sum.push(...subgroup);
return sum;
}, []);
return list;
}
noResults() {
return this.optionsSearch()?.length === 0;
}
isIndeterminate(groupIndex) {
const option = this.options?.[groupIndex];
if (option?.group?.length) {
const all = option.group.every(({ checked }) => checked);
const none = option.group.every(({ checked }) => !checked);
return !(all || none);
}
return false;
}
optionSelect({ val, checked, chip }) {
if (val === this.allValue)
return this.optionSelectAll(checked);
const options = this.options;
const { indexGroup, indexNested } = this.optionsIndex(val);
const group = options[indexGroup]?.group;
const nested = group?.[indexNested];
if (nested?.value) {
options[indexGroup].group[indexNested].checked = checked;
const allSiblingsChecked = group?.every(({ checked }) => checked);
if (allSiblingsChecked)
options[indexGroup].checked = true;
else
options[indexGroup].checked = false;
}
else {
options[indexGroup].checked = checked;
if (group?.length)
options[indexGroup].group = group?.map(opt => ({ ...opt, checked: checked }));
}
const option = indexNested === -1 ? options[indexGroup] : options[indexGroup].group[indexNested];
this.emitEvents(option);
this.options = [...options];
if (typeof chip === 'number') {
this.handleSrMesssage(`${this.translate('REMOVED')} ${option.label}`);
requestAnimationFrame(() => {
const index = chip === this.optionsCheckedTotal() ? chip - 1 : chip;
const btn = Array.from(this.elChips.children)?.[index];
btn?.querySelector('button').focus({ preventScroll: true });
});
}
}
optionSelectAll(checked) {
this.options = [
...this.options.map(option => {
const opt = {
...option,
checked: this.isSearching ? (option.hide ? option.checked : checked) : checked,
};
if (opt.group)
opt.group = [
...opt.group.map(item => ({
...item,
checked: this.isSearching ? (item.hide ? item.checked : checked) : checked,
})),
];
const allChecked = opt?.group?.every(({ checked }) => checked);
if (opt?.group?.length)
opt.checked = allChecked;
return opt;
}),
];
this.emitEvents(null, checked);
}
optionSelected(val) {
return !!this.optionsChecked()?.find(({ value, checked }) => value === val && checked);
}
translate(prop) {
const text = translations?.[prop]?.[this.language || en];
if (text.includes('{number}'))
return text.replace('{number}', this.optionsSearch().length);
return text;
}
getRect(element) {
return element?.getBoundingClientRect();
}
ripple({ clientX, clientY, target }) {
const isKeyboard = clientX === 0 && clientY === 0;
const element = target.nextElementSibling;
const { x, width, y, top } = this.getRect(element);
const clientCor = isKeyboard ? { clientX: x + width - 24, clientY: y - top } : { clientX, clientY };
ripple(clientCor, element);
}
handleMoving() {
this.moving = true;
clearTimeout(this.movingTimer);
this.movingTimer = setTimeout(() => (this.moving = false), 200);
}
handleSrMesssage(text) {
this.srMessage = text;
clearTimeout(this.srTimer);
this.srTimer = setTimeout(() => (this.srMessage = null), 2000);
}
handleDirection() {
if (this.top)
return (this.upwards = true);
if (this.bottom)
return (this.upwards = false);
const { bottom, top } = this.getRect(this.elInput);
const oneEm = 16;
/*
* Take the inner window height and subtract the elements bottom and 1em (16px)
* If the max height of this calculation is less than the space above the element, open it upwards.
* Do another calculation with the top value - 1em.
*/
const offsetTop = window.innerHeight - bottom - oneEm;
const offsetBottom = top - oneEm;
/** Always point downwards, unless the space to the bottom is less than half of the top offset space. */
this.upwards = offsetBottom / 2 > offsetTop;
}
handleMaxHeight() {
if (this.maxHeight)
return this.elGroup.style.setProperty('--pn-select-max-height', this.maxHeight);
const { bottom, top } = this.getRect(this.elInput);
const inputHeight = this.upwards ? top : bottom;
const offsetTop = getTotalHeightOffset();
const offset = this.upwards ? offsetTop + 16 : 16;
const maxHeight = this.upwards ? inputHeight - offset : window.innerHeight - inputHeight - offset;
this.elGroup.style.setProperty('--pn-select-max-height', `${Math.ceil(maxHeight)}px`);
}
handleWidth() {
const { width } = this.getRect(this.elInput);
this.elGroup.style.setProperty('--pn-select-options-width', `${Math.ceil(width)}px`);
}
setFocus() {
if (this.search)
this.elInput.focus({ preventScroll: true });
else
this.elButton.focus({ preventScroll: true });
}
hasError() {
return this.invalid || !!this.error;
}
hasMessage() {
return !!this.helpertext || !!this.error;
}
toggleOpen(state) {
this.open = state ?? !this.open;
this.toggleSelect.emit({ open: this.open });
}
handleInputKeyboard(event) {
const { code } = event;
if (code === 'Escape')
return this.toggleOpen(false);
if (!this.open && code.match(/^(Space|Enter)$|Arrow|^Key.*$/))
this.toggleOpen();
}
setSearchQuery(value) {
this.searchQuery = value;
}
handleInputSearch() {
if (this.isEmpty())
return;
const term = this.searchQuery;
const performSearch = ({ label, helpertext, value }) => {
return `${label} ${helpertext} ${value}`.trim().toLowerCase().includes(term.toLowerCase());
};
const options = this.options.map(option => {
const foundNested = option?.group?.map(item => ({ ...item, hide: !performSearch(item) })) || [];
const found = performSearch(option) || foundNested?.some(({ hide }) => !hide);
option.hide = !found;
if (option?.group?.length)
option.group = [...foundNested];
return option;
});
this.isSearching = term !== '';
this.options = [...options];
this.searchInput.emit({ query: term, found: this.optionsSearch() });
}
getListItem(index) {
const { value } = this.options[index];
return this.elList.querySelector(`.pn-multiselect-option-input[value='${value}']`);
}
getOptionIndex(val, triggers, code) {
const total = this.optionsTotal() - 1;
if (code === 'End')
return total;
if (code === 'Home')
return 0;
const valIndex = this.options.findIndex(({ value }) => value === val);
const count = triggers.find(item => typeof item === 'number');
const index = valIndex + count;
if (index >= total)
return total;
if (index <= 0)
return 0;
return index;
}
checkboxNav(e, val) {
const { code } = e;
const arrowUp = code === 'ArrowUp' && -1;
const arrowDown = code === 'ArrowDown' && 1;
const pageUp = code === 'PageUp' && -10;
const pageDown = code === 'PageDown' && 10;
const home = code === 'Home' && 0;
const end = code === 'End' && this.optionsTotal() - 1;
const tab = code === 'Tab';
const space = code === 'Space';
const enter = code === 'Enter';
const escape = code === 'Escape';
const triggers = [arrowUp, arrowDown, pageUp, pageDown, home, end, tab, space, enter, escape];
if (!triggers.some(item => typeof item === 'number' || item))
return;
if (tab || space || enter)
return;
if (escape) {
this.setFocus();
return this.toggleOpen(false);
}
const item = this.getOptionIndex(val, triggers, code);
e.preventDefault();
return this.getListItem(item)?.focus();
}
handleBlur(event) {
const target = event.relatedTarget;
const currentSelect = target?.closest('pn-multiselect');
const insideCurrent = currentSelect?.selectId === this.selectId;
const jumpingToChips = event.relatedTarget?.className === 'pn-multiselect-chip-button';
if (!insideCurrent || jumpingToChips)
this.toggleOpen(false);
}
handleLabel() {
if (this.disabled)
return;
this.setFocus();
}
/** Check if there are no options in the list. */
isEmpty() {
return (this.options?.length || 0) === 0;
}
showSelectAll() {
return this.selectAll && !this.isEmpty() && !this.noResults();
}
/** Check if the empty/nothing found should be visible. */
showEmptyOption() {
return (this.isSearching && this.noResults()) || this.isEmpty();
}
getPlaceholder() {
const autoTranslation = this.search ? 'SEARCH' : 'SELECT_AN_OPTION';
return this.placeholder || this.translate(autoTranslation);
}
handleChange({ target }) {
const { value, checked } = target;
this.optionSelect({ val: value, checked });
}
/** Display the "X more selected options" text. */
additonalOptions() {
const count = this.optionsCheckedTotal() - this.itemCount;
const single = `MORE_OPTION${count === 1 ? '' : 'S'}`;
return `${count} ${this.translate(single)}`;
}
describedBy() {
const list = [this.search && this.idChips, this.srMessage && this.idSr, !!this.helpertext && this.idHelper].filter(Boolean);
if (list.length)
return list.join(' ');
return null;
}
renderOption({ label, value, checked, helpertext, icon, id = `${this.selectId}-${value || label}`, invalid, disabled, hide, group, }, indexGroup, indexNested) {
return (h("li", { class: "pn-multiselect-option", key: id, hidden: hide }, h("input", { type: "checkbox", id: id, class: "pn-multiselect-option-input", checked: checked ?? this.optionSelected(value), indeterminate: indexNested === undefined && this.isIndeterminate(indexGroup), name: this.name, value: value, disabled: this.disabled || disabled, required: this.required, "aria-invalid": invalid ? 'true' : null, "aria-describedby": helpertext ? `${id}-helper` : null, onClick: (event) => this.ripple(event), onKeyDown: (event) => this.checkboxNav(event, value), onBlur: (event) => this.handleBlur(event) }), h("div", { class: "pn-multiselect-option-content" }, !!icon && h("pn-icon", { icon: icon, color: "blue900" }), h("div", { class: "pn-multiselect-option-text" }, h("label", { class: "pn-multiselect-option-label", htmlFor: id }, h("span", null, label)), helpertext && (h("p", { class: "pn-multiselect-option-helper", id: `${id}-helper` }, helpertext))), h("div", { class: "pn-multiselect-option-checkbox" }, h("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 24 24", fill: "none" }, h("polyline", { class: "pn-multiselect-option-checkbox-checkmark-path", points: "4,12 9,17 20,6", "stroke-width": "3" }), h("polyline", { class: "pn-multiselect-option-checkbox-indeterminate-path", points: "4,12 20,12", "stroke-width": "3" })))), group?.length && (h("ul", { class: "pn-multiselect-optgroup" }, group?.map((option, i) => this.renderOption(option, indexGroup, i))))));
}
renderOptions() {
return (h("ul", { id: this.idOptions, class: "pn-multiselect-options", "data-open": this.open, "data-upwards": this.upwards, "data-moving": this.moving, onChange: (event) => this.handleChange(event), ref: el => (this.elList = el) }, this.showSelectAll() &&
this.renderOption({
label: this.translate(`SELECT_${this.isSearching ? 'FOUND' : 'ALL'}_OPTIONS`),
value: this.allValue,
checked: this.optionsTotal() === this.optionsCheckedTotal(),
}), this.options?.map((option, index) => this.renderOption(option, index)), this.showEmptyOption() && (h("li", { class: "pn-multiselect-option" }, h("div", { class: "pn-multiselect-option-content", role: "alert" }, h("div", { class: "pn-multiselect-option-text" }, h("span", { class: "pn-multiselect-option-label" }, this.translate(this.isEmpty() ? 'NO_OPTIONS' : 'NO_SEARCH_RESULTS'))))))));
}
renderChips() {
return (h("ul", { id: this.idChips, class: "pn-multiselect-chips", "aria-label": this.translate('SELECTED_OPTIONS'), ref: el => (this.elChips = el) }, this.optionsCheckedPreview()?.map(({ label, value }, index) => (h("li", { class: "pn-multiselect-chip", "aria-setsize": this.optionsCheckedTotal(), "aria-posinset": index + 1, key: `${label}-${value}` }, h("span", { class: "pn-multiselect-chip-label" }, label), h("button", { type: "button", class: "pn-multiselect-chip-button", "aria-label": `${this.translate('REMOVE')} ${label}`, onClick: () => this.optionSelect({ val: value, checked: false, chip: index }) }, h("pn-icon", { icon: close, small: true, color: "blue700" }))))), this.optionsCheckedTotal() > this.itemCount && (h("li", { class: "pn-multiselect-chip", "data-count": true }, h("span", { class: "pn-multiselect-chip-label" }, "+ ", this.additonalOptions())))));
}
render() {
return (h(Host, { key: '4d58fe38a9cd652173ea9f2cea2bf3c1aadfe24d' }, h("fieldset", { key: 'b0e73e9df6fb42392dec0ea6f83e906f34b04963', class: "pn-multiselect", "data-icon": !!this.icon, "data-error": this.hasError(), disabled: this.disabled }, this.label && (h("legend", { key: 'a89d4b85e3f1d4d79855fb3cf64a810f815f375a', id: this.idLegend, class: "pn-multiselect-label", onClick: () => this.handleLabel() }, h("span", { key: '4c888cc040b1c8dfba6983e62ccbdf2850d46976' }, this.label), !!this.optionsChecked()?.length && (h("span", { key: 'b648b8dc76e23abf0245f796b2368773def82b4f' }, this.optionsCheckedTotal(), "/", this.optionsTotal())))), h("div", { key: '73e0b4a56211c128071f87a7507cd286660d1dd8', class: "pn-multiselect-group", ref: el => (this.elGroup = el) }, h("div", { key: '6a23dceb2e31cd80f2b9373f2455b996c53e454b', class: "pn-multiselect-input" }, !!this.icon && h("pn-icon", { key: 'ce6bec5aac2398db1583dca4791866197ffc5379', class: "pn-multiselect-icon", "data-custom": true, icon: this.icon }), h("input", { key: '509b6ae212e7ad34a825806816be9bda9b9691a6', tabindex: this.search ? null : '-1', type: this.search ? 'search' : 'input', id: this.selectId, class: "pn-multiselect-element", value: this.search ? this.searchQuery : this.optionsCheckedLabels(), name: this.selectName, placeholder: this.getPlaceholder(), required: this.search ? null : this.required, "aria-labelledby": this.idLegend, "aria-describedby": this.describedBy(), "aria-controls": `${this.idOptions} ${this.search ? this.idChips : ''}`, "aria-invalid": this.hasError()?.toString(), disabled: this.disabled, readonly: !this.search, onClick: () => this.toggleOpen(), onKeyDown: e => this.handleInputKeyboard(e), onBlur: e => this.handleBlur(e), onInput: e => this.search && this.setSearchQuery(e.target.value), ref: el => (this.elInput = el) }), this.hasError() && (h("pn-icon", { key: 'eee58901db95ce805a247bc5c5c6e93dacbfbfb3', class: "pn-multiselect-icon", "data-error": true, icon: alert_exclamation_circle, color: "warning" })), h("button", { key: 'ddd3fadcd289b6b10f90f5d1c14bce16c9148096', id: this.idButton, type: "button", class: "pn-multiselect-button", "aria-label": this.translate(`BUTTON_${this.open ? 'CLOSE' : 'OPEN'}`), "aria-describedby": this.search ? null : this.selectId, "aria-controls": this.idOptions, "aria-expanded": this.open.toString(), onClick: () => this.toggleOpen(), ref: el => (this.elButton = el) }, h("pn-icon", { key: '5d2b2556f0696c39489863a19d36be0ccdd34644', class: "pn-multiselect-icon", icon: angle_down, color: "blue700" }))), this.renderOptions()), this.hasMessage() && (h("p", { key: '89dc5ec7faaa1f4d1d734449eafa836fc00a5b8b', id: this.idHelper, class: "pn-multiselect-description", role: !!this.error ? 'alert' : null }, h("span", { key: 'a3041c171672223c64d0d3f50f11e4b7c650873e' }, this.error || this.helpertext))), this.search && this.renderChips(), h("slot", { key: 'd420c415a2f145bd0ddd27c8b70335629a83c93b' }), this.search && (h("p", { key: 'ed08dbce5e58a3a8047317c5756b7792225f7560', id: this.idSr, class: "pn-multiselect-sr-only", role: "alert", "aria-live": "assertive" }, this.srMessage && h("span", { key: '15edfdab7417fc70f44e098c3f9943d59ad7eb8f' }, this.srMessage))))));
}
static get is() { return "pn-multiselect"; }
static get originalStyleUrls() {
return {
"$": ["pn-multiselect.scss"]
};
}
static get styleUrls() {
return {
"$": ["pn-multiselect.css"]
};
}
static get properties() {
return {
"label": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": true,
"optional": false,
"docs": {
"tags": [],
"text": "Label placed above the select"
},
"attribute": "label",
"reflect": false
},
"helpertext": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "Display a helper text underneath the select"
},
"attribute": "helpertext",
"reflect": false
},
"placeholder": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "This is what will be shown on load if no value is used.\nThe `placeholder` will override the default text used if you have the `search` prop active."
},
"attribute": "placeholder",
"reflect": false
},
"name": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "HTML name of the checkbox elements. Used for each checkbox inside the multiselect."
},
"attribute": "name",
"reflect": false
},
"selectId": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [],
"text": "Select HTML id"
},
"attribute": "select-id",
"reflect": false,
"defaultValue": "this.id"
},
"selectName": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "HTML name of the input element."
},
"attribute": "select-name",
"reflect": false
},
"icon": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "Display an icon to the left of the select input"
},
"attribute": "icon",
"reflect": false
},
"language": {
"type": "string",
"mutable": false,
"complexType": {
"original": "PnLanguages",
"resolved": "\"\" | \"da\" | \"en\" | \"fi\" | \"no\" | \"sv\"",
"references": {
"PnLanguages": {
"location": "import",
"path": "@/index",
"id": "src/index.ts::PnLanguages"
}
}
},
"required": false,
"optional": true,
"docs": {
"tags": [],
"text": "Manually set the language, not needed if you have the pnTopbar available"
},
"attribute": "language",
"reflect": false,
"defaultValue": "null"
},
"options": {
"type": "unknown",
"mutable": true,
"complexType": {
"original": "PnMultiselectOption[]",
"resolved": "PnMultiselectOption[]",
"references": {
"PnMultiselectOption": {
"location": "import",
"path": "@/index",
"id": "src/index.ts::PnMultiselectOption"
}
}
},
"required": true,
"optional": false,
"docs": {
"tags": [{
"name": "hide",
"text": "true"
}],
"text": "Array of options."
}
},
"selectAll": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [{
"name": "see",
"text": "{@link search }"
}, {
"name": "category",
"text": "Features"
}],
"text": "Adds a \"Select all\" option into the list.\nIf you use the search feature at the same time, clicking this option will only toggle the options found."
},
"attribute": "select-all",
"reflect": false,
"defaultValue": "false"
},
"allValue": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "see",
"text": "{@link selectAll }"
}, {
"name": "category",
"text": "Features"
}],
"text": "Set a custom value for the \"Select all value\" option."
},
"attribute": "all-value",
"reflect": false,
"defaultValue": "'pn_multiselect_all'"
},
"search": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Features"
}],
"text": "Allow the user to search among the options.\nThe selected options will now display underneath the multiselect element."
},
"attribute": "search",
"reflect": false,
"defaultValue": "false"
},
"searchQuery": {
"type": "string",
"mutable": true,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "see",
"text": "{@link search }"
}, {
"name": "category",
"text": "Features"
}],
"text": "Set the search query of the multiselect."
},
"attribute": "search-query",
"reflect": false,
"defaultValue": "''"
},
"itemCount": {
"type": "number",
"mutable": false,
"complexType": {
"original": "number",
"resolved": "number",
"references": {}
},
"required": false,
"optional": false,
"docs": {
"tags": [{
"name": "see",
"text": "{@link search }"
}, {
"name": "category",
"text": "Features"
}],
"text": "Decide how many items should be shown before ellipsis. Requires the `search` prop to work."
},
"attribute": "item-count",
"reflect": false,
"defaultValue": "5"
},
"maxHeight": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "description",
"text": "The component will automatically set the max height of the dropdown list on its own.\nIt takes the `pn-topbar` into account and will open in the direction that fits best.\nUse this prop to override this behaviour and use a custom max-height."
}, {
"name": "category",
"text": "Features"
}],
"text": "Use a custom max-height for the dropdown list."
},
"attribute": "max-height",
"reflect": false
},
"top": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Features"
}],
"text": "Force the dropdown to always open upwards."
},
"attribute": "top",
"reflect": false,
"defaultValue": "false"
},
"bottom": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Features"
}],
"text": "Force the dropdown to always open downwards."
},
"attribute": "bottom",
"reflect": false,
"defaultValue": "false"
},
"required": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Validation"
}],
"text": "Set the select as required."
},
"attribute": "required",
"reflect": false,
"defaultValue": "false"
},
"disabled": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Validation"
}],
"text": "Disable the select."
},
"attribute": "disabled",
"reflect": false,
"defaultValue": "false"
},
"invalid": {
"type": "boolean",
"mutable": false,
"complexType": {
"original": "boolean",
"resolved": "boolean",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Validation"
}],
"text": "Trigger the invalid state."
},
"attribute": "invalid",
"reflect": false,
"defaultValue": "false"
},
"error": {
"type": "string",
"mutable": false,
"complexType": {
"original": "string",
"resolved": "string",
"references": {}
},
"required": false,
"optional": true,
"docs": {
"tags": [{
"name": "category",
"text": "Validation"
}],
"text": "Display an error message and trigger the invalid state."
},
"attribute": "error",
"reflect": false
}
};
}
static get states() {
return {
"isSearching": {},
"open": {},
"moving": {},
"upwards": {},
"srMessage": {}
};
}
static get events() {
return [{
"method": "toggleSelect",
"name": "toggleSelect",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "Dispatched everytime the multiselect is opened or closed."
},
"complexType": {
"original": "{ open: boolean }",
"resolved": "{ open: boolean; }",
"references": {}
}
}, {
"method": "allOptions",
"name": "allOptions",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "This event contains the entire options array with the new props. Dispatched everytime you make changes to any option."
},
"complexType": {
"original": "PnMultiselectOption[]",
"resolved": "PnMultiselectOption[]",
"references": {
"PnMultiselectOption": {
"location": "import",
"path": "@/index",
"id": "src/index.ts::PnMultiselectOption"
}
}
}
}, {
"method": "selectedOption",
"name": "selectedOption",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "Dispatched when you toggle an option. Includes all the props of the option."
},
"complexType": {
"original": "PnMultiselectOption",
"resolved": "PnMultiselectOption",
"references": {
"PnMultiselectOption": {
"location": "import",
"path": "@/index",
"id": "src/index.ts::PnMultiselectOption"
}
}
}
}, {
"method": "selectedAllOptions",
"name": "selectedAllOptions",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "This event is dispatched when the user toggles the \"Choose all options\" box.\nAlso triggers when you click the \"Select {number} options\" if you are performing a search at the same time."
},
"complexType": {
"original": "{\n checked: boolean;\n searching: boolean;\n query?: string;\n found?: PnMultiselectOption[];\n }",
"resolved": "{ checked: boolean; searching: boolean; query?: string; found?: PnMultiselectOption[]; }",
"references": {
"PnMultiselectOption": {
"location": "import",
"path": "@/index",
"id": "src/index.ts::PnMultiselectOption"
}
}
}
}, {
"method": "searchInput",
"name": "searchInput",
"bubbles": true,
"cancelable": true,
"composed": true,
"docs": {
"tags": [],
"text": "Contains the search text and the options found for that query.\nDispacthed everytime you change the search query."
},
"complexType": {
"original": "{\n query: string;\n found?: PnMultiselectOption[];\n }",
"resolved": "{ query: string; found?: PnMultiselectOption[]; }",
"references": {
"PnMultiselectOption": {
"location": "import",
"path": "@/index",
"id": "src/index.ts::PnMultiselectOption"
}
}
}
}];
}
static get elementRef() { return "hostElement"; }
static get watchers() {
return [{
"propName": "open",
"methodName": "handleOpen"
}, {
"propName": "search",
"methodName": "handleSearch"
}, {
"propName": "searchQuery",
"methodName": "handleSearchQuery"
}, {
"propName": "selectId",
"methodName": "handleSelectId"
}];
}
static get listeners() {
return [{
"name": "resize",
"method": "handleResize",
"target": "window",
"capture": false,
"passive": true
}];
}
}
//# sourceMappingURL=pn-multiselect.js.map