@synergy-design-system/angular
Version:
Angular wrappers for the Synergy Design System
394 lines (390 loc) • 15.4 kB
JavaScript
import * as i0 from '@angular/core';
import { EventEmitter, Output, Input, Component } from '@angular/core';
import '@synergy-design-system/components/components/combobox/combobox.js';
// ---------------------------------------------------------------------
// 🔒 AUTOGENERATED @synergy-design-system/angular wrappers for @synergy-design-system/components
// Please do not edit this file directly!
// It will get recreated when running pnpm build.
// ---------------------------------------------------------------------
/**
* @summary Comboboxes allow you to choose items from a menu of predefined options.
* @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-combobox--docs
* @status stable
*
* @dependency syn-icon
* @dependency syn-popup
*
* @slot - The listbox options. Must be `<syn-option>` elements.
* You can use `<syn-optgroup>`'s to group items visually.
* @slot label - The combobox's label. Alternatively, you can use the `label` attribute.
* @slot prefix - Used to prepend a presentational icon or similar element to the combobox.
* @slot suffix - Used to append a presentational icon or similar element to the combobox.
* @slot clear-icon - An icon to use in lieu of the default clear icon.
* @slot expand-icon - The icon to show when the control is expanded and collapsed.
* Rotates on open and close.
* @slot help-text - Text that describes how to use the combobox.
* Alternatively, you can use the `help-text` attribute.
*
* @event syn-change - Emitted when the control's value changes.
* @event syn-clear - Emitted when the control's value is cleared.
* @event syn-input - Emitted when the control receives input.
* @event syn-focus - Emitted when the control gains focus.
* @event syn-blur - Emitted when the control loses focus.
* @event syn-show - Emitted when the combobox's menu opens.
* @event syn-after-show - Emitted after the combobox's menu opens and all animations are complete.
* @event syn-hide - Emitted when the combobox's menu closes.
* @event syn-after-hide - Emitted after the combobox's menu closes and all animations are complete.
* @event syn-invalid - Emitted when the form control has been checked for validity
* and its constraints aren't satisfied.
* @event syn-error - Emitted when the combobox menu fails to open.
*
* @csspart form-control - The form control that wraps the label, combobox, and help text.
* @csspart form-control-label - The label's wrapper.
* @csspart form-control-input - The combobox's wrapper.
* @csspart form-control-help-text - The help text's wrapper.
* @csspart combobox - The container the wraps the prefix, combobox, clear icon, and expand button.
* @csspart prefix - The container that wraps the prefix slot.
* @csspart suffix - The container that wraps the suffix slot.
* @csspart display-input - The element that displays the selected option's label,
* an `<input>` element.
* @csspart listbox - The listbox container where the options are slotted
* and the filtered options list exists.
* @csspart filtered-listbox - The container that wraps the filtered options.
* @csspart clear-button - The clear button.
* @csspart expand-icon - The container that wraps the expand icon.
* @csspart popup - The popup's exported `popup` part.
* Use this to target the tooltip's popup container.
*
* @animation combobox.show - The animation to use when showing the combobox.
* @animation combobox.hide - The animation to use when hiding the combobox.
*/
class SynComboboxComponent {
nativeElement;
_ngZone;
modelSignal = new AbortController();
constructor(e, ngZone) {
this.nativeElement = e.nativeElement;
this._ngZone = ngZone;
this.nativeElement.addEventListener('syn-change', (e) => {
this.synChangeEvent.emit(e);
});
this.nativeElement.addEventListener('syn-clear', (e) => {
this.synClearEvent.emit(e);
});
this.nativeElement.addEventListener('syn-input', (e) => {
this.synInputEvent.emit(e);
});
this.nativeElement.addEventListener('syn-focus', (e) => {
this.synFocusEvent.emit(e);
});
this.nativeElement.addEventListener('syn-blur', (e) => {
this.synBlurEvent.emit(e);
});
this.nativeElement.addEventListener('syn-show', (e) => {
this.synShowEvent.emit(e);
});
this.nativeElement.addEventListener('syn-after-show', (e) => {
this.synAfterShowEvent.emit(e);
});
this.nativeElement.addEventListener('syn-hide', (e) => {
this.synHideEvent.emit(e);
});
this.nativeElement.addEventListener('syn-after-hide', (e) => {
this.synAfterHideEvent.emit(e);
});
this.nativeElement.addEventListener('syn-invalid', (e) => {
this.synInvalidEvent.emit(e);
});
this.nativeElement.addEventListener('syn-error', (e) => {
this.synErrorEvent.emit(e);
});
this.ngModelUpdateOn = 'syn-input';
}
/**
* The event that will trigger the ngModel update.
* By default, this is set to "syn-input".
*/
set ngModelUpdateOn(v) {
this.modelSignal.abort();
this.modelSignal = new AbortController();
const option = v || 'syn-input';
this.nativeElement.addEventListener(option, () => {
this.valueChange.emit(this.value);
}, {
signal: this.modelSignal.signal,
});
}
get ngModelUpdateOn() {
return this.ngModelUpdateOn;
}
/**
* The name of the combobox, submitted as a name/value pair with form data.
*/
set name(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.name = v));
}
get name() {
return this.nativeElement.name;
}
/**
* The current value of the combobox, submitted as a name/value pair with form data.
*/
set value(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.value = v));
}
get value() {
return this.nativeElement.value;
}
/**
* The combobox's size.
*/
set size(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.size = v));
}
get size() {
return this.nativeElement.size;
}
/**
* Placeholder text to show as a hint when the combobox is empty.
*/
set placeholder(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.placeholder = v));
}
get placeholder() {
return this.nativeElement.placeholder;
}
/**
* Disables the combobox control.
*/
set disabled(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.disabled = v === '' || v));
}
get disabled() {
return this.nativeElement.disabled;
}
/**
* Adds a clear button when the combobox is not empty.
*/
set clearable(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.clearable = v === '' || v));
}
get clearable() {
return this.nativeElement.clearable;
}
/**
* Indicates whether or not the combobox is open.
You can toggle this attribute to show and hide the listbox, or you can use the `show()`
and `hide()` methods and this attribute will reflect the combobox's open state.
*/
set open(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.open = v === '' || v));
}
get open() {
return this.nativeElement.open;
}
/**
* Enable this option to prevent the listbox from being clipped,
when the component is placed inside a container with `overflow: auto|scroll`.
Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
*/
set hoist(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.hoist = v === '' || v));
}
get hoist() {
return this.nativeElement.hoist;
}
/**
* The combobox's label.
* If you need to display HTML, use the `label` slot instead.
*/
set label(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.label = v));
}
get label() {
return this.nativeElement.label;
}
/**
* The preferred placement of the combobox's menu.
Note that the actual placement may vary as needed to keep the listbox inside of the viewport.
*/
set placement(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.placement = v));
}
get placement() {
return this.nativeElement.placement;
}
/**
* The combobox's help text.
* If you need to display HTML, use the `help-text` slot instead.
*/
set helpText(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.helpText = v));
}
get helpText() {
return this.nativeElement.helpText;
}
/**
* By default, form controls are associated with the nearest containing `<form>` element.
This attribute allows you to place the form control outside of a form and associate it
with the form that has this `id`.
The form must be in the same document or shadow root for this to work.
*/
set form(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.form = v));
}
get form() {
return this.nativeElement.form;
}
/**
* The combobox's required attribute.
*/
set required(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.required = v === '' || v));
}
get required() {
return this.nativeElement.required;
}
/**
* A function that customizes the rendered option.
* The first argument is the option, the second
is the query string, which is typed into the combobox.
The function should return either a Lit TemplateResult or a string containing trusted HTML
to render in the shown list of filtered options.
If the query string should be highlighted use the `highlightOptionRenderer` function.
*/
set getOption(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.getOption = v));
}
get getOption() {
return this.nativeElement.getOption;
}
/**
* A function used to filter options in the combobox component.
The default filter method is a case- and diacritic-insensitive string comparison.
*/
set filter(v) {
this._ngZone.runOutsideAngular(() => (this.nativeElement.filter = v));
}
get filter() {
return this.nativeElement.filter;
}
/**
* Emitted when the control's value changes.
*/
synChangeEvent = new EventEmitter();
/**
* Emitted when the control's value is cleared.
*/
synClearEvent = new EventEmitter();
/**
* Emitted when the control receives input.
*/
synInputEvent = new EventEmitter();
/**
* Emitted when the control gains focus.
*/
synFocusEvent = new EventEmitter();
/**
* Emitted when the control loses focus.
*/
synBlurEvent = new EventEmitter();
/**
* Emitted when the combobox's menu opens.
*/
synShowEvent = new EventEmitter();
/**
* Emitted after the combobox's menu opens and all animations are complete.
*/
synAfterShowEvent = new EventEmitter();
/**
* Emitted when the combobox's menu closes.
*/
synHideEvent = new EventEmitter();
/**
* Emitted after the combobox's menu closes and all animations are complete.
*/
synAfterHideEvent = new EventEmitter();
/**
* Emitted when the form control has been checked for validity and its constraints aren't satisfied.
*/
synInvalidEvent = new EventEmitter();
/**
* Emitted when the combobox menu fails to open.
*/
synErrorEvent = new EventEmitter();
/**
* Support for two way data binding
*/
valueChange = new EventEmitter();
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.1", ngImport: i0, type: SynComboboxComponent, deps: [{ token: i0.ElementRef }, { token: i0.NgZone }], target: i0.ɵɵFactoryTarget.Component });
static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "20.0.1", type: SynComboboxComponent, isStandalone: true, selector: "syn-combobox", inputs: { ngModelUpdateOn: "ngModelUpdateOn", name: "name", value: "value", size: "size", placeholder: "placeholder", disabled: "disabled", clearable: "clearable", open: "open", hoist: "hoist", label: "label", placement: "placement", helpText: "helpText", form: "form", required: "required", getOption: "getOption", filter: "filter" }, outputs: { synChangeEvent: "synChangeEvent", synClearEvent: "synClearEvent", synInputEvent: "synInputEvent", synFocusEvent: "synFocusEvent", synBlurEvent: "synBlurEvent", synShowEvent: "synShowEvent", synAfterShowEvent: "synAfterShowEvent", synHideEvent: "synHideEvent", synAfterHideEvent: "synAfterHideEvent", synInvalidEvent: "synInvalidEvent", synErrorEvent: "synErrorEvent", valueChange: "valueChange" }, ngImport: i0, template: '<ng-content></ng-content>', isInline: true });
}
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.1", ngImport: i0, type: SynComboboxComponent, decorators: [{
type: Component,
args: [{
selector: 'syn-combobox',
standalone: true,
template: '<ng-content></ng-content>',
}]
}], ctorParameters: () => [{ type: i0.ElementRef }, { type: i0.NgZone }], propDecorators: { ngModelUpdateOn: [{
type: Input
}], name: [{
type: Input
}], value: [{
type: Input
}], size: [{
type: Input
}], placeholder: [{
type: Input
}], disabled: [{
type: Input
}], clearable: [{
type: Input
}], open: [{
type: Input
}], hoist: [{
type: Input
}], label: [{
type: Input
}], placement: [{
type: Input
}], helpText: [{
type: Input
}], form: [{
type: Input
}], required: [{
type: Input
}], getOption: [{
type: Input
}], filter: [{
type: Input
}], synChangeEvent: [{
type: Output
}], synClearEvent: [{
type: Output
}], synInputEvent: [{
type: Output
}], synFocusEvent: [{
type: Output
}], synBlurEvent: [{
type: Output
}], synShowEvent: [{
type: Output
}], synAfterShowEvent: [{
type: Output
}], synHideEvent: [{
type: Output
}], synAfterHideEvent: [{
type: Output
}], synInvalidEvent: [{
type: Output
}], synErrorEvent: [{
type: Output
}], valueChange: [{
type: Output
}] } });
/**
* Generated bundle index. Do not edit.
*/
export { SynComboboxComponent };
//# sourceMappingURL=synergy-design-system-angular-components-combobox.mjs.map