{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/theming/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/theming/theming-event.ts", "declarations": [ { "kind": "variable", "name": "CHANGE_THEME_EVENT", "type": { "text": "string" }, "default": "'igc-change-theme'" }, { "kind": "variable", "name": "CHANGED_THEME_EVENT", "type": { "text": "string" }, "default": "'igc-changed-theme'" }, { "kind": "variable", "name": "_themeChangedEmitter", "default": "new ThemeChangedEmitter()" } ], "exports": [ { "kind": "js", "name": "CHANGE_THEME_EVENT", "declaration": { "name": "CHANGE_THEME_EVENT", "module": "src/theming/theming-event.ts" } }, { "kind": "js", "name": "CHANGED_THEME_EVENT", "declaration": { "name": "CHANGED_THEME_EVENT", "module": "src/theming/theming-event.ts" } }, { "kind": "js", "name": "_themeChangedEmitter", "declaration": { "name": "_themeChangedEmitter", "module": "src/theming/theming-event.ts" } } ] }, { "kind": "javascript-module", "path": "src/theming/utils.ts", "declarations": [ { "kind": "function", "name": "getAllCssVariables", "return": { "type": { "text": "" } }, "description": "Retrieves all CSS custom properties from the document root element.\nProperty names are converted from kebab-case to camelCase." } ], "exports": [ { "kind": "js", "name": "getAllCssVariables", "declaration": { "name": "getAllCssVariables", "module": "src/theming/utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/theming/config.ts", "declarations": [ { "kind": "function", "name": "getTheme" }, { "kind": "function", "name": "setTheme", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "Theme" } }, { "name": "variant", "type": { "text": "ThemeVariant" } } ] }, { "kind": "function", "name": "configureTheme", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "t", "type": { "text": "Theme" } }, { "name": "v", "default": "'light'", "type": { "text": "ThemeVariant" } } ], "description": "Allows the global configuration of the active theme.\n\nUsage:\n ```ts\n import { configureTheme } from 'igniteui-webcomponents';\n\n configureTheme('material', 'light');\n ```" } ], "exports": [ { "kind": "js", "name": "getTheme", "declaration": { "name": "getTheme", "module": "src/theming/config.ts" } }, { "kind": "js", "name": "setTheme", "declaration": { "name": "setTheme", "module": "src/theming/config.ts" } }, { "kind": "js", "name": "configureTheme", "declaration": { "name": "configureTheme", "module": "src/theming/config.ts" } } ] }, { "kind": "javascript-module", "path": "src/theming/context.ts", "declarations": [ { "kind": "variable", "name": "themeContext", "description": "Context for providing theme information to descendant components.\n\nComponents can consume this context to receive theme information from a theme provider\ninstead of relying on global theming events." } ], "exports": [ { "kind": "js", "name": "themeContext", "declaration": { "name": "themeContext", "module": "src/theming/context.ts" } } ] }, { "kind": "javascript-module", "path": "src/theming/theming-controller.ts", "declarations": [ { "kind": "class", "description": "A reactive controller that manages theme adoption for a Lit host element.\n\nIt resolves the active theme from one of two sources, in order of priority:\n\n1. **Context** — provided by an ancestor `` element via the Lit context API.\n2. **Global** — the application-wide theme set via `configureTheme()`.\n\nWhen a context provider is present, the controller subscribes to its updates\nand stops listening to global theme change events. When the host element is\ndisconnected and reconnected outside a provider, it automatically falls back\nto the global theme.\n\nTheme styles are applied directly to the host's shadow root via `adoptStyles`\nevery time the active theme or variant changes.", "name": "ThemingController", "members": [ { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & ReactiveElement" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_themes", "type": { "text": "Themes" }, "privacy": "private", "readonly": true, "default": "themes" }, { "kind": "field", "name": "_options", "type": { "text": "ThemingControllerConfig | undefined" }, "privacy": "private", "readonly": true, "default": "config" }, { "kind": "field", "name": "_contextConsumer", "type": { "text": "ContextConsumer<\n typeof themeContext,\n ReactiveElement\n >" }, "privacy": "private", "readonly": true, "default": "new ContextConsumer(this._host, { context: themeContext, callback: (value) => { if (value) { this._applyContextTheme(value); } }, subscribe: true, })" }, { "kind": "field", "name": "_theme", "type": { "text": "Theme" }, "privacy": "private", "default": "'bootstrap'", "expandedType": { "text": "'material' | 'bootstrap' | 'indigo' | 'fluent'" } }, { "kind": "field", "name": "_variant", "type": { "text": "ThemeVariant" }, "privacy": "private", "default": "'light'", "expandedType": { "text": "'light' | 'dark'" } }, { "kind": "field", "name": "_themeSource", "type": { "text": "ThemeProviderSource" }, "privacy": "private", "default": "'uninitialized'", "expandedType": { "text": "'uninitialized' | 'context' | 'global'" } }, { "kind": "field", "name": "theme", "type": { "text": "Theme" }, "privacy": "public", "description": "Gets the current theme.", "readonly": true, "expandedType": { "text": "'material' | 'bootstrap' | 'indigo' | 'fluent'" } }, { "kind": "field", "name": "variant", "type": { "text": "ThemeVariant" }, "privacy": "public", "description": "Gets the current theme variant.", "readonly": true, "expandedType": { "text": "'light' | 'dark'" } }, { "kind": "method", "name": "_applyContextTheme", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "contextValue", "type": { "text": "{\n theme: Theme;\n variant: ThemeVariant;\n }" } } ] }, { "kind": "method", "name": "_applyGlobalTheme", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_applyTheme", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "theme", "type": { "text": "Theme" } }, { "name": "variant", "type": { "text": "ThemeVariant" } } ] }, { "kind": "method", "name": "_adoptStyles", "privacy": "private", "return": { "type": { "text": "void" } } } ] }, { "kind": "function", "name": "addThemingController", "return": { "type": { "text": "" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & ReactiveElement" }, "description": "The Lit element that will host the controller." }, { "name": "themes", "type": { "text": "Themes" }, "description": "The theme styles map containing `light` and `dark` variant entries,\neach keyed by theme name (`bootstrap`, `material`, `fluent`, `indigo`) and\nan optional `shared` entry applied regardless of theme." }, { "name": "config", "optional": true, "type": { "text": "ThemingControllerConfig" }, "description": "Optional configuration." }, { "description": "Callback invoked on the host whenever the active theme changes.", "name": "config.themeChange" } ], "description": "Creates and attaches a ThemingController to the given host element.\n\nThis is the preferred way to add theming support to a component. The controller\nis registered with the host's reactive controller lifecycle and automatically\nresolves the active theme from an ancestor `` context or\nfalls back to the application-wide theme set via `configureTheme()`." } ], "exports": [ { "kind": "js", "name": "addThemingController", "declaration": { "name": "addThemingController", "module": "src/theming/theming-controller.ts" } }, { "kind": "js", "name": "ThemingController", "declaration": { "name": "ThemingController", "module": "src/theming/theming-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/model.ts", "declarations": [ { "kind": "variable", "name": "DAYS_IN_WEEK", "type": { "text": "number" }, "default": "7" }, { "kind": "function", "name": "toCalendarDay", "return": { "type": { "text": "CalendarDay" } }, "parameters": [ { "name": "date", "type": { "text": "DayParameter" } } ] }, { "kind": "class", "description": "", "name": "CalendarDay", "members": [ { "kind": "field", "name": "_date", "type": { "text": "Date" }, "privacy": "private", "readonly": true, "default": "new Date(args.year, args.month, args.date ?? 1)" }, { "kind": "field", "name": "today", "type": { "text": "CalendarDay" }, "privacy": "public", "static": true, "description": "Constructs and returns the current day.", "readonly": true }, { "kind": "method", "name": "from", "privacy": "public", "static": true, "return": { "type": { "text": "CalendarDay" } }, "parameters": [ { "name": "date", "type": { "text": "Date" } } ], "description": "Constructs a new CalendarDay instance from a Date object." }, { "kind": "method", "name": "compare", "privacy": "public", "static": true, "return": { "type": { "text": "" } }, "parameters": [ { "name": "first", "type": { "text": "DayParameter" } }, { "name": "second", "type": { "text": "DayParameter" } } ], "description": "Compares the date portion of two date objects." }, { "kind": "method", "name": "clone", "privacy": "public", "return": { "type": { "text": "CalendarDay" } }, "description": "Returns a copy of this instance." }, { "kind": "method", "name": "set", "privacy": "public", "return": { "type": { "text": "CalendarDay" } }, "parameters": [ { "name": "args", "type": { "text": "Partial" } } ], "description": "Returns a new instance with values replaced." }, { "kind": "method", "name": "add", "privacy": "public", "return": { "type": { "text": "CalendarDay" } }, "parameters": [ { "name": "unit", "type": { "text": "DayInterval" } }, { "name": "value", "type": { "text": "number" } } ] }, { "kind": "field", "name": "day", "type": { "text": "number" }, "privacy": "public", "description": "Returns the day of the week (Sunday = 0).", "readonly": true }, { "kind": "field", "name": "year", "type": { "text": "number" }, "privacy": "public", "description": "Returns the full year.", "readonly": true }, { "kind": "field", "name": "month", "type": { "text": "number" }, "privacy": "public", "description": "Returns the month.", "readonly": true }, { "kind": "field", "name": "date", "type": { "text": "number" }, "privacy": "public", "description": "Returns the date", "readonly": true }, { "kind": "field", "name": "timestamp", "type": { "text": "number" }, "privacy": "public", "description": "Returns the timestamp since epoch in milliseconds.", "readonly": true }, { "kind": "field", "name": "week", "type": { "text": "number" }, "privacy": "public", "description": "Returns the ISO 8601 week number.", "readonly": true }, { "kind": "field", "name": "native", "type": { "text": "Date" }, "privacy": "public", "description": "Returns the underlying native date instance.", "readonly": true }, { "kind": "field", "name": "weekend", "type": { "text": "boolean" }, "privacy": "public", "description": "Whether the current date is a weekend day.", "readonly": true }, { "kind": "method", "name": "equalTo", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "DayParameter" } } ] }, { "kind": "method", "name": "greaterThan", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "DayParameter" } } ] }, { "kind": "method", "name": "greaterThanOrEqual", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "DayParameter" } } ] }, { "kind": "method", "name": "lessThan", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "DayParameter" } } ] }, { "kind": "method", "name": "lessThanOrEqual", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "DayParameter" } } ] }, { "kind": "method", "name": "toString", "privacy": "public", "return": { "type": { "text": "string" } } } ] } ], "exports": [ { "kind": "js", "name": "DAYS_IN_WEEK", "declaration": { "name": "DAYS_IN_WEEK", "module": "src/components/calendar/model.ts" } }, { "kind": "js", "name": "toCalendarDay", "declaration": { "name": "toCalendarDay", "module": "src/components/calendar/model.ts" } }, { "kind": "js", "name": "CalendarDay", "declaration": { "name": "CalendarDay", "module": "src/components/calendar/model.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/definitions/register.ts", "declarations": [ { "kind": "function", "name": "registerComponent", "parameters": [ { "name": "component", "type": { "text": "IgniteComponent" } }, { "name": "dependencies", "type": { "text": "IgniteComponent[]" } } ] } ], "exports": [ { "kind": "js", "name": "registerComponent", "declaration": { "name": "registerComponent", "module": "src/components/common/definitions/register.ts" } }, { "kind": "custom-element-definition", "declaration": { "name": "component", "module": "src/components/common/definitions/register.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/abort-handler.ts", "declarations": [ { "kind": "function", "name": "createAbortHandle", "return": { "type": { "text": "AbortHandle" } }, "description": "Creates and returns an `AbortHandle` object that wraps an AbortController,\nproviding a resettable AbortSignal. This allows you to use the signal for event\nlisteners, fetch requests, or other cancellable operations, and then\nreset the underlying AbortController to get a fresh signal without\nneeding to create a new wrapper object." } ], "exports": [ { "kind": "js", "name": "createAbortHandle", "declaration": { "name": "createAbortHandle", "module": "src/components/common/abort-handler.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/focus-ring.ts", "declarations": [ { "kind": "class", "description": "A controller class which determines whether a focus ring should be shown to indicate keyboard focus.\nFocus rings are visible only when the user is interacting with a keyboard, not with a mouse, touch, or other input methods.\n\nBy default the class attaches a keyup event handler on the component host and will update its keyboard focus\nstate based on it.\n\n**Important Note:** This controller is designed for use with **atomic web components** that represent single,\ninteractive elements (e.g., buttons, form fields, interactive icons). It helps these components correctly\ndisplay a focus indicator *only* when keyboard navigation is occurring, improving accessibility without\nvisual clutter during mouse or touch interactions.\n\n**Do not use this controller as a general-purpose shortcut for managing focus state in complex components or layouts.**\nMisusing it in this way can lead to incorrect focus ring behavior, accessibility issues, and make your\napplication harder to maintain. For managing focus within larger, composite components, consider alternative\nstrategies like ARIA attributes, managing `tabindex`, or a bespoke implementation if needed.", "name": "KeyboardFocusRingController", "members": [ { "kind": "field", "name": "_events", "privacy": "private", "static": true, "readonly": true, "default": "['keyup', 'focusout', 'pointerup']", "type": { "text": "['keyup', 'focusout', 'pointerup']" } }, { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & HTMLElement" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_abortHandle", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isKeyboardFocused", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "focused", "type": { "text": "boolean" }, "privacy": "public", "description": "Gets whether the current focus state is activated through a keyboard interaction.", "readonly": true } ] }, { "kind": "function", "name": "addKeyboardFocusRing", "return": { "type": { "text": "KeyboardFocusRingController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & HTMLElement" } } ], "description": "Adds a KeyboardFocusRingController responsible for managing keyboard focus state.\n\nThis utility function is intended for use with **atomic web components** that require\ndynamic focus ring visibility based on keyboard interaction." } ], "exports": [ { "kind": "js", "name": "KeyboardFocusRingController", "declaration": { "name": "KeyboardFocusRingController", "module": "src/components/common/controllers/focus-ring.ts" } }, { "kind": "js", "name": "addKeyboardFocusRing", "declaration": { "name": "addKeyboardFocusRing", "module": "src/components/common/controllers/focus-ring.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/constructor.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/common/decorators/blazorDeepImport.ts", "declarations": [ { "kind": "function", "name": "blazorDeepImport", "parameters": [ { "name": "_constructor", "type": { "text": "Constructor | AbstractConstructor" } } ], "description": "Indicates a class isn't imported at the root of the API, so needs to be referred to with a deep import in the wrappers." } ], "exports": [ { "kind": "js", "name": "blazorDeepImport", "declaration": { "name": "blazorDeepImport", "module": "src/components/common/decorators/blazorDeepImport.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/decorators/shadow-options.ts", "declarations": [ { "kind": "function", "name": "shadowOptions", "return": { "type": { "text": "(proto: unknown) => void" } }, "parameters": [ { "name": "options", "type": { "text": "Partial" } } ], "description": "TypeScript decorator that allows customizing the Shadow DOM options for a LitElement component.\n\nThis decorator merges the provided `options` with LitElement's default `shadowRootOptions`,\nproviding a convenient way to configure the Shadow DOM, such as its `mode` (e.g., 'open' or 'closed')\nor `delegatesFocus` property.\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow#options" } ], "exports": [ { "kind": "js", "name": "shadowOptions", "declaration": { "name": "shadowOptions", "module": "src/components/common/decorators/shadow-options.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/event-emitter.ts", "declarations": [ { "kind": "class", "description": "", "name": "EventEmitterInterface", "members": [ { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ] }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ] }, { "kind": "method", "name": "emitEvent", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ] } ] }, { "kind": "function", "name": "EventEmitterMixin", "return": { "type": { "text": "Constructor> & T" } }, "parameters": [ { "name": "superClass", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "", "name": "EventEmitterMixin", "members": [ { "kind": "method", "name": "addEventListener", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ] }, { "kind": "method", "name": "removeEventListener", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ] }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ] }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ] } ], "events": [ { "type": { "text": "CustomEvent" } } ], "parameters": [ { "name": "superClass", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "EventEmitterInterface", "declaration": { "name": "EventEmitterInterface", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "js", "name": "EventEmitterMixin", "declaration": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "js", "name": "EventEmitterMixin", "declaration": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/part-map.ts", "declarations": [ { "kind": "class", "description": "", "name": "PartMapDirective", "members": [ { "kind": "field", "name": "_previousParts", "type": { "text": "Set | undefined" }, "privacy": "private" } ], "superclass": { "name": "Directive", "package": "lit/directive.js" } }, { "kind": "variable", "name": "partMap", "description": "Similar to Lit's https://lit.dev/docs/templates/directives/#classmap | `classMap` and\nhttps://lit.dev/docs/templates/directives/#stylemap | `styleMap` but for `part` attributes." } ], "exports": [ { "kind": "js", "name": "partMap", "declaration": { "name": "partMap", "module": "src/components/common/part-map.ts" } }, { "kind": "js", "name": "PartMapDirective", "declaration": { "name": "PartMapDirective", "module": "src/components/common/part-map.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcButtonBaseComponent", "members": [ { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true" }, { "kind": "field", "name": "_internals", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_focusRingManager", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "_nativeButton", "type": { "text": "HTMLButtonElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'reset' | 'submit'" }, "privacy": "public", "default": "'button'", "description": "The type of the button. Defaults to `button`.", "attribute": "type", "reflects": true }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The URL the button points to.", "attribute": "href" }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Prompts to save the linked URL instead of navigating to it.", "attribute": "download" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "privacy": "public", "description": "Where to display the linked URL, as the name for a browsing context.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The relationship of the linked URL.\nSee https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types", "attribute": "rel" }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus in the button." }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a mouse click on the element" }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the button." }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "renderButton", "privacy": "private" }, { "kind": "method", "name": "renderLinkButton", "privacy": "private" }, { "kind": "method", "name": "renderContent", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "type", "type": { "text": "'button' | 'reset' | 'submit'" }, "default": "'button'", "description": "The type of the button. Defaults to `button`.", "fieldName": "type", "attribute": "type" }, { "name": "href", "type": { "text": "string | undefined" }, "description": "The URL the button points to.", "fieldName": "href", "attribute": "href" }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Prompts to save the linked URL instead of navigating to it.", "fieldName": "download", "attribute": "download" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Where to display the linked URL, as the name for a browsing context.", "fieldName": "target", "attribute": "target" }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL.\nSee https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types", "fieldName": "rel", "attribute": "rel" }, { "name": "disabled", "description": "The disabled state of the component", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common//mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IgcButtonBaseComponent", "declaration": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/button.ts", "declarations": [ { "kind": "class", "description": "Represents a clickable button, used to submit forms or anywhere in a\ndocument for accessible, standard button functionality.", "name": "IgcButtonComponent", "cssParts": [ { "description": "The native button element of the igc-button component.", "name": "base" }, { "description": "The prefix container of the igc-button component.", "name": "prefix" }, { "description": "The suffix container of the igc-button component.", "name": "suffix" } ], "slots": [ { "description": "Renders the label of the button.", "name": "" }, { "description": "Renders content before the label of the button.", "name": "prefix" }, { "description": "Renders content after the label of the button.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-button'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "variant", "type": { "text": "ButtonVariant" }, "privacy": "public", "default": "'contained'", "description": "Sets the variant of the button.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'contained' | 'flat' | 'outlined' | 'fab'" } }, { "kind": "method", "name": "renderContent", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_internals", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_focusRingManager", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_nativeButton", "type": { "text": "HTMLButtonElement" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'reset' | 'submit'" }, "privacy": "public", "default": "'button'", "description": "The type of the button. Defaults to `button`.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The URL the button points to.", "attribute": "href", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Prompts to save the linked URL instead of navigating to it.", "attribute": "download", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "privacy": "public", "description": "Where to display the linked URL, as the name for a browsing context.", "attribute": "target", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The relationship of the linked URL.\nSee https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types", "attribute": "rel", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus in the button.", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a mouse click on the element", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the button.", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "renderButton", "privacy": "private", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "renderLinkButton", "privacy": "private", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ], "attributes": [ { "name": "variant", "type": { "text": "ButtonVariant" }, "default": "'contained'", "description": "Sets the variant of the button.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'contained' | 'flat' | 'outlined' | 'fab'" } }, { "name": "type", "type": { "text": "'button' | 'reset' | 'submit'" }, "default": "'button'", "description": "The type of the button. Defaults to `button`.", "fieldName": "type", "attribute": "type", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "href", "type": { "text": "string | undefined" }, "description": "The URL the button points to.", "fieldName": "href", "attribute": "href", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Prompts to save the linked URL instead of navigating to it.", "fieldName": "download", "attribute": "download", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Where to display the linked URL, as the name for a browsing context.", "fieldName": "target", "attribute": "target", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL.\nSee https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types", "fieldName": "rel", "attribute": "rel", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ], "superclass": { "name": "IgcButtonBaseComponent", "module": "/src/components/button/button-base.js" }, "tagName": "igc-button", "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcButtonComponent", "module": "src/components/button/button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/slot.ts", "declarations": [ { "kind": "variable", "name": "DefaultSlot", "type": { "text": "string" }, "default": "'[default]'" }, { "kind": "class", "description": "", "name": "SlotController", "members": [ { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & LitElement" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_options", "type": { "text": "SlotControllerOptions" }, "privacy": "private", "readonly": true, "default": "{ ...options }" }, { "kind": "field", "name": "_slots", "type": { "text": "Set | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_initialized", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "method", "name": "_getSlot", "privacy": "private", "return": { "type": { "text": "HTMLSlotElement | null" } }, "parameters": [ { "name": "slotName", "optional": true, "type": { "text": "T" } } ] }, { "kind": "method", "name": "getAssignedNodes", "privacy": "public", "return": { "type": { "text": "Node[]" } }, "parameters": [ { "name": "slot", "type": { "text": "T" } }, { "name": "flatten", "default": "false" } ], "description": "Returns an array of the assigned nodes for `slot`.\n\nIf `flatten` is set to `true`, it returns a sequence of both the nodes assigned to the queried slot,\nas well as nodes assigned to any other slots that are descendants of this slot. If no\nassigned nodes are found, it returns the slot's fallback content." }, { "kind": "method", "name": "getAssignedElements", "privacy": "public", "return": { "type": { "text": "U[]" } }, "parameters": [ { "name": "slot", "type": { "text": "T" } }, { "name": "options", "optional": true, "type": { "text": "SlotQueryOptions" } } ], "description": "Returns an array of the assigned elements for `slot` with additional `options`.\n\nSee SlotQueryOptions.flatten and SlotQueryOptions.selector for more information." }, { "kind": "method", "name": "hasAssignedNodes", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "slot", "type": { "text": "T" } }, { "name": "flatten", "default": "false" } ], "description": "Return whether `slot` has assigned nodes.\n\nIf `flatten` is set to `true`, it returns a sequence of both the nodes assigned to the queried slot,\nas well as nodes assigned to any other slots that are descendants of this slot. If no\nassigned nodes are found, it returns the slot's fallback content." }, { "kind": "method", "name": "hasAssignedElements", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "slot", "type": { "text": "T" } }, { "name": "options", "optional": true, "type": { "text": "SlotQueryOptions" } } ], "description": "Return whether `slot` has assigned elements accepting additional `options`.\n\nSee SlotQueryOptions.flatten and SlotQueryOptions.selector for more information." } ] }, { "kind": "function", "name": "addSlotController", "return": { "type": { "text": "SlotController>" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost" } }, { "name": "options", "optional": true, "type": { "text": "SlotControllerOptions> & {\n slots?: K;\n }" } } ] }, { "kind": "function", "name": "setSlots", "parameters": [ { "name": "slots", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "addSlotController", "declaration": { "name": "addSlotController", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "DefaultSlot", "declaration": { "name": "DefaultSlot", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "setSlots", "declaration": { "name": "setSlots", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "InferSlotNames", "declaration": { "name": "InferSlotNames", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "SlotController", "declaration": { "name": "SlotController", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "SlotQueryOptions", "declaration": { "name": "SlotQueryOptions", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "SlotChangeCallback", "declaration": { "name": "SlotChangeCallback", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "SlotChangeCallbackParameters", "declaration": { "name": "SlotChangeCallbackParameters", "module": "src/components/common/controllers/slot.ts" } }, { "kind": "js", "name": "SlotControllerOptions", "declaration": { "name": "SlotControllerOptions", "module": "src/components/common/controllers/slot.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/i18n/EN/calendar.resources.ts", "declarations": [ { "kind": "variable", "name": "IgcCalendarResourceStringEN", "type": { "text": "IgcCalendarResourceStrings" }, "default": "{ ...convertToIgcResource(CalendarResourceStringsEN), ...{ weekLabel: 'Wk' }, }" } ], "exports": [ { "kind": "js", "name": "IgcCalendarResourceStringEN", "declaration": { "name": "IgcCalendarResourceStringEN", "module": "src/components/common/i18n/EN/calendar.resources.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/i18n/EN/date-range-picker.resources.ts", "declarations": [ { "kind": "variable", "name": "IgcDateRangePickerResourceStringsEN", "type": { "text": "IgcDateRangePickerResourceStrings" }, "default": "{ ...convertToIgcResource(DateRangePickerResourceStringsEN), ...IgcCalendarResourceStringEN, }" } ], "exports": [ { "kind": "js", "name": "IgcDateRangePickerResourceStringsEN", "declaration": { "name": "IgcDateRangePickerResourceStringsEN", "module": "src/components/common/i18n/EN/date-range-picker.resources.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/i18n/utils.ts", "declarations": [ { "kind": "variable", "name": "calendarResourcesMap", "default": "new Map< keyof IgcCalendarResourceStrings, string | undefined >([ ['selectMonth', 'calendar_select_month'], ['selectYear', 'calendar_select_year'], ['selectDate', 'calendar_select_date'], ['selectRange', 'calendar_range_placeholder'], ['selectedDate', undefined], // This one seems not to be in use anyway ['startDate', 'calendar_range_label_start'], ['endDate', 'calendar_range_label_end'], ['previousMonth', 'calendar_previous_month'], ['nextMonth', 'calendar_next_month'], ['previousYear', 'calendar_previous_year'], ['nextYear', 'calendar_next_year'], ['previousYears', 'calendar_previous_years'], ['nextYears', 'calendar_next_years'], ['weekLabel', 'i18n/getWeekLabel'], ])" }, { "kind": "variable", "name": "dateRangePickerResourcesMap", "default": "new Map< keyof IgcDateRangePickerResourceStrings, string | undefined >([ ['separator', 'date_range_picker_date_separator'], ['done', 'date_range_picker_done_button'], ['cancel', 'date_range_picker_cancel_button'], ['last7Days', 'date_range_picker_last7Days'], ['last30Days', 'date_range_picker_last30Days'], ['currentMonth', 'date_range_picker_currentMonth'], ['yearToDate', 'date_range_picker_yearToDate'], ...( calendarResourcesMap as Map< keyof IgcDateRangePickerResourceStrings, string | undefined > ).entries(), ])" }, { "kind": "function", "name": "convertToIgcResource", "return": { "type": { "text": "T" } }, "parameters": [ { "name": "resource", "type": { "text": "IResourceStrings" } } ] }, { "kind": "function", "name": "convertToCoreResource", "return": { "type": { "text": "IResourceStrings" } }, "parameters": [ { "name": "resource", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "calendarResourcesMap", "declaration": { "name": "calendarResourcesMap", "module": "src/components/common/i18n/utils.ts" } }, { "kind": "js", "name": "dateRangePickerResourcesMap", "declaration": { "name": "dateRangePickerResourcesMap", "module": "src/components/common/i18n/utils.ts" } }, { "kind": "js", "name": "convertToIgcResource", "declaration": { "name": "convertToIgcResource", "module": "src/components/common/i18n/utils.ts" } }, { "kind": "js", "name": "convertToCoreResource", "declaration": { "name": "convertToCoreResource", "module": "src/components/common/i18n/utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/i18n/i18n-controller.ts", "declarations": [ { "kind": "class", "description": "Manages localization (i18n) for a Lit web component.\nIt handles the current locale, component-specific resource overrides,\nand updates when the global localization state changes.", "name": "I18nController", "members": [ { "kind": "field", "name": "_host", "type": { "text": "I18nControllerHost" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_defaultEN", "type": { "text": "T" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_resourceChangeCallback", "type": { "text": "ResourceChangeCallback | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_defaultResourceStrings", "type": { "text": "T" }, "privacy": "private" }, { "kind": "field", "name": "_locale", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_resourceStrings", "type": { "text": "T | undefined" }, "privacy": "private" }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets the resolved locale for the host component.\nThis is the component's custom locale if set, otherwise it falls back to the\nglobal locale.", "type": { "text": "string" } }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "Get resolved resource strings for component", "type": { "text": "T" } }, { "kind": "method", "name": "_registerResources", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "resource", "type": { "text": "T" } } ], "description": "Registers the default English resources with the global i18n manager." }, { "kind": "method", "name": "_getResourceMapForComponent", "privacy": "private", "return": { "type": { "text": "| Map\n | undefined" } }, "description": "Helper to find the correct resource map based on the component's default resources (`#defaultEN`).\nThis relies on structural checking (the component's key names)." }, { "kind": "method", "name": "_getCurrentResourceStrings", "privacy": "private", "return": { "type": { "text": "T" } }, "description": "Gets the current, locale-specific resource strings for the component.\nThe logic maps component keys (from defaultEN) to core library keys\nand retrieves the localized string from the i18n manager.\n\nResult is truncated, containing only relevant locale strings." } ] }, { "kind": "function", "name": "getDefaultDateTimeFormat", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "locale", "type": { "text": "string" } } ], "description": "Returns the default date-time input format for a given locale" }, { "kind": "function", "name": "getDateTimeFormat", "return": { "type": { "text": "string | undefined" } }, "parameters": [ { "name": "format", "optional": true, "type": { "text": "string" } }, { "name": "suffix", "default": "'Date'", "type": { "text": "'Date' | 'Time'" } } ], "description": "Returns the date-time format string with the appropriate suffix if it's a predefined style" }, { "kind": "function", "name": "formatDisplayDate", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "Date" } }, { "name": "locale", "type": { "text": "string" } }, { "name": "displayFormat", "optional": true, "type": { "text": "string" } } ], "description": "Formats a date for display using the specified format." }, { "kind": "function", "name": "addI18nController", "return": { "type": { "text": "I18nController" } }, "parameters": [ { "name": "host", "type": { "text": "I18nControllerHost" } }, { "name": "config", "type": { "text": "I18nControllerConfig" } } ], "description": "Factory function to create and attach the I18nController to a host." } ], "exports": [ { "kind": "js", "name": "getDefaultDateTimeFormat", "declaration": { "name": "getDefaultDateTimeFormat", "module": "src/components/common/i18n/i18n-controller.ts" } }, { "kind": "js", "name": "getDateTimeFormat", "declaration": { "name": "getDateTimeFormat", "module": "src/components/common/i18n/i18n-controller.ts" } }, { "kind": "js", "name": "formatDisplayDate", "declaration": { "name": "formatDisplayDate", "module": "src/components/common/i18n/i18n-controller.ts" } }, { "kind": "js", "name": "addI18nController", "declaration": { "name": "addI18nController", "module": "src/components/common/i18n/i18n-controller.ts" } }, { "kind": "js", "name": "I18nController", "declaration": { "name": "I18nController", "module": "src/components/common/i18n/i18n-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/key-bindings.ts", "declarations": [ { "kind": "variable", "name": "arrowLeft", "type": { "text": "'ArrowLeft'" }, "default": "'ArrowLeft'" }, { "kind": "variable", "name": "arrowRight", "type": { "text": "'ArrowRight'" }, "default": "'ArrowRight'" }, { "kind": "variable", "name": "arrowUp", "type": { "text": "'ArrowUp'" }, "default": "'ArrowUp'" }, { "kind": "variable", "name": "arrowDown", "type": { "text": "'ArrowDown'" }, "default": "'ArrowDown'" }, { "kind": "variable", "name": "enterKey", "type": { "text": "'Enter'" }, "default": "'Enter'" }, { "kind": "variable", "name": "spaceBar", "type": { "text": "' '" }, "default": "' '" }, { "kind": "variable", "name": "escapeKey", "type": { "text": "'Escape'" }, "default": "'Escape'" }, { "kind": "variable", "name": "homeKey", "type": { "text": "'Home'" }, "default": "'Home'" }, { "kind": "variable", "name": "endKey", "type": { "text": "'End'" }, "default": "'End'" }, { "kind": "variable", "name": "pageUpKey", "type": { "text": "'PageUp'" }, "default": "'PageUp'" }, { "kind": "variable", "name": "pageDownKey", "type": { "text": "'PageDown'" }, "default": "'PageDown'" }, { "kind": "variable", "name": "tabKey", "type": { "text": "'Tab'" }, "default": "'Tab'" }, { "kind": "variable", "name": "altKey", "type": { "text": "'Alt'" }, "default": "'Alt'" }, { "kind": "variable", "name": "ctrlKey", "type": { "text": "'Ctrl'" }, "default": "'Ctrl'" }, { "kind": "variable", "name": "metaKey", "type": { "text": "'Meta'" }, "default": "'Meta'" }, { "kind": "variable", "name": "shiftKey", "type": { "text": "'Shift'" }, "default": "'Shift'" }, { "kind": "class", "description": "", "name": "KeyBindingController", "members": [ { "kind": "field", "name": "_defaultOptions", "type": { "text": "KeyBindingControllerOptions" }, "privacy": "private", "static": true, "readonly": true, "default": "{ skip: ['input', 'textarea', 'select'], bindingDefaults: { preventDefault: true }, }" }, { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & Element" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_ref", "type": { "text": "Ref | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_abortHandle", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_bindings", "privacy": "private", "readonly": true, "default": "new Map()" }, { "kind": "field", "name": "_allowedKeys", "privacy": "private", "readonly": true, "default": "new Set()" }, { "kind": "field", "name": "_pressedKeys", "privacy": "private", "readonly": true, "default": "new Set()" }, { "kind": "field", "name": "_options", "type": { "text": "KeyBindingControllerOptions" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_skipSelector", "type": { "text": "string | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_observedElement", "type": { "text": "Element | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_element", "type": { "text": "Element" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "_applyEventModifiers", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "binding", "type": { "text": "KeyBinding" } }, { "name": "event", "type": { "text": "KeyboardEvent" } } ], "description": "Checks and executes any event modifiers that are present in the matched binding." }, { "kind": "method", "name": "_bindingMatches", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "binding", "type": { "text": "KeyBinding" } }, { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_shouldSkip", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "set", "privacy": "public", "parameters": [ { "name": "key", "type": { "text": "string | string[]" } }, { "name": "handler", "type": { "text": "KeyBindingHandler" } }, { "name": "bindingOptions", "optional": true, "type": { "text": "KeyBindingOptions" } } ], "description": "Registers a keybinding handler." }, { "kind": "method", "name": "setActivateHandler", "privacy": "public", "parameters": [ { "name": "handler", "type": { "text": "KeyBindingHandler" } }, { "name": "options", "optional": true, "type": { "text": "KeyBindingOptions" } } ], "description": "Register a handler function which is called when the target receives a key\nwhich \"activates\" it.\n\nIn the browser context this is usually either an Enter and Space bar keypress." }, { "kind": "method", "name": "observeElement", "privacy": "public", "return": { "type": { "text": "KeyBindingObserverCleanup" } }, "parameters": [ { "name": "element", "type": { "text": "Element" } } ], "description": "Sets the controller to listen for keyboard events on an arbitrary `element` in the page context.\nAll the configuration and event handlers are applied as well.\n\nReturns an object with an `unsubscribe` function which should be called when the observing of keyboard\nevents on the `element` should cease." } ] }, { "kind": "function", "name": "addKeybindings", "return": { "type": { "text": "KeyBindingController" } }, "parameters": [ { "name": "element", "type": { "text": "ReactiveControllerHost & Element" } }, { "name": "options", "optional": true, "type": { "text": "KeyBindingControllerOptions" } } ], "description": "Creates a keybinding controller and adds to it to the passed `element`\nwith the provided `options`." } ], "exports": [ { "kind": "js", "name": "arrowLeft", "declaration": { "name": "arrowLeft", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "arrowRight", "declaration": { "name": "arrowRight", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "arrowUp", "declaration": { "name": "arrowUp", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "arrowDown", "declaration": { "name": "arrowDown", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "enterKey", "declaration": { "name": "enterKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "spaceBar", "declaration": { "name": "spaceBar", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "escapeKey", "declaration": { "name": "escapeKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "homeKey", "declaration": { "name": "homeKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "endKey", "declaration": { "name": "endKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "pageUpKey", "declaration": { "name": "pageUpKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "pageDownKey", "declaration": { "name": "pageDownKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "tabKey", "declaration": { "name": "tabKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "altKey", "declaration": { "name": "altKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "ctrlKey", "declaration": { "name": "ctrlKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "metaKey", "declaration": { "name": "metaKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "shiftKey", "declaration": { "name": "shiftKey", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "addKeybindings", "declaration": { "name": "addKeybindings", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "KeyBindingHandler", "declaration": { "name": "KeyBindingHandler", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "KeyBindingObserverCleanup", "declaration": { "name": "KeyBindingObserverCleanup", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "KeyBindingSkipCallback", "declaration": { "name": "KeyBindingSkipCallback", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "KeyBindingTrigger", "declaration": { "name": "KeyBindingTrigger", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "KeyBindingOptions", "declaration": { "name": "KeyBindingOptions", "module": "src/components/common/controllers/key-bindings.ts" } }, { "kind": "js", "name": "KeyBindingController", "declaration": { "name": "KeyBindingController", "module": "src/components/common/controllers/key-bindings.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/decorators/blazorInclude.ts", "declarations": [ { "kind": "function", "name": "blazorInclude", "description": "Indicates a member should be included in the Blazor API even if non-public.", "return": { "type": { "text": "" } } } ], "exports": [ { "kind": "js", "name": "blazorInclude", "declaration": { "name": "blazorInclude", "module": "src/components/common/decorators/blazorInclude.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/registry/default-map.ts", "declarations": [ { "kind": "class", "description": "A Map that automatically creates default values for missing keys.", "name": "DefaultMap", "members": [ { "kind": "field", "name": "_factoryFn", "type": { "text": "() => V" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "[Symbol.toStringTag]", "type": { "text": "string" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "getOrCreate", "privacy": "public", "return": { "type": { "text": "" } }, "parameters": [ { "name": "key", "type": { "text": "K" }, "description": "The key to look up or create a value for." } ], "description": "Returns the value for the given key, creating it if it doesn't exist." }, { "kind": "method", "name": "toPlainMap", "privacy": "public", "return": { "type": { "text": "" } }, "description": "Converts the DefaultMap to a plain Map for structured cloning." } ], "superclass": { "name": "Map", "module": "src/components/icon/registry/default-map.ts" } }, { "kind": "function", "name": "createDefaultMap", "return": { "type": { "text": "" } }, "parameters": [ { "name": "entries", "optional": true, "type": { "text": "Iterable" }, "description": "Optional iterable of key-value pairs to initialize the map." }, { "name": "factoryFn", "optional": true, "type": { "text": "() => V" }, "description": "Factory function that creates default values for missing keys." } ], "description": "Creates a new DefaultMap with the specified entries and factory function." }, { "kind": "function", "name": "createIconDefaultMap", "description": "Creates a DefaultMap for icon collections with nested Map values.", "return": { "type": { "text": "" } } } ], "exports": [ { "kind": "js", "name": "createDefaultMap", "declaration": { "name": "createDefaultMap", "module": "src/components/icon/registry/default-map.ts" } }, { "kind": "js", "name": "createIconDefaultMap", "declaration": { "name": "createIconDefaultMap", "module": "src/components/icon/registry/default-map.ts" } }, { "kind": "js", "name": "DefaultMap", "declaration": { "name": "DefaultMap", "module": "src/components/icon/registry/default-map.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/registry/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/icon/icon-references.ts", "declarations": [ { "kind": "variable", "name": "ICON_REFERENCES", "type": { "text": "IconReference[]" }, "default": "[]" } ], "exports": [ { "kind": "js", "name": "ICON_REFERENCES", "declaration": { "name": "ICON_REFERENCES", "module": "src/components/icon/icon-references.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon-state.broadcast.ts", "declarations": [ { "kind": "class", "description": "Manages cross-context synchronization of icon state using the BroadcastChannel API.", "name": "IconsStateBroadcast", "members": [ { "kind": "field", "name": "_origin", "type": { "text": "string" }, "privacy": "private", "static": true, "readonly": true, "default": "'igniteui-webcomponents'" }, { "kind": "field", "name": "_iconsCollection", "type": { "text": "IconsCollection" }, "privacy": "private", "readonly": true, "default": "iconsCollection" }, { "kind": "field", "name": "_iconReferences", "type": { "text": "IconsCollection" }, "privacy": "private", "readonly": true, "default": "iconReferences" }, { "kind": "field", "name": "_channel", "type": { "text": "BroadcastChannel | null" }, "privacy": "private", "default": "null" }, { "kind": "method", "name": "send", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "data", "type": { "text": "BroadcastIconsChangeMessage" } } ], "description": "Sends a message to other browsing contexts via the broadcast channel." }, { "kind": "method", "name": "_syncState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{\n data: { actionType, origin },\n }", "type": { "text": "MessageEvent" } } ] }, { "kind": "method", "name": "_create", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_dispose", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getUserRefsCollection", "privacy": "private", "return": { "type": { "text": "IconsCollection" } }, "parameters": [ { "name": "collections", "type": { "text": "IconsCollection" } } ] }, { "kind": "method", "name": "_getUserSetCollection", "privacy": "private", "return": { "type": { "text": "IconsCollection" } }, "parameters": [ { "name": "collections", "type": { "text": "IconsCollection" } } ] } ] } ], "exports": [ { "kind": "js", "name": "IconsStateBroadcast", "declaration": { "name": "IconsStateBroadcast", "module": "src/components/icon/icon-state.broadcast.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/internal-icons-lib.ts", "declarations": [ { "kind": "variable", "name": "internalIcons", "default": "new Map( Object.entries({ attach_file: { svg: ``, }, auto_suggest: { svg: ``, }, navigate_before: { svg: ``, }, navigate_next: { svg: ``, }, keyboard_arrow_up: { svg: ``, }, keyboard_arrow_down: { svg: ``, }, keyboard_arrow_right: { svg: ``, }, keyboard_arrow_left: { svg: ``, }, send: { svg: ``, }, close: { svg: ``, }, copy: { svg: ``, }, chip_cancel: { svg: ``, }, chip_select: { svg: ``, }, document_empty: { svg: ``, }, document_filled: { svg: ``, }, document_image: { svg: ``, }, image: { svg: ``, }, table: { svg: ``, }, layout: { svg: ``, }, code_circle: { svg: ``, }, file_generic: { svg: ``, }, file_css: { svg: ``, }, file_csv: { svg: ``, }, file_doc: { svg: ``, }, file_htm: { svg: ``, }, file_html: { svg: ``, }, file_js: { svg: ``, }, file_json: { svg: ``, }, file_link: { svg: ``, }, file_pdf: { svg: ``, }, file_rtf: { svg: ``, }, file_svg: { svg: ``, }, file_txt: { svg: ``, }, file_xls: { svg: ``, }, file_xml: { svg: ``, }, file_zip: { svg: ``, }, more_horiz: { svg: ``, }, open_in_new: { svg: ``, }, star: { svg: ``, }, star_border: { svg: ``, }, thumb_up_empty: { svg: ``, }, thumb_up_filled: { svg: ``, }, thumb_down_empty: { svg: ``, }, thumb_down_filled: { svg: ``, }, reload: { svg: ``, }, case_sensitive: { svg: ``, }, clear: { svg: ``, }, arrow_drop_up: { svg: ``, }, arrow_drop_down: { svg: ``, }, arrow_back: { svg: ``, }, arrow_forward: { svg: ``, }, arrow_downward: { svg: ``, }, arrow_upward: { svg: ``, }, calendar: { svg: ``, }, calendar_today: { svg: ``, }, expand_content: { svg: ``, }, indigo_expand_content: { svg: ` `, }, collapse_content: { svg: ``, }, indigo_collapse_content: { svg: ` `, }, fullscreen: { svg: ``, }, indigo_fullscreen: { svg: ` `, }, fullscreen_exit: { svg: ``, }, indigo_fullscreen_exit: { svg: ` `, }, resize: { svg: ``, }, indigo_clear: { svg: ` `, }, indigo_unfold_more: { svg: ` `, }, indigo_unfold_less: { svg: ` `, }, indigo_arrow_forward: { svg: ` `, }, indigo_arrow_back: { svg: ` `, }, indigo_arrow_downward: { svg: ` `, }, indigo_arrow_upward: { svg: ` `, }, indigo_chevron_down: { svg: ` `, }, indigo_chevron_up: { svg: ` `, }, indigo_chevron_right: { svg: ` `, }, indigo_chevron_left: { svg: ` `, }, indigo_check: { svg: ` `, }, error: { svg: ``, }, indigo_access_time: { svg: ``, }, indigo_add: { svg: ``, }, indigo_attach_file: { svg: ``, }, indigo_block: { svg: ``, }, indigo_calendar_today: { svg: ``, }, indigo_cancel: { svg: ``, }, indigo_check_circle: { svg: ``, }, indigo_error: { svg: ``, }, indigo_file_download: { svg: ``, }, indigo_file_upload: { svg: ``, }, indigo_filter_list: { svg: ``, }, indigo_horizontal_rule: { svg: ``, }, indigo_info: { svg: ``, }, indigo_menu: { svg: ``, }, indigo_pin: { svg: ``, }, indigo_refresh: { svg: ``, }, indigo_search: { svg: ``, }, indigo_send: { svg: ``, }, indigo_unpin: { svg: ``, }, }) )" } ], "exports": [ { "kind": "js", "name": "internalIcons", "declaration": { "name": "internalIcons", "module": "src/components/icon/internal-icons-lib.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/registry/parser.ts", "declarations": [ { "kind": "class", "description": "", "name": "SvgIconParser", "members": [ { "kind": "field", "name": "_parser", "type": { "text": "DOMParser" }, "privacy": "private", "default": "new DOMParser()" }, { "kind": "method", "name": "parse", "privacy": "public", "return": { "type": { "text": "SvgIcon" } }, "parameters": [ { "name": "svgString", "type": { "text": "string" } } ] } ] } ], "exports": [ { "kind": "js", "name": "SvgIconParser", "declaration": { "name": "SvgIconParser", "module": "src/components/icon/registry/parser.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.registry.ts", "declarations": [ { "kind": "function", "name": "getIconRegistry", "description": "Gets the global icon registry singleton instance.", "return": { "type": { "text": "" } } }, { "kind": "function", "name": "registerIcon", "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "The unique name for the icon" }, { "name": "url", "type": { "text": "string" }, "description": "The URL to fetch the SVG icon from" }, { "name": "collection", "default": "'default'", "description": "The collection to register the icon in (default: 'default')" } ], "description": "Registers an icon by fetching it from a URL.", "return": { "type": { "text": "" } } }, { "kind": "function", "name": "registerIconFromText", "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "The unique name for the icon" }, { "name": "iconText", "type": { "text": "string" }, "description": "The SVG markup as a string" }, { "name": "collection", "default": "'default'", "description": "The collection to register the icon in (default: 'default')" } ], "description": "Registers an icon from SVG text content." }, { "kind": "function", "name": "setIconRef", "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "The alias name" }, { "name": "collection", "type": { "text": "string" }, "description": "The collection for the alias" }, { "name": "icon", "type": { "text": "IconMeta" }, "description": "The target icon metadata (name and collection)" } ], "description": "Sets an icon reference/alias that points to another icon." } ], "exports": [ { "kind": "js", "name": "getIconRegistry", "declaration": { "name": "getIconRegistry", "module": "src/components/icon/icon.registry.ts" } }, { "kind": "js", "name": "registerIcon", "declaration": { "name": "registerIcon", "module": "src/components/icon/icon.registry.ts" } }, { "kind": "js", "name": "registerIconFromText", "declaration": { "name": "registerIconFromText", "module": "src/components/icon/icon.registry.ts" } }, { "kind": "js", "name": "setIconRef", "declaration": { "name": "setIconRef", "module": "src/components/icon/icon.registry.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/icon/icon.ts", "declarations": [ { "kind": "class", "description": "The icon component allows visualizing collections of pre-registered SVG icons.", "name": "IgcIconComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-icon'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_theming", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_boundIconLoaded", "type": { "text": "IconCallback | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_svg", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The name of the icon glyph to draw.", "attribute": "name" }, { "kind": "field", "name": "collection", "type": { "text": "string" }, "privacy": "public", "default": "'default'", "description": "The name of the registered collection for look up of icons.", "attribute": "collection" }, { "kind": "field", "name": "mirrored", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to flip the icon horizontally. Useful for RTL (right-to-left) layouts.", "attribute": "mirrored", "reflects": true }, { "kind": "method", "name": "_iconLoaded", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "The name of the registered icon" }, { "name": "collection", "type": { "text": "string" }, "description": "The collection of the registered icon" } ], "description": "Callback invoked when an icon is registered or updated in the registry.\nRe-fetches the icon if it matches this component's name and collection." }, { "kind": "method", "name": "_getIcon", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Fetches and updates the icon from the registry." }, { "kind": "method", "name": "registerIcon", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "url", "type": { "text": "string" } }, { "name": "collection", "default": "'default'" } ] }, { "kind": "method", "name": "registerIconFromText", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "iconText", "type": { "text": "string" } }, { "name": "collection", "default": "'default'" } ] }, { "kind": "method", "name": "setIconRef", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "collection", "type": { "text": "string" } }, { "name": "icon", "type": { "text": "IconMeta" } } ] } ], "attributes": [ { "name": "name", "type": { "text": "string" }, "default": "''", "description": "The name of the icon glyph to draw.", "fieldName": "name", "attribute": "name" }, { "name": "collection", "type": { "text": "string" }, "default": "'default'", "description": "The name of the registered collection for look up of icons.", "fieldName": "collection", "attribute": "collection" }, { "name": "mirrored", "type": { "text": "boolean" }, "default": "false", "description": "Whether to flip the icon horizontally. Useful for RTL (right-to-left) layouts.", "fieldName": "mirrored", "attribute": "mirrored" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-icon", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcIconComponent", "module": "src/components/icon/icon.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/decorators/blazorIndirectRender.ts", "declarations": [ { "kind": "function", "name": "blazorIndirectRender", "parameters": [ { "name": "_constructor", "type": { "text": "Constructor | AbstractConstructor" } } ], "description": "Indicates a class should use the indirect renderer in Blazor." } ], "exports": [ { "kind": "js", "name": "blazorIndirectRender", "declaration": { "name": "blazorIndirectRender", "module": "src/components/common/decorators/blazorIndirectRender.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/calendar/base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcCalendarBaseComponent", "members": [ { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_initialActiveDateSet", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_hasValues", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_isSingle", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_isMultiple", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_isRange", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_rangePreviewDate", "type": { "text": "CalendarDay | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "_firstDayOfWeek", "type": { "text": "number" }, "privacy": "protected", "default": "0" }, { "kind": "field", "name": "_activeDate", "privacy": "protected" }, { "kind": "field", "name": "_value", "type": { "text": "CalendarDay | null" }, "privacy": "protected", "default": "null" }, { "kind": "field", "name": "_values", "type": { "text": "CalendarDay[]" }, "privacy": "protected", "default": "[]" }, { "kind": "field", "name": "_specialDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "protected", "default": "[]" }, { "kind": "field", "name": "_disabledDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "protected", "default": "[]" }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the calendar.\nUsed when selection is set to single", "attribute": "value", "type": { "text": "Date | null" } }, { "kind": "field", "name": "values", "privacy": "public", "description": "The current values of the calendar.\nUsed when selection is set to multiple of range.", "attribute": "values", "type": { "text": "Date[]" } }, { "kind": "field", "name": "activeDate", "privacy": "public", "description": "Get/Set the date which is shown in view and is highlighted. By default it is the current date.", "type": { "text": "Date" }, "attribute": "active-date" }, { "kind": "field", "name": "selection", "type": { "text": "CalendarSelection" }, "privacy": "public", "default": "'single'", "description": "Sets the type of selection in the component.", "attribute": "selection", "expandedType": { "text": "'single' | 'multiple' | 'range'" } }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show the week numbers.", "attribute": "show-week-numbers", "reflects": true }, { "kind": "field", "name": "weekStart", "type": { "text": "WeekDays" }, "privacy": "public", "default": "'sunday'", "description": "Gets/Sets the first day of the week.", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for formatting and displaying the dates in the component.", "attribute": "locale" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.", "type": { "text": "IgcCalendarResourceStrings" } }, { "kind": "field", "name": "specialDates", "privacy": "public", "description": "Gets/Sets the special dates for the component.", "type": { "text": "DateRangeDescriptor[] | undefined" } }, { "kind": "field", "name": "disabledDates", "privacy": "public", "description": "Gets/Sets the disabled dates for the component.", "type": { "text": "DateRangeDescriptor[] | undefined" } } ], "attributes": [ { "name": "value", "description": "The current value of the calendar.\nUsed when selection is set to single", "fieldName": "value", "attribute": "value", "type": { "text": "Date | null" } }, { "name": "values", "description": "The current values of the calendar.\nUsed when selection is set to multiple of range.", "fieldName": "values", "attribute": "values", "type": { "text": "Date[]" } }, { "name": "selection", "type": { "text": "CalendarSelection" }, "default": "'single'", "description": "Sets the type of selection in the component.", "fieldName": "selection", "attribute": "selection", "expandedType": { "text": "'single' | 'multiple' | 'range'" } }, { "name": "show-week-numbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the week numbers.", "fieldName": "showWeekNumbers", "attribute": "show-week-numbers" }, { "name": "week-start", "type": { "text": "WeekDays" }, "default": "'sunday'", "description": "Gets/Sets the first day of the week.", "fieldName": "weekStart", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" } }, { "name": "locale", "description": "Gets/Sets the locale used for formatting and displaying the dates in the component.", "fieldName": "locale", "attribute": "locale" }, { "name": "active-date", "description": "Get/Set the date which is shown in view and is highlighted. By default it is the current date.", "type": { "text": "Date" }, "fieldName": "activeDate" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "IgcCalendarBaseComponent", "declaration": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/decorators/blazorSuppressComponent.ts", "declarations": [ { "kind": "function", "name": "blazorSuppressComponent", "parameters": [ { "name": "_constructor", "type": { "text": "Constructor | AbstractConstructor" } } ], "description": "Indicates a class should not be exposed to blazor Blazor." } ], "exports": [ { "kind": "js", "name": "blazorSuppressComponent", "declaration": { "name": "blazorSuppressComponent", "module": "src/components/common/decorators/blazorSuppressComponent.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/days-view/days-view.ts", "declarations": [ { "kind": "class", "description": "Instantiate a days view as a separate component in the calendar.", "name": "IgcDaysViewComponent", "cssParts": [ { "description": "The days row container.", "name": "days-row" }, { "description": "The label container.", "name": "label" }, { "description": "The inner label container.", "name": "label-inner" }, { "description": "The week number container.", "name": "week-number" }, { "description": "The inner week number container.", "name": "week-number-inner" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-days-view'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_dates", "type": { "text": "CalendarDay[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_activeDay", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_rangeStart", "type": { "text": "CalendarDay | undefined" }, "privacy": "private", "description": "Returns the first date in the current range selection.", "readonly": true }, { "kind": "field", "name": "_rangeEnd", "type": { "text": "CalendarDay | undefined" }, "privacy": "private", "description": "Returns the last date in the current range selection.", "readonly": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The active state of the component.", "attribute": "active" }, { "kind": "field", "name": "hideLeadingDays", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show leading days which do not belong to the current month.", "attribute": "hide-leading-days" }, { "kind": "field", "name": "hideTrailingDays", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show trailing days which do not belong to the current month.", "attribute": "hide-trailing-days" }, { "kind": "field", "name": "rangePreviewDate", "privacy": "public", "description": "The range preview date.", "type": { "text": "Date | undefined" } }, { "kind": "field", "name": "weekDayFormat", "type": { "text": "'long' | 'short' | 'narrow'" }, "privacy": "public", "default": "'narrow'", "description": "The format of the days. Defaults to narrow.", "attribute": "week-day-format" }, { "kind": "method", "name": "_handleInteraction", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_selectDate", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_selectMultiple", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_selectRange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_isSelected", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_setRangePreviewDate", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "day", "optional": true, "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_changeRangePreview", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_clearRangePreview", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getEffectiveRangeStart", "privacy": "private", "return": { "type": { "text": "CalendarDay | undefined" } }, "description": "Gets the effective start of the visual range, accounting for preview." }, { "kind": "method", "name": "_getEffectiveRangeEnd", "privacy": "private", "return": { "type": { "text": "CalendarDay | undefined" } }, "description": "Gets the effective end of the visual range, accounting for preview." }, { "kind": "method", "name": "_isFirstInRange", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_isLastInRange", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_isRangeDate", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_isRangePreview", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_intlFormatDay", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_getDayHandlers", "privacy": "private", "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_getDayProperties", "privacy": "private", "return": { "type": { "text": "DayProperties" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } }, { "name": "today", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "focusActiveDate", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Focuses the active date." }, { "kind": "method", "name": "_renderDayWithProps", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "day", "type": { "text": "CalendarDay" } }, { "name": "props", "type": { "text": "DayProperties" } } ] }, { "kind": "method", "name": "_renderHeaderWeekNumber", "privacy": "protected" }, { "kind": "method", "name": "_renderWeekNumber", "privacy": "protected", "parameters": [ { "name": "start", "type": { "text": "CalendarDay" } }, { "name": "last", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_renderHeaders", "privacy": "protected" }, { "kind": "method", "name": "_renderWeeks", "privacy": "protected", "return": { "type": { "text": "Generator" } } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_initialActiveDateSet", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_hasValues", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_isSingle", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_isMultiple", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_isRange", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_rangePreviewDate", "type": { "text": "CalendarDay | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_firstDayOfWeek", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_activeDate", "privacy": "protected", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "CalendarDay | null" }, "privacy": "protected", "default": "null", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_values", "type": { "text": "CalendarDay[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_specialDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_disabledDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the calendar.\nUsed when selection is set to single", "attribute": "value", "type": { "text": "Date | null" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "values", "privacy": "public", "description": "The current values of the calendar.\nUsed when selection is set to multiple of range.", "attribute": "values", "type": { "text": "Date[]" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "activeDate", "privacy": "public", "description": "Get/Set the date which is shown in view and is highlighted. By default it is the current date.", "type": { "text": "Date" }, "attribute": "active-date", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "selection", "type": { "text": "CalendarSelection" }, "privacy": "public", "default": "'single'", "description": "Sets the type of selection in the component.", "attribute": "selection", "expandedType": { "text": "'single' | 'multiple' | 'range'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show the week numbers.", "attribute": "show-week-numbers", "reflects": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "weekStart", "type": { "text": "WeekDays" }, "privacy": "public", "default": "'sunday'", "description": "Gets/Sets the first day of the week.", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for formatting and displaying the dates in the component.", "attribute": "locale", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.", "type": { "text": "IgcCalendarResourceStrings" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "specialDates", "privacy": "public", "description": "Gets/Sets the special dates for the component.", "type": { "text": "DateRangeDescriptor[] | undefined" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "disabledDates", "privacy": "public", "description": "Gets/Sets the disabled dates for the component.", "type": { "text": "DateRangeDescriptor[] | undefined" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } } ], "events": [ { "description": "Emitted when the active date changes.", "name": "igcActiveDateChange" }, { "description": "Emitted when the range preview date changes.", "name": "igcRangePreviewDateChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "hide-leading-days", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show leading days which do not belong to the current month.", "fieldName": "hideLeadingDays", "attribute": "hide-leading-days" }, { "name": "hide-trailing-days", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show trailing days which do not belong to the current month.", "fieldName": "hideTrailingDays", "attribute": "hide-trailing-days" }, { "name": "week-day-format", "type": { "text": "'long' | 'short' | 'narrow'" }, "default": "'narrow'", "description": "The format of the days. Defaults to narrow.", "fieldName": "weekDayFormat", "attribute": "week-day-format" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "The active state of the component.", "fieldName": "active" }, { "name": "value", "description": "The current value of the calendar.\nUsed when selection is set to single", "fieldName": "value", "attribute": "value", "type": { "text": "Date | null" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "values", "description": "The current values of the calendar.\nUsed when selection is set to multiple of range.", "fieldName": "values", "attribute": "values", "type": { "text": "Date[]" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "selection", "type": { "text": "CalendarSelection" }, "default": "'single'", "description": "Sets the type of selection in the component.", "fieldName": "selection", "attribute": "selection", "expandedType": { "text": "'single' | 'multiple' | 'range'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "show-week-numbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the week numbers.", "fieldName": "showWeekNumbers", "attribute": "show-week-numbers", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "week-start", "type": { "text": "WeekDays" }, "default": "'sunday'", "description": "Gets/Sets the first day of the week.", "fieldName": "weekStart", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "locale", "description": "Gets/Sets the locale used for formatting and displaying the dates in the component.", "fieldName": "locale", "attribute": "locale", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "active-date", "description": "Get/Set the date which is shown in view and is highlighted. By default it is the current date.", "type": { "text": "Date" }, "fieldName": "activeDate", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcCalendarBaseComponent", "module": "/src/components/calendar/base.js" }, "tagName": "igc-days-view", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDaysViewComponent", "module": "src/components/calendar/days-view/days-view.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/months-view/months-view.ts", "declarations": [ { "kind": "class", "description": "Instantiate a months view as a separate component in the calendar.", "name": "IgcMonthsViewComponent", "cssParts": [ { "description": "The months row container.", "name": "months-row" }, { "description": "The month container.", "name": "month" }, { "description": "The inner month container.", "name": "month-inner" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-months-view'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_value", "privacy": "private" }, { "kind": "field", "name": "_activeMonth", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "value", "privacy": "public", "description": "Тhe current value of the calendar.", "type": { "text": "Date" } }, { "kind": "field", "name": "locale", "type": { "text": "string" }, "privacy": "public", "default": "'en'", "description": "Sets the locale used for formatting and displaying the dates.", "attribute": "locale" }, { "kind": "field", "name": "monthFormat", "type": { "text": "'numeric' | '2-digit' | 'long' | 'short' | 'narrow'" }, "privacy": "public", "default": "'long'", "description": "The format of the month. Defaults to long.", "attribute": "month-format" }, { "kind": "method", "name": "_handleInteraction", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "focusActiveDate", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Focuses the active date." }, { "kind": "method", "name": "_renderMonth", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "month", "type": { "text": "CalendarDay" } }, { "name": "now", "type": { "text": "CalendarDay" } }, { "name": "ariaFormatter", "type": { "text": "Intl.DateTimeFormat" } }, { "name": "labelFormatter", "type": { "text": "Intl.DateTimeFormat" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "locale", "type": { "text": "string" }, "default": "'en'", "description": "Sets the locale used for formatting and displaying the dates.", "fieldName": "locale" }, { "name": "month-format", "type": { "text": "'numeric' | '2-digit' | 'long' | 'short' | 'narrow'" }, "default": "'long'", "description": "The format of the month. Defaults to long.", "fieldName": "monthFormat" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-months-view", "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcMonthsViewComponent", "module": "src/components/calendar/months-view/months-view.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/years-view/years-view.ts", "declarations": [ { "kind": "class", "description": "Instantiate a years view as a separate component in the calendar.", "name": "IgcYearsViewComponent", "cssParts": [ { "description": "The years row container.", "name": "years-row" }, { "description": "The year container.", "name": "year" }, { "description": "The inner year container.", "name": "year-inner" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-years-view'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_value", "privacy": "private" }, { "kind": "field", "name": "_activeYear", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "value", "privacy": "public", "description": "Тhe current value of the calendar.", "type": { "text": "Date" } }, { "kind": "field", "name": "yearsPerPage", "type": { "text": "number" }, "privacy": "public", "default": "15", "description": "Sets how many years are displayed on a single page.", "attribute": "years-per-page" }, { "kind": "method", "name": "_handleInteraction", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "focusActiveDate", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Focuses the active year element." }, { "kind": "method", "name": "_renderYear", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "year", "type": { "text": "number" } }, { "name": "now", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "years-per-page", "type": { "text": "number" }, "default": "15", "description": "Sets how many years are displayed on a single page.", "fieldName": "yearsPerPage", "attribute": "years-per-page" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-years-view", "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcYearsViewComponent", "module": "src/components/calendar/years-view/years-view.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/calendar.ts", "declarations": [ { "kind": "variable", "name": "focusActiveDate" }, { "kind": "class", "description": "Represents a calendar that lets users\nto select a date value in a variety of different ways.", "name": "IgcCalendarComponent", "cssParts": [ { "description": "The header element of the calendar.", "name": "header" }, { "description": "The header title element of the calendar.", "name": "header-title" }, { "description": "The header date element of the calendar.", "name": "header-date" }, { "description": "The content element which contains the views and navigation elements of the calendar.", "name": "content" }, { "description": "The content element which contains the views and navigation elements of the calendar in vertical orientation.", "name": "content-vertical" }, { "description": "The navigation container element of the calendar.", "name": "navigation" }, { "description": "The months navigation button element of the calendar.", "name": "months-navigation" }, { "description": "The years navigation button element of the calendar.", "name": "years-navigation" }, { "description": "The years range element of the calendar.", "name": "years-range" }, { "description": "The navigation buttons container of the calendar.", "name": "navigation-buttons" }, { "description": "Previous/next navigation button of the calendar.", "name": "navigation-button" }, { "description": "The days view container element of the calendar.", "name": "days-view-container" }, { "description": "Days view element of the calendar.", "name": "days-view" }, { "description": "The months view element of the calendar.", "name": "months-view" }, { "description": "The years view element of the calendar.", "name": "years-view" }, { "description": "Days row element of the calendar.", "name": "days-row" }, { "description": "Week header label element of the calendar.", "name": "label" }, { "description": "Week number element of the calendar.", "name": "week-number" }, { "description": "Week number inner element of the calendar.", "name": "week-number-inner" }, { "description": "Date element of the calendar.", "name": "date" }, { "description": "Date inner element of the calendar.", "name": "date-inner" }, { "description": "The first selected date element of the calendar in range selection.", "name": "first" }, { "description": "The last selected date element of the calendar in range selection.", "name": "last" }, { "description": "Inactive date element of the calendar.", "name": "inactive" }, { "description": "Hidden date element of the calendar.", "name": "hidden" }, { "description": "Weekend date element of the calendar.", "name": "weekend" }, { "description": "Range selected element of the calendar.", "name": "range" }, { "description": "Special date element of the calendar.", "name": "special" }, { "description": "Disabled date element of the calendar.", "name": "disabled" }, { "description": "Single selected date element of the calendar.", "name": "single" }, { "description": "Range selection preview date element of the calendar.", "name": "preview" }, { "description": "Month element of the calendar.", "name": "month" }, { "description": "Month inner element of the calendar.", "name": "month-inner" }, { "description": "Year element of the calendar.", "name": "year" }, { "description": "Year inner element of the calendar.", "name": "year-inner" }, { "description": "Indicates selected state. Applies to date, month and year elements of the calendar.", "name": "selected" }, { "description": "Indicates current state. Applies to date, month and year elements of the calendar.", "name": "current" } ], "slots": [ { "description": "The default slot for the calendar.", "name": "" }, { "description": "Renders the title of the calendar header.", "name": "title" }, { "description": "Renders content instead of the current date/range in the calendar header.", "name": "header-date" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-calendar'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_contentRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isDayView", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isMonthView", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isYearView", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_previousButtonLabel", "type": { "text": "string" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_nextButtonLabel", "type": { "text": "string" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_activeDaysViewIndex", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_daysViews", "type": { "text": "NodeListOf" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_monthsView", "type": { "text": "IgcMonthsViewComponent" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_yearsView", "type": { "text": "IgcYearsViewComponent" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "hideOutsideDays", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show the dates that do not belong to the current active month.", "attribute": "hide-outside-days", "reflects": true }, { "kind": "field", "name": "hideHeader", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to render the calendar header part.\nWhen the calendar selection is set to `multiple` the header is always hidden.", "attribute": "hide-header", "reflects": true }, { "kind": "field", "name": "headerOrientation", "type": { "text": "CalendarHeaderOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the calendar header.", "attribute": "header-orientation", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "orientation", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the calendar months when more than one month\nis being shown.", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "visibleMonths", "type": { "text": "number" }, "privacy": "public", "default": "1", "description": "The number of months displayed in the days view.", "attribute": "visible-months" }, { "kind": "field", "name": "activeView", "type": { "text": "CalendarActiveView" }, "privacy": "public", "default": "'days'", "description": "The current active view of the component.", "attribute": "active-view", "expandedType": { "text": "'days' | 'months' | 'years'" } }, { "kind": "field", "name": "formatOptions", "type": { "text": "Pick" }, "privacy": "public", "default": "{ month: 'long', weekday: 'narrow' }", "description": "The options used to format the months and the weekdays in the calendar views." }, { "kind": "method", "name": "_shouldSkipKeyboardEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "_", "type": { "text": "Element" } }, { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_handleArrowKey", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "period", "type": { "text": "'day' | 'week'" } }, { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_handlePageKeys", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_handleShiftPageKeys", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_handleHomeKey", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleEndKey", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleMonthChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleYearChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleValueChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleActiveDateChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleRangePreviewChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_setActiveDaysView", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "viewIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_navigate", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "1 | -1" } } ] }, { "kind": "method", "name": "_navigatePrevious", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_navigateNext", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_navigateToMonthView", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "viewIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_navigateToYearView", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "viewIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_updateViewIndex", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "date", "type": { "text": "CalendarDay" } }, { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_getActiveDates", "privacy": "private", "return": { "type": { "text": "CalendarDay[]" } } }, { "kind": "method", "name": "_getNextEnabledDate", "privacy": "private", "return": { "type": { "text": "CalendarDay" } }, "parameters": [ { "name": "start", "type": { "text": "CalendarDay" } }, { "name": "delta", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_renderNavigationButtons", "privacy": "protected" }, { "kind": "method", "name": "_renderMonthButtonNavigation", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "active", "type": { "text": "CalendarDay" } }, { "name": "viewIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_renderYearButtonNavigation", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "active", "type": { "text": "CalendarDay" } }, { "name": "viewIndex", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_renderYearRangeNavigation", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "active", "type": { "text": "CalendarDay" } } ] }, { "kind": "method", "name": "_renderNavigation", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "date", "optional": true, "type": { "text": "CalendarDay" } }, { "name": "showButtons", "default": "true" }, { "name": "viewIndex", "default": "0" } ] }, { "kind": "method", "name": "_renderHeader", "privacy": "protected" }, { "kind": "method", "name": "_renderHeaderDateSingle", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderHeaderDateRange", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderHeaderDate", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderDaysView", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderMonthView", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderYearView", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_initialActiveDateSet", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_hasValues", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_isSingle", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_isMultiple", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_isRange", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_rangePreviewDate", "type": { "text": "CalendarDay | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_firstDayOfWeek", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_activeDate", "privacy": "protected", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "CalendarDay | null" }, "privacy": "protected", "default": "null", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_values", "type": { "text": "CalendarDay[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_specialDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "_disabledDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the calendar.\nUsed when selection is set to single", "attribute": "value", "type": { "text": "Date | null" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "values", "privacy": "public", "description": "The current values of the calendar.\nUsed when selection is set to multiple of range.", "attribute": "values", "type": { "text": "Date[]" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "activeDate", "privacy": "public", "description": "Get/Set the date which is shown in view and is highlighted. By default it is the current date.", "type": { "text": "Date" }, "attribute": "active-date", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "selection", "type": { "text": "CalendarSelection" }, "privacy": "public", "default": "'single'", "description": "Sets the type of selection in the component.", "attribute": "selection", "expandedType": { "text": "'single' | 'multiple' | 'range'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show the week numbers.", "attribute": "show-week-numbers", "reflects": true, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "weekStart", "type": { "text": "WeekDays" }, "privacy": "public", "default": "'sunday'", "description": "Gets/Sets the first day of the week.", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for formatting and displaying the dates in the component.", "attribute": "locale", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.", "type": { "text": "IgcCalendarResourceStrings" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "specialDates", "privacy": "public", "description": "Gets/Sets the special dates for the component.", "type": { "text": "DateRangeDescriptor[] | undefined" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "kind": "field", "name": "disabledDates", "privacy": "public", "description": "Gets/Sets the disabled dates for the component.", "type": { "text": "DateRangeDescriptor[] | undefined" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } } ], "events": [ { "description": "Emitted when calendar changes its value.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "hide-outside-days", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the dates that do not belong to the current active month.", "fieldName": "hideOutsideDays", "attribute": "hide-outside-days" }, { "name": "hide-header", "type": { "text": "boolean" }, "default": "false", "description": "Whether to render the calendar header part.\nWhen the calendar selection is set to `multiple` the header is always hidden.", "fieldName": "hideHeader", "attribute": "hide-header" }, { "name": "header-orientation", "type": { "text": "CalendarHeaderOrientation" }, "default": "'horizontal'", "description": "The orientation of the calendar header.", "fieldName": "headerOrientation", "attribute": "header-orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "orientation", "type": { "text": "ContentOrientation" }, "default": "'horizontal'", "description": "The orientation of the calendar months when more than one month\nis being shown.", "fieldName": "orientation", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "visible-months", "type": { "text": "number" }, "default": "1", "description": "The number of months displayed in the days view.", "fieldName": "visibleMonths", "attribute": "visible-months" }, { "name": "active-view", "type": { "text": "CalendarActiveView" }, "default": "'days'", "description": "The current active view of the component.", "fieldName": "activeView", "attribute": "active-view", "expandedType": { "text": "'days' | 'months' | 'years'" } }, { "name": "value", "description": "The current value of the calendar.\nUsed when selection is set to single", "fieldName": "value", "attribute": "value", "type": { "text": "Date | null" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "values", "description": "The current values of the calendar.\nUsed when selection is set to multiple of range.", "fieldName": "values", "attribute": "values", "type": { "text": "Date[]" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "selection", "type": { "text": "CalendarSelection" }, "default": "'single'", "description": "Sets the type of selection in the component.", "fieldName": "selection", "attribute": "selection", "expandedType": { "text": "'single' | 'multiple' | 'range'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "show-week-numbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the week numbers.", "fieldName": "showWeekNumbers", "attribute": "show-week-numbers", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "week-start", "type": { "text": "WeekDays" }, "default": "'sunday'", "description": "Gets/Sets the first day of the week.", "fieldName": "weekStart", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" }, "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "locale", "description": "Gets/Sets the locale used for formatting and displaying the dates in the component.", "fieldName": "locale", "attribute": "locale", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } }, { "name": "active-date", "description": "Get/Set the date which is shown in view and is highlighted. By default it is the current date.", "type": { "text": "Date" }, "fieldName": "activeDate", "inheritedFrom": { "name": "IgcCalendarBaseComponent", "module": "src/components/calendar/base.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcCalendarBaseComponent", "module": "/src/components/calendar/base.js" }, "tagName": "igc-calendar", "customElement": true } ], "exports": [ { "kind": "js", "name": "focusActiveDate", "declaration": { "name": "focusActiveDate", "module": "src/components/calendar/calendar.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "IgcCalendarComponent", "module": "src/components/calendar/calendar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/root-click.ts", "declarations": [ { "kind": "class", "description": "A Lit ReactiveController that manages global click listeners to hide a component\nwhen a click occurs outside of the component or its specified target.\n\nThis controller implements a singleton pattern for the document click listener,\nmeaning only one event listener is attached to `document` regardless of how many\ninstances of `RootClickController` are active. Each controller instance\nsubscribes to this single listener.", "name": "RootClickController", "members": [ { "kind": "field", "name": "_host", "type": { "text": "RootClickControllerHost" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_config", "type": { "text": "RootClickControllerConfig | undefined" }, "privacy": "private", "default": "config" }, { "kind": "method", "name": "_addActiveHost", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Adds the host to the set of active hosts and ensures the global\ndocument click listener is active if needed." }, { "kind": "method", "name": "_removeActiveHost", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Removes the host from the set of active hosts and removes the global\ndocument click listener if no other hosts are active." }, { "kind": "method", "name": "_configureListeners", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Configures the active state of the controller based on the host's `open` property.\nIf `host.open` is true, the controller becomes active; otherwise, it becomes inactive." } ] }, { "kind": "function", "name": "addRootClickController", "return": { "type": { "text": "RootClickController" } }, "parameters": [ { "name": "host", "type": { "text": "RootClickControllerHost" } }, { "name": "config", "optional": true, "type": { "text": "RootClickControllerConfig" } } ], "description": "Creates and adds a RootClickController instance with a RootClickControllerConfig| configuration\nto the given RootClickControllerHost| host." } ], "exports": [ { "kind": "js", "name": "addRootClickController", "declaration": { "name": "addRootClickController", "module": "src/components/common/controllers/root-click.ts" } }, { "kind": "js", "name": "RootClickController", "declaration": { "name": "RootClickController", "module": "src/components/common/controllers/root-click.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/decorators/blazorAdditionalDependencies.ts", "declarations": [ { "kind": "function", "name": "blazorAdditionalDependencies", "parameters": [ { "name": "_additionalDependencies", "type": { "text": "string" }, "description": "an alternate member name to use." } ], "description": "Indicates additional dependencies that should be loaded by the module of a component, even if they don't appear to be dependencies." } ], "exports": [ { "kind": "js", "name": "blazorAdditionalDependencies", "declaration": { "name": "blazorAdditionalDependencies", "module": "src/components/common/decorators/blazorAdditionalDependencies.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/decorators/watch.ts", "declarations": [ { "kind": "function", "name": "watch", "parameters": [ { "name": "propName", "type": { "text": "string" } }, { "name": "options", "optional": true, "type": { "text": "WatchOptions" } } ] } ], "exports": [ { "kind": "js", "name": "watch", "declaration": { "name": "watch", "module": "src/components/common/decorators/watch.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/combo-box.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcBaseComboBoxLikeComponent", "members": [ { "kind": "field", "name": "emitEvent", "type": { "text": "<\n K extends keyof IgcBaseComboBoxEventMap,\n D extends UnpackCustomEvent,\n >(\n event: K,\n eventInitDict?: CustomEventInit\n ) => boolean" }, "privacy": "public" }, { "kind": "field", "name": "_rootClickController", "type": { "text": "RootClickController" }, "privacy": "protected" }, { "kind": "field", "name": "keepOpenOnSelect", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "attribute": "keep-open-on-select", "reflects": true }, { "kind": "field", "name": "keepOpenOnOutsideClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "attribute": "keep-open-on-outside-click", "reflects": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the open state of the component.", "attribute": "open", "reflects": true }, { "kind": "method", "name": "emitClosing", "privacy": "protected" }, { "kind": "method", "name": "emitClosed", "privacy": "protected" }, { "kind": "method", "name": "emitOpening", "privacy": "protected" }, { "kind": "method", "name": "emitOpened", "privacy": "protected" }, { "kind": "method", "name": "handleAnchorClick", "privacy": "protected" }, { "kind": "method", "name": "_hide", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ] }, { "kind": "method", "name": "_show", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ] }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the component." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the component." }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component." } ], "attributes": [ { "name": "keep-open-on-select", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "fieldName": "keepOpenOnSelect", "attribute": "keep-open-on-select" }, { "name": "keep-open-on-outside-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "fieldName": "keepOpenOnOutsideClick", "attribute": "keep-open-on-outside-click" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the component.", "fieldName": "open", "attribute": "open" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true }, { "kind": "function", "name": "getItems", "parameters": [ { "name": "root", "type": { "text": "Node" } }, { "name": "tagName", "type": { "text": "string" } } ] }, { "kind": "function", "name": "getActiveItems", "parameters": [ { "name": "root", "type": { "text": "Node" } }, { "name": "tagName", "type": { "text": "string" } } ] }, { "kind": "function", "name": "getNextActiveItem", "parameters": [ { "name": "items", "type": { "text": "T[]" } }, { "name": "from", "type": { "text": "T" } } ] }, { "kind": "function", "name": "getPreviousActiveItem", "parameters": [ { "name": "items", "type": { "text": "T[]" } }, { "name": "from", "type": { "text": "T" } } ] }, { "kind": "function", "name": "setInitialSelectionState", "parameters": [ { "name": "items", "type": { "text": "T[]" } } ] } ], "exports": [ { "kind": "js", "name": "IgcBaseComboBoxLikeComponent", "declaration": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "js", "name": "getItems", "declaration": { "name": "getItems", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "js", "name": "getActiveItems", "declaration": { "name": "getActiveItems", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "js", "name": "getNextActiveItem", "declaration": { "name": "getNextActiveItem", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "js", "name": "getPreviousActiveItem", "declaration": { "name": "getPreviousActiveItem", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "js", "name": "setInitialSelectionState", "declaration": { "name": "setInitialSelectionState", "module": "src/components/common/mixins/combo-box.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/forms/form-value.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormValue", "members": [ { "kind": "field", "name": "setFormValueKey", "privacy": "private", "static": true, "readonly": true, "default": "'_setFormValue'", "type": { "text": "'_setFormValue'" } }, { "kind": "field", "name": "_host", "type": { "text": "IgcFormControl" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_transformers", "type": { "text": "FormValueTransformers" }, "privacy": "private", "readonly": true, "default": "{ ...FormValueDefaultTransformers, ...config.transformers, }" }, { "kind": "field", "name": "_setFormValue", "type": { "text": "IgcFormControl[typeof FormValue.setFormValueKey]" }, "privacy": "private", "readonly": true, "default": "host[FormValue.setFormValueKey]" }, { "kind": "field", "name": "_value", "type": { "text": "T" }, "privacy": "private" }, { "kind": "field", "name": "_defaultValue", "type": { "text": "T" }, "privacy": "private" }, { "kind": "method", "name": "setValueAndFormState", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "T" } } ] }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "T" } }, { "kind": "field", "name": "value", "privacy": "public", "type": { "text": "T" } } ] }, { "kind": "function", "name": "createFormValueState", "return": { "type": { "text": "FormValue" } }, "parameters": [ { "name": "host", "type": { "text": "LitElement" } }, { "name": "config", "type": { "text": "FormValueConfig" } } ] } ], "exports": [ { "kind": "js", "name": "FormValue", "declaration": { "name": "FormValue", "module": "src/components/common/mixins/forms/form-value.ts" } }, { "kind": "js", "name": "createFormValueState", "declaration": { "name": "createFormValueState", "module": "src/components/common/mixins/forms/form-value.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/forms/associated.ts", "declarations": [ { "kind": "mixin", "description": "Mixes the passed in class and turns it into a form associated custom element.", "name": "FormAssociatedMixin", "members": [ { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ], "attributes": [ { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ] }, { "kind": "mixin", "description": "Mixes the passed in class and turns it into a form associated custom element.", "name": "FormAssociatedCheckboxMixin", "members": [ { "kind": "field", "name": "defaultChecked", "privacy": "public", "type": { "text": "boolean" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ], "attributes": [ { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ] } ], "exports": [ { "kind": "js", "name": "FormAssociatedMixin", "declaration": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "js", "name": "FormAssociatedCheckboxMixin", "declaration": { "name": "FormAssociatedCheckboxMixin", "module": "src/components/common/mixins/forms/associated.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/forms/associated-required.ts", "declarations": [ { "kind": "mixin", "description": "Mixes the passed class into a form associated custom element with an\nadditional `required` attribute.", "name": "FormAssociatedRequiredMixin", "members": [ { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "attributes": [ { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedMixin", "module": "/src/components/common/mixins/forms/associated.js" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] }, { "kind": "mixin", "description": "Mixes the passed class into a form associated custom element with an\nadditional `required` attribute.", "name": "FormAssociatedCheckboxRequiredMixin", "members": [ { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "defaultChecked", "privacy": "public", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedCheckboxMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "attributes": [ { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedCheckboxMixin", "module": "/src/components/common/mixins/forms/associated.js" } ], "parameters": [ { "name": "base", "type": { "text": "T" } } ] } ], "exports": [ { "kind": "js", "name": "FormAssociatedRequiredMixin", "declaration": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "js", "name": "FormAssociatedCheckboxRequiredMixin", "declaration": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/validation-container/validation-container.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcValidationContainerComponent", "cssParts": [ { "description": "The base wrapper", "name": "helper-text" }, { "description": "The validation error message container", "name": "validation-message" }, { "description": "The validation error icon", "name": "validation-icon" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-validator'" }, { "kind": "field", "name": "_themes", "privacy": "protected", "readonly": true }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "create", "privacy": "public", "static": true, "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "host", "type": { "text": "IgcFormControl" } }, { "name": "config", "default": "{\n id: 'helper-text',\n hasHelperText: true,\n }", "type": { "text": "ValidationContainerConfig" } } ] }, { "kind": "field", "name": "_abortHandle", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_target", "type": { "text": "IgcFormControl" }, "privacy": "private" }, { "kind": "field", "name": "_hasSlottedContent", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "attribute": "invalid" }, { "kind": "field", "name": "target", "privacy": "public", "type": { "text": "IgcFormControl" } }, { "kind": "method", "name": "_renderValidationMessage", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "slotName", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderValidationSlots", "privacy": "protected", "return": { "type": { "text": "Generator" } }, "parameters": [ { "name": "validity", "type": { "text": "ValidityState" } }, { "name": "projected", "default": "false" } ] }, { "kind": "method", "name": "_renderHelper", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } } } ], "attributes": [ { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "fieldName": "invalid" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-validator", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcValidationContainerComponent", "module": "src/components/validation-container/validation-container.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcInputBaseComponent", "members": [ { "kind": "field", "name": "_themes", "type": { "text": "ThemingController" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`input-${nextId++}`" }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "value", "type": { "text": "string | Date | null" }, "privacy": "public", "description": "The value attribute of the control.\nType varies based on the input type and can be string, Date or null." }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label" }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected", "parameters": [ { "name": "base", "type": { "text": "string" } } ], "description": "Resolves the part names for the container based on the current state.\nUsed to apply conditional styling via CSS parts." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all the text inside the input." }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control." }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control." }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderFileParts", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderPrefix", "privacy": "private" }, { "kind": "method", "name": "_renderSuffix", "privacy": "private" }, { "kind": "method", "name": "_renderLabel", "privacy": "private" }, { "kind": "method", "name": "_renderMaterial", "privacy": "private" }, { "kind": "method", "name": "_renderStandard", "privacy": "private" }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder" }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label" }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IgcInputBaseComponent", "declaration": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask-input/mask-parser.ts", "declarations": [ { "kind": "class", "description": "A class for parsing and applying masks to strings, typically for input fields.\nIt handles mask definitions, literals, character validation, and cursor positioning.", "name": "MaskParser", "members": [ { "kind": "field", "name": "_options", "type": { "text": "MaskOptionsInternal" }, "privacy": "protected", "readonly": true, "default": "{ ...MaskDefaultOptions, ...options }" }, { "kind": "field", "name": "_literals", "privacy": "protected", "readonly": true, "default": "new Map()", "description": "Stores literal characters and their original positions in the mask (e.g., '(', ')', '-')." }, { "kind": "field", "name": "_literalPositions", "privacy": "protected", "default": "new Set()", "description": "A Set of positions where literals occur in the `_escapedMask`." }, { "kind": "field", "name": "_escapedMask", "type": { "text": "string" }, "privacy": "protected", "default": "''", "description": "The mask format after processing escape characters" }, { "kind": "field", "name": "_requiredPositions", "type": { "text": "number[]" }, "privacy": "protected", "default": "[]", "description": "Cached array of required non-literal positions for validation" }, { "kind": "field", "name": "literalPositions", "type": { "text": "ReadonlySet" }, "privacy": "public", "description": "Returns a set of the all the literal positions in the mask.\nThese positions are fixed characters that are not part of the input.", "readonly": true }, { "kind": "field", "name": "escapedMask", "type": { "text": "string" }, "privacy": "public", "description": "Returns the escaped mask string.\nThis is the mask after processing any escape sequences.", "readonly": true }, { "kind": "field", "name": "emptyMask", "type": { "text": "string" }, "privacy": "public", "description": "Returns the result of applying an empty string over the mask pattern.", "readonly": true }, { "kind": "field", "name": "mask", "type": { "text": "string" }, "privacy": "public", "description": "Sets the mask of the parser.\nWhen the mask is set, it triggers a re-parsing of the mask literals and escaped mask." }, { "kind": "field", "name": "prompt", "type": { "text": "string" }, "privacy": "public", "description": "Sets the prompt character. Only the first character of the provided string is used." }, { "kind": "method", "name": "_isEscapedFlag", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "char", "type": { "text": "string" } }, { "name": "nextChar", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_parseMaskLiterals", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Parses the mask format string to identify literal characters and\ncreate the escaped mask. This method is called whenever the mask format changes." }, { "kind": "method", "name": "_computeRequiredPositions", "privacy": "protected", "return": { "type": { "text": "number[]" } }, "description": "Computes an array of positions in the escaped mask that correspond to\nrequired input flags (e.g., '0', 'L') and are not literal characters.\n\nThese positions must be filled for the masked string to be valid." }, { "kind": "method", "name": "getPreviousNonLiteralPosition", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "start", "type": { "text": "number" } } ], "description": "Finds the closest non-literal position in the mask *before* the given start position.\nUseful for backward navigation (e.g., backspace)." }, { "kind": "method", "name": "getNextNonLiteralPosition", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "start", "type": { "text": "number" } } ], "description": "Finds the closest non-literal position in the mask *after* the given start position.\nUseful for forward navigation (e.g., arrow keys, delete key or initial cursor placement)." }, { "kind": "method", "name": "replace", "privacy": "public", "return": { "type": { "text": "MaskReplaceResult" } }, "parameters": [ { "name": "maskString", "type": { "text": "string" } }, { "name": "value", "type": { "text": "string" } }, { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } } ], "description": "Replaces a segment of the masked string with new input, simulating typing or pasting.\nIt handles clearing the selected range and inserting new characters according to the mask." }, { "kind": "method", "name": "parse", "privacy": "public", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "masked", "default": "''" } ], "description": "Parses the masked string, extracting only the valid input characters.\nThis effectively \"unmasks\" the string, removing prompts and literals." }, { "kind": "method", "name": "isValidString", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "input", "default": "''" } ], "description": "Checks if the masked string is valid, specifically if all required mask positions are filled\nwith valid, non-prompt characters." }, { "kind": "method", "name": "apply", "privacy": "public", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "input", "default": "''" } ], "description": "Applies the mask format to an input string. This attempts to fit the input\ninto the mask from left to right, filling valid positions and skipping invalid\ninput characters." } ] } ], "exports": [ { "kind": "js", "name": "MaskParser", "declaration": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask-input/mask-input-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcMaskInputBaseComponent", "members": [ { "kind": "field", "name": "_parser", "privacy": "protected", "readonly": true, "default": "new MaskParser()" }, { "kind": "field", "name": "_maskSelection", "type": { "text": "MaskSelection" }, "privacy": "protected", "default": "{ start: 0, end: 0 }" }, { "kind": "field", "name": "_compositionStart", "type": { "text": "number" }, "privacy": "protected", "default": "0" }, { "kind": "field", "name": "_focused", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "_maskedValue", "type": { "text": "string" }, "privacy": "protected", "default": "''" }, { "kind": "field", "name": "_inputSelection", "type": { "text": "MaskSelection" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_isEmptyMask", "type": { "text": "boolean" }, "privacy": "protected", "description": "Indicates whether the current mask value is empty.", "readonly": true }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readOnly", "reflects": true }, { "kind": "field", "name": "mask", "privacy": "public", "description": "The masked pattern of the component.", "default": "'CCCCCCCCCC'", "attribute": "mask", "type": { "text": "string" } }, { "kind": "field", "name": "prompt", "privacy": "public", "description": "The prompt symbol to use for unfilled parts of the mask pattern.", "default": "'_'", "attribute": "prompt", "type": { "text": "string" } }, { "kind": "method", "name": "_handleInput", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "{\n inputType,\n isComposing,\n }", "type": { "text": "InputEvent" } } ] }, { "kind": "method", "name": "_setMaskSelection", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleCompositionStart", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleCompositionEnd", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ data }", "type": { "text": "CompositionEvent" } } ] }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updateSetRangeTextValue", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updateInput", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "text", "type": { "text": "string" } }, { "name": "range", "type": { "text": "MaskSelection" } } ] }, { "kind": "method", "name": "setSelectionRange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "SelectionRangeDirection" } } ], "description": "Sets the text selection range of the control" }, { "kind": "method", "name": "setRangeText", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "replacement", "type": { "text": "string" } }, { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "selectMode", "optional": true, "type": { "text": "RangeTextSelectMode" } } ], "description": "Replaces the selected text in the control and re-applies the mask" }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_themes", "type": { "text": "ThemingController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`input-${nextId++}`", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "string | Date | null" }, "privacy": "public", "description": "The value attribute of the control.\nType varies based on the input type and can be string, Date or null.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected", "parameters": [ { "name": "base", "type": { "text": "string" } } ], "description": "Resolves the part names for the container based on the current state.\nUsed to apply conditional styling via CSS parts.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all the text inside the input.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderFileParts", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderPrefix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderSuffix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderMaterial", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderStandard", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "attributes": [ { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly" }, { "name": "mask", "description": "The masked pattern of the component.", "default": "'CCCCCCCCCC'", "fieldName": "mask", "attribute": "mask", "type": { "text": "string" } }, { "name": "prompt", "description": "The prompt symbol to use for unfilled parts of the mask pattern.", "default": "'_'", "fieldName": "prompt", "attribute": "prompt", "type": { "text": "string" } }, { "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "fieldName": "readOnly" }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "superclass": { "name": "IgcInputBaseComponent", "module": "/src/components/input/input-base.js" }, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IgcMaskInputBaseComponent", "declaration": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-time-input/date-part.ts", "declarations": [ { "kind": "variable", "name": "DatePartType", "type": { "text": "{\n Month: 'month',\n Year: 'year',\n Date: 'date',\n Hours: 'hours',\n Minutes: 'minutes',\n Seconds: 'seconds',\n AmPm: 'amPm',\n Literal: 'literal',\n}" }, "default": "{ Month: 'month', Year: 'year', Date: 'date', Hours: 'hours', Minutes: 'minutes', Seconds: 'seconds', AmPm: 'amPm', Literal: 'literal', }", "description": "Types of date/time parts that can appear in a format string" }, { "kind": "variable", "name": "DEFAULT_DATE_PARTS_SPIN_DELTAS" }, { "kind": "function", "name": "createDatePart", "return": { "type": { "text": "" } }, "parameters": [ { "name": "type", "type": { "text": "DatePartType" }, "description": "The type of date part to create" }, { "name": "options", "type": { "text": "DatePartOptions" }, "description": "The options for the date part" } ], "description": "Creates a date part instance based on the type.\nThis is the only way to create date part instances outside this module." } ], "exports": [ { "kind": "js", "name": "DatePartType", "declaration": { "name": "DatePartType", "module": "src/components/date-time-input/date-part.ts" } }, { "kind": "js", "name": "DEFAULT_DATE_PARTS_SPIN_DELTAS", "declaration": { "name": "DEFAULT_DATE_PARTS_SPIN_DELTAS", "module": "src/components/date-time-input/date-part.ts" } }, { "kind": "js", "name": "createDatePart", "declaration": { "name": "createDatePart", "module": "src/components/date-time-input/date-part.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-time-input/datetime-mask-parser.ts", "declarations": [ { "kind": "class", "description": "A specialized mask parser for date/time input fields.\nExtends MaskParser to handle date-specific format patterns and validation.", "name": "DateTimeMaskParser", "members": [ { "kind": "field", "name": "_dateParts", "type": { "text": "IDatePart[]" }, "privacy": "private", "description": "Parsed date parts from the format string" }, { "kind": "field", "name": "dateParts", "type": { "text": "ReadonlyArray" }, "privacy": "public", "description": "Gets the parsed date parts from the format string.\nEach part contains type, position, and format information.", "readonly": true }, { "kind": "field", "name": "mask", "type": { "text": "string" }, "privacy": "public", "description": "Sets a new date/time format and re-parses the date parts.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "_parseDateFormat", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Parses the format string into IDatePart objects.\nThis identifies each date/time component and its position." }, { "kind": "method", "name": "_normalizeYearFormatBuilder", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "builders", "type": { "text": "Array<{ type: DatePartType; end: number; format: string }>" } } ], "description": "Normalizes year format to 'yyyy' for editing (except for 'yy').\nAlso updates the end position to account for the expanded format." }, { "kind": "method", "name": "parseDate", "privacy": "public", "return": { "type": { "text": "" } }, "parameters": [ { "name": "masked", "type": { "text": "string" }, "description": "The masked input string to parse" } ], "description": "Parses a masked string into a Date object.\nReturns null if the string cannot be parsed into a valid date." }, { "kind": "method", "name": "_extractDateValues", "privacy": "private", "return": { "type": { "text": "Partial>" } }, "parameters": [ { "name": "masked", "type": { "text": "string" } } ], "description": "Extracts numeric values from the masked string for each date part." }, { "kind": "method", "name": "_validateDateParts", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "parts", "type": { "text": "Partial>" } } ], "description": "Validates that parsed date parts are within valid ranges.\nOnly validates parts that are present in the format.\nUses the validate() method on each date part instance." }, { "kind": "method", "name": "_applyAmPmConversion", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "parts", "type": { "text": "Partial>" } }, { "name": "masked", "type": { "text": "string" } } ], "description": "Applies AM/PM conversion to hours if format includes AM/PM." }, { "kind": "method", "name": "_createDateFromParts", "privacy": "private", "return": { "type": { "text": "Date" } }, "parameters": [ { "name": "parts", "type": { "text": "Partial>" } } ], "description": "Creates a Date object from parsed parts with defaults for missing values." }, { "kind": "method", "name": "_daysInMonth", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "year", "type": { "text": "number" } }, { "name": "month", "type": { "text": "number" } } ], "description": "Gets the number of days in a specific month/year." }, { "kind": "method", "name": "formatDate", "privacy": "public", "return": { "type": { "text": "" } }, "parameters": [ { "name": "date", "type": { "text": "Date | null" }, "description": "The date to format" } ], "description": "Formats a Date object into a masked string according to the current format." }, { "kind": "method", "name": "getDatePartAtPosition", "privacy": "public", "return": { "type": { "text": "" } }, "parameters": [ { "name": "position", "type": { "text": "number" }, "description": "The cursor position to check" } ], "description": "Finds the date part at a given cursor position.\nUses exclusive end (position < end) for precise character targeting." }, { "kind": "method", "name": "getDatePartForCursor", "privacy": "public", "return": { "type": { "text": "" } }, "parameters": [ { "name": "position", "type": { "text": "number" }, "description": "The cursor position to check" } ], "description": "Finds the date part for a cursor position, using inclusive end.\nThis handles the edge case where cursor is at the end of the mask\n(position equals the end of the last part)." }, { "kind": "method", "name": "hasDateParts", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks if the format includes any date parts (day, month, year)." }, { "kind": "method", "name": "hasTimeParts", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks if the format includes any time parts (hours, minutes, seconds)." }, { "kind": "method", "name": "getFirstDatePart", "privacy": "public", "return": { "type": { "text": "DatePartInfo | undefined" } }, "description": "Gets the first non-literal date part (useful for default selection)." }, { "kind": "method", "name": "getPartByType", "privacy": "public", "return": { "type": { "text": "DatePartInfo | undefined" } }, "parameters": [ { "name": "type", "type": { "text": "DatePartType" } } ], "description": "Gets a specific type of date part." }, { "kind": "method", "name": "_parseMaskLiterals", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Builds the internal mask pattern from the date format.\nConverts date format characters to mask pattern characters.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "_convertToMaskFormat", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "dateFormat", "type": { "text": "string" } } ], "description": "Converts a date format string to a mask format string.\nDate format chars become '0' (numeric) or 'L' (alpha for AM/PM)." }, { "kind": "field", "name": "_options", "type": { "text": "MaskOptionsInternal" }, "privacy": "protected", "readonly": true, "default": "{ ...MaskDefaultOptions, ...options }", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "_literals", "privacy": "protected", "readonly": true, "default": "new Map()", "description": "Stores literal characters and their original positions in the mask (e.g., '(', ')', '-').", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "_literalPositions", "privacy": "protected", "default": "new Set()", "description": "A Set of positions where literals occur in the `_escapedMask`.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "_escapedMask", "type": { "text": "string" }, "privacy": "protected", "default": "''", "description": "The mask format after processing escape characters", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "_requiredPositions", "type": { "text": "number[]" }, "privacy": "protected", "default": "[]", "description": "Cached array of required non-literal positions for validation", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "literalPositions", "type": { "text": "ReadonlySet" }, "privacy": "public", "description": "Returns a set of the all the literal positions in the mask.\nThese positions are fixed characters that are not part of the input.", "readonly": true, "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "escapedMask", "type": { "text": "string" }, "privacy": "public", "description": "Returns the escaped mask string.\nThis is the mask after processing any escape sequences.", "readonly": true, "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "emptyMask", "type": { "text": "string" }, "privacy": "public", "description": "Returns the result of applying an empty string over the mask pattern.", "readonly": true, "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "field", "name": "prompt", "type": { "text": "string" }, "privacy": "public", "description": "Sets the prompt character. Only the first character of the provided string is used.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "_isEscapedFlag", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "char", "type": { "text": "string" } }, { "name": "nextChar", "type": { "text": "string" } } ], "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "_computeRequiredPositions", "privacy": "protected", "return": { "type": { "text": "number[]" } }, "description": "Computes an array of positions in the escaped mask that correspond to\nrequired input flags (e.g., '0', 'L') and are not literal characters.\n\nThese positions must be filled for the masked string to be valid.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "getPreviousNonLiteralPosition", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "start", "type": { "text": "number" } } ], "description": "Finds the closest non-literal position in the mask *before* the given start position.\nUseful for backward navigation (e.g., backspace).", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "getNextNonLiteralPosition", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "start", "type": { "text": "number" } } ], "description": "Finds the closest non-literal position in the mask *after* the given start position.\nUseful for forward navigation (e.g., arrow keys, delete key or initial cursor placement).", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "replace", "privacy": "public", "return": { "type": { "text": "MaskReplaceResult" } }, "parameters": [ { "name": "maskString", "type": { "text": "string" } }, { "name": "value", "type": { "text": "string" } }, { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } } ], "description": "Replaces a segment of the masked string with new input, simulating typing or pasting.\nIt handles clearing the selected range and inserting new characters according to the mask.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "parse", "privacy": "public", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "masked", "default": "''" } ], "description": "Parses the masked string, extracting only the valid input characters.\nThis effectively \"unmasks\" the string, removing prompts and literals.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "isValidString", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "input", "default": "''" } ], "description": "Checks if the masked string is valid, specifically if all required mask positions are filled\nwith valid, non-prompt characters.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } }, { "kind": "method", "name": "apply", "privacy": "public", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "input", "default": "''" } ], "description": "Applies the mask format to an input string. This attempts to fit the input\ninto the mask from left to right, filling valid positions and skipping invalid\ninput characters.", "inheritedFrom": { "name": "MaskParser", "module": "src/components/mask-input/mask-parser.ts" } } ], "superclass": { "name": "MaskParser", "module": "/src/components/mask-input/mask-parser.js" } } ], "exports": [ { "kind": "js", "name": "DateParts", "declaration": { "name": "DatePartType", "module": "src/components/date-time-input/datetime-mask-parser.ts" } }, { "kind": "js", "name": "createDatePart", "declaration": { "name": "createDatePart", "module": "src/components/date-time-input/datetime-mask-parser.ts" } }, { "kind": "js", "name": "DateTimeMaskParser", "declaration": { "name": "DateTimeMaskParser", "module": "src/components/date-time-input/datetime-mask-parser.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-time-input/validators.ts", "declarations": [ { "kind": "variable", "name": "dateTimeInputValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, { ...minDateValidator, isValid: (host) => host.value && host.min ? !isDateLessThanMin( host.value, host.min, host.hasTimeParts(), host.hasDateParts() ) : true, }, { ...maxDateValidator, isValid: (host) => host.value && host.max ? !isDateExceedingMax( host.value, host.max, host.hasTimeParts(), host.hasDateParts() ) : true, }, ]" } ], "exports": [ { "kind": "js", "name": "dateTimeInputValidators", "declaration": { "name": "dateTimeInputValidators", "module": "src/components/date-time-input/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-time-input/date-time-input.ts", "declarations": [ { "kind": "class", "description": "A date time input is an input field that lets you set and edit the date and time in a chosen input element\nusing customizable display and input formats.", "name": "IgcDateTimeInputComponent", "cssParts": [ { "description": "The main wrapper that holds all main input elements.", "name": "container" }, { "description": "The native input element.", "name": "input" }, { "description": "The native label element.", "name": "label" }, { "description": "The prefix wrapper.", "name": "prefix" }, { "description": "The suffix wrapper.", "name": "suffix" }, { "description": "The helper text wrapper.", "name": "helper-text" } ], "slots": [ { "description": "Renders content before the input.", "name": "prefix" }, { "description": "Renders content after input.", "name": "suffix" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when the max validation fails.", "name": "range-overflow" }, { "description": "Renders content when the min validation fails.", "name": "range-underflow" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-date-time-input'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_parser", "privacy": "protected", "readonly": true, "default": "new DateTimeMaskParser()", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_defaultDisplayFormat", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_displayFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_inputFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_oldValue", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_min", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_max", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_i18nController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_themes", "type": { "text": "ThemingController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_targetDatePart", "type": { "text": "DatePart | undefined" }, "privacy": "private", "description": "Determines which date/time part is currently targeted based on cursor position.\nWhen focused, returns the part under the cursor.\nWhen unfocused, returns a default part based on available parts.", "readonly": true, "expandedType": { "text": "'month' | 'year' | 'date' | 'hours' | 'minutes' | 'seconds' | 'amPm' | undefined" } }, { "kind": "field", "name": "_datePartDeltas", "type": { "text": "DatePartDeltas" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "inputFormat", "privacy": "public", "description": "The date format to apply on the input.", "attribute": "input-format", "type": { "text": "string" } }, { "kind": "field", "name": "value", "type": { "text": "string | Date | null" }, "privacy": "public", "description": "The value of the input.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" }, "attribute": "value" }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum value required for the input to remain valid.", "attribute": "min", "type": { "text": "Date | null" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value required for the input to remain valid.", "attribute": "max", "type": { "text": "Date | null" } }, { "kind": "field", "name": "displayFormat", "privacy": "public", "description": "Format to display the value in when not editing.\nDefaults to the locale format if not set.", "attribute": "display-format", "type": { "text": "string" } }, { "kind": "field", "name": "spinDelta", "type": { "text": "DatePartDeltas | undefined" }, "privacy": "public", "description": "Delta values used to increment or decrement each date part on step actions.\nAll values default to `1`." }, { "kind": "field", "name": "spinLoop", "type": { "text": "boolean" }, "privacy": "public", "default": "true", "description": "Sets whether to loop over the currently spun segment.", "attribute": "spin-loop" }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for formatting the display value.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected", "parameters": [ { "name": "base", "type": { "text": "string" } } ], "description": "Resolves the part names for the container based on the current state.\nUsed to apply conditional styling via CSS parts.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_updateSetRangeTextValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_emitInputEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleResourceChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleDragLeave", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleDragEnter", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleWheel", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "WheelEvent" } } ] }, { "kind": "method", "name": "_handleFocus", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setCurrentDateTime", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_navigateParts", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "direction", "type": { "text": "number" } } ], "description": "Navigates to the previous or next date part." }, { "kind": "method", "name": "_calculatePartNavigationPosition", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "inputValue", "type": { "text": "string" } }, { "name": "direction", "type": { "text": "number" } } ], "description": "Calculates the new cursor position when navigating between date parts.\ndirection = 0: navigate to start of previous part\ndirection = 1: navigate to start of next part" }, { "kind": "method", "name": "_keyboardSpin", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "direction", "type": { "text": "'up' | 'down'" } } ], "description": "Handles keyboard-triggered spinning (arrow up/down)." }, { "kind": "method", "name": "_updateMaskDisplay", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Updates the displayed mask value based on focus state.\nWhen focused, shows the editable mask. When unfocused, shows formatted display value." }, { "kind": "method", "name": "_updateInput", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "text", "type": { "text": "string" } }, { "name": "{ start, end }", "type": { "text": "MaskSelection" } } ], "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_performStep", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "datePart", "type": { "text": "DatePart | undefined" } }, { "name": "delta", "type": { "text": "number | undefined" } }, { "name": "isDecrement", "type": { "text": "boolean" } } ], "description": "Common logic for stepping up or down a date part." }, { "kind": "method", "name": "_calculateSpunValue", "privacy": "private", "return": { "type": { "text": "Date" } }, "parameters": [ { "name": "datePart", "type": { "text": "DatePart" } }, { "name": "delta", "type": { "text": "number | undefined" } }, { "name": "isDecrement", "type": { "text": "boolean" } } ], "description": "Calculates the new date value after spinning a date part." }, { "kind": "method", "name": "_spinDatePart", "privacy": "private", "return": { "type": { "text": "Date" } }, "parameters": [ { "name": "datePart", "type": { "text": "DatePart" } }, { "name": "delta", "type": { "text": "number" } } ], "description": "Spins a specific date part by the given delta." }, { "kind": "method", "name": "_updateDefaultDisplayFormat", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Updates the default display format based on current locale." }, { "kind": "method", "name": "_applyMask", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "formatString", "type": { "text": "string" } } ], "description": "Applies a mask pattern to the input, parsing the format string into date parts." }, { "kind": "method", "name": "_buildMaskedValue", "privacy": "private", "return": { "type": { "text": "string" } }, "description": "Builds the masked value string from the current date value.\nReturns empty mask if no value, or existing masked value if incomplete." }, { "kind": "method", "name": "_initializeDefaultMask", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getDatePartAtCursor", "privacy": "private", "return": { "type": { "text": "DatePart | undefined" } }, "description": "Gets the date part at the current cursor position.\nUses inclusive end to handle cursor at the end of the last part.\nReturns undefined if cursor is not within a valid date part." }, { "kind": "method", "name": "_getDefaultDatePart", "privacy": "private", "return": { "type": { "text": "DatePart | undefined" } }, "description": "Gets the default date part to target when the input is not focused.\nPrioritizes: Date > Hours > First available part" }, { "kind": "method", "name": "_isMaskComplete", "privacy": "private", "return": { "type": { "text": "boolean" } }, "description": "Checks if all mask positions are filled (no prompt characters remain)." }, { "kind": "method", "name": "_updateValueFromMask", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Updates the internal value based on the current masked input.\nOnly sets a value if the mask is complete and parses to a valid date." }, { "kind": "method", "name": "stepUp", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "datePart", "optional": true, "type": { "text": "DatePart" } }, { "name": "delta", "optional": true, "type": { "text": "number" } } ], "description": "Increments a date/time portion." }, { "kind": "method", "name": "stepDown", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "datePart", "optional": true, "type": { "text": "DatePart" } }, { "name": "delta", "optional": true, "type": { "text": "number" } } ], "description": "Decrements a date/time portion." }, { "kind": "method", "name": "clear", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Clears the input element of user input." }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_maskSelection", "type": { "text": "MaskSelection" }, "privacy": "protected", "default": "{ start: 0, end: 0 }", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_compositionStart", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_focused", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_maskedValue", "type": { "text": "string" }, "privacy": "protected", "default": "''", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_inputSelection", "type": { "text": "MaskSelection" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_isEmptyMask", "type": { "text": "boolean" }, "privacy": "protected", "description": "Indicates whether the current mask value is empty.", "readonly": true, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readOnly", "reflects": true, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "mask", "privacy": "public", "description": "The masked pattern of the component.", "default": "'CCCCCCCCCC'", "attribute": "mask", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "prompt", "privacy": "public", "description": "The prompt symbol to use for unfilled parts of the mask pattern.", "default": "'_'", "attribute": "prompt", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleInput", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "{\n inputType,\n isComposing,\n }", "type": { "text": "InputEvent" } } ], "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_setMaskSelection", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleCompositionStart", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleCompositionEnd", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ data }", "type": { "text": "CompositionEvent" } } ], "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "setSelectionRange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "SelectionRangeDirection" } } ], "description": "Sets the text selection range of the control", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "setRangeText", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "replacement", "type": { "text": "string" } }, { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "selectMode", "optional": true, "type": { "text": "RangeTextSelectMode" } } ], "description": "Replaces the selected text in the control and re-applies the mask", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`input-${nextId++}`", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all the text inside the input.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderFileParts", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderPrefix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderSuffix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderMaterial", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderStandard", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "events": [ { "description": "Emitted when the control input receives user input.", "name": "igcInput" }, { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "attributes": [ { "name": "input-format", "description": "The date format to apply on the input.", "fieldName": "inputFormat", "attribute": "input-format", "type": { "text": "string" } }, { "name": "value", "description": "The value of the input.", "fieldName": "value", "attribute": "value", "type": { "text": "Date | null" } }, { "name": "min", "description": "The minimum value required for the input to remain valid.", "fieldName": "min", "attribute": "min", "type": { "text": "Date | null" } }, { "name": "max", "description": "The maximum value required for the input to remain valid.", "fieldName": "max", "attribute": "max", "type": { "text": "Date | null" } }, { "name": "display-format", "description": "Format to display the value in when not editing.\nDefaults to the locale format if not set.", "fieldName": "displayFormat", "attribute": "display-format", "type": { "text": "string" } }, { "name": "spin-loop", "type": { "text": "boolean" }, "default": "true", "description": "Sets whether to loop over the currently spun segment.", "fieldName": "spinLoop", "attribute": "spin-loop" }, { "name": "locale", "description": "Gets/Sets the locale used for formatting the display value.", "fieldName": "locale", "attribute": "locale", "type": { "text": "string" } }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "mask", "description": "The masked pattern of the component.", "default": "'CCCCCCCCCC'", "fieldName": "mask", "attribute": "mask", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "prompt", "description": "The prompt symbol to use for unfilled parts of the mask pattern.", "default": "'_'", "fieldName": "prompt", "attribute": "prompt", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "fieldName": "readOnly", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcMaskInputBaseComponent", "module": "/src/components/mask-input/mask-input-base.js" }, "tagName": "igc-date-time-input", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDateTimeInputComponent", "module": "src/components/date-time-input/date-time-input.ts" } } ] }, { "kind": "javascript-module", "path": "src/animations/types.ts", "declarations": [ { "kind": "function", "name": "animation", "return": { "type": { "text": "AnimationReferenceMetadata" } }, "parameters": [ { "name": "steps", "type": { "text": "Keyframe[]" } }, { "name": "options", "optional": true, "type": { "text": "KeyframeAnimationOptions" } } ] } ], "exports": [ { "kind": "js", "name": "animation", "declaration": { "name": "animation", "module": "src/animations/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/animations/player.ts", "declarations": [ { "kind": "class", "description": "A ReactiveController for managing Web Animation API (WAAPI) playback\non a host element or a specified target element.\n\nIt provides methods to play, stop, and coordinate animations, including\nsupport for 'height: auto' transitions and reduced motion preference.", "name": "AnimationController", "members": [ { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & HTMLElement" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_ref", "type": { "text": "Ref | HTMLElement | undefined" }, "privacy": "private", "readonly": true, "default": "ref" }, { "kind": "field", "name": "_target", "type": { "text": "HTMLElement" }, "privacy": "protected", "description": "The actual HTMLElement target for the animations.\nPrioritizes a passed-in Ref value, then a direct HTMLElement, falling back to the host.", "readonly": true }, { "kind": "method", "name": "_parseKeyframes", "privacy": "private", "return": { "type": { "text": "Keyframe[]" } }, "parameters": [ { "name": "keyframes", "type": { "text": "Keyframe[]" } } ], "description": "Pre-processes keyframes, specifically resolving 'auto' height to the element's scrollHeight." }, { "kind": "method", "name": "playExclusive", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "animation", "type": { "text": "AnimationReferenceMetadata" } } ], "description": "Plays a sequence of keyframes, first cancelling all existing animations on the target." }, { "kind": "method", "name": "play", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "animation", "type": { "text": "AnimationReferenceMetadata" } } ], "description": "Plays a sequence of keyframes using WAAPI.\nAutomatically sets duration to 0 if 'prefers-reduced-motion' is set." }, { "kind": "method", "name": "cancelAll", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Cancels all active animations on the target element." } ] }, { "kind": "function", "name": "addAnimationController", "return": { "type": { "text": "AnimationController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & HTMLElement" } }, { "name": "target", "optional": true, "type": { "text": "Ref | HTMLElement" } } ], "description": "Creates and attaches an animation player instance to the passed in `host` element.\nThe player will run animations on the passed in `target`, or if `target` is undefined,\nthe host element itself." }, { "kind": "function", "name": "startViewTransition", "return": { "type": { "text": "ViewTransitionResult" } }, "parameters": [ { "name": "callback", "optional": true, "type": { "text": "ViewTransitionUpdateCallback" } } ], "description": "Initiates a View Transition if supported by the browser and not suppressed by\nthe 'prefers-reduced-motion' setting." } ], "exports": [ { "kind": "js", "name": "addAnimationController", "declaration": { "name": "addAnimationController", "module": "src/animations/player.ts" } }, { "kind": "js", "name": "startViewTransition", "declaration": { "name": "startViewTransition", "module": "src/animations/player.ts" } }, { "kind": "js", "name": "AnimationController", "declaration": { "name": "AnimationController", "module": "src/animations/player.ts" } } ] }, { "kind": "javascript-module", "path": "src/animations/easings.ts", "declarations": [], "exports": [ { "kind": "js", "name": "EaseIn", "declaration": { "name": "EaseIn", "module": "src/animations/easings.ts" } }, { "kind": "js", "name": "EaseOut", "declaration": { "name": "EaseOut", "module": "src/animations/easings.ts" } }, { "kind": "js", "name": "EaseInOut", "declaration": { "name": "EaseInOut", "module": "src/animations/easings.ts" } } ] }, { "kind": "javascript-module", "path": "src/animations/presets/fade/index.ts", "declarations": [ { "kind": "function", "name": "fadeIn", "parameters": [ { "name": "options", "default": "baseOptions" } ] }, { "kind": "function", "name": "fadeOut", "parameters": [ { "name": "options", "default": "baseOptions" } ] } ], "exports": [ { "kind": "js", "name": "fadeIn", "declaration": { "name": "fadeIn", "module": "src/animations/presets/fade/index.ts" } }, { "kind": "js", "name": "fadeOut", "declaration": { "name": "fadeOut", "module": "src/animations/presets/fade/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dialog/dialog.ts", "declarations": [ { "kind": "class", "description": "Represents a Dialog component.", "name": "IgcDialogComponent", "cssParts": [ { "description": "The base wrapper of the dialog.", "name": "base" }, { "description": "The title container of the dialog.", "name": "title" }, { "description": "The footer container of the dialog.", "name": "footer" }, { "description": "The backdrop overlay of the dialog.", "name": "overlay" } ], "slots": [ { "description": "Renders content inside the default slot of the dialog.", "name": "" }, { "description": "Renders content in the title slot of the dialog header.", "name": "title" }, { "description": "Renders the message content of the dialog.", "name": "message" }, { "description": "Renders content in the dialog footer.", "name": "footer" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-dialog'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_titleId", "privacy": "private", "readonly": true, "default": "`title-${nextId++}`" }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_dialogRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_player", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_animating", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "description": "Backdrop animation helper." }, { "kind": "field", "name": "_dialog", "type": { "text": "HTMLDialogElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "keepOpenOnEscape", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the dialog should be kept open when pressing the 'Escape' button.", "attribute": "keep-open-on-escape" }, { "kind": "field", "name": "closeOnOutsideClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the dialog should be closed when clicking outside of it.", "attribute": "close-on-outside-click" }, { "kind": "field", "name": "hideDefaultAction", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to hide the default action button for the dialog.\n\nWhen there is projected content in the `footer` slot this property\nhas no effect.", "attribute": "hide-default-action" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the dialog is opened.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "title", "type": { "text": "string" }, "privacy": "public", "description": "Sets the title of the dialog.", "attribute": "title" }, { "kind": "field", "name": "returnValue", "type": { "text": "string" }, "privacy": "public", "description": "Sets the return value for the dialog." }, { "kind": "method", "name": "_handleOpenState", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_emitClosing", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_hide", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "emitEvent", "default": "false" } ] }, { "kind": "method", "name": "_closeWithEvent", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleFormSubmit", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "SubmitEvent" } } ] }, { "kind": "method", "name": "_handleCancel", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_handleClose", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ clientX, clientY, target }", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Opens the dialog." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Closes the dialog." }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the dialog." }, { "kind": "method", "name": "_renderBackdrop", "privacy": "protected" }, { "kind": "method", "name": "_renderHeader", "privacy": "protected" }, { "kind": "method", "name": "_renderContent", "privacy": "protected" }, { "kind": "method", "name": "_renderFooter", "privacy": "protected" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitter just before the dialog is closed. Cancelable.", "name": "igcClosing" }, { "description": "Emitted after closing the dialog.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "keep-open-on-escape", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog should be kept open when pressing the 'Escape' button.", "fieldName": "keepOpenOnEscape", "attribute": "keep-open-on-escape" }, { "name": "close-on-outside-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog should be closed when clicking outside of it.", "fieldName": "closeOnOutsideClick", "attribute": "close-on-outside-click" }, { "name": "hide-default-action", "type": { "text": "boolean" }, "default": "false", "description": "Whether to hide the default action button for the dialog.\n\nWhen there is projected content in the `footer` slot this property\nhas no effect.", "fieldName": "hideDefaultAction", "attribute": "hide-default-action" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dialog is opened.", "fieldName": "open", "attribute": "open" }, { "name": "title", "type": { "text": "string" }, "description": "Sets the title of the dialog.", "fieldName": "title", "attribute": "title" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-dialog", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDialogComponent", "module": "src/components/dialog/dialog.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/focus-trap/focus-trap.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcFocusTrapComponent", "slots": [ { "description": "The content of the focus trap component", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-focus-trap'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "_focused", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to manage focus state for the slotted children.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "focused", "privacy": "public", "description": "Whether focus in currently inside the trap component.", "readonly": true }, { "kind": "field", "name": "focusableElements", "privacy": "public", "description": "An array of focusable elements including elements in Shadow roots", "readonly": true }, { "kind": "method", "name": "onFocusIn", "privacy": "private" }, { "kind": "method", "name": "onFocusOut", "privacy": "private" }, { "kind": "method", "name": "focusFirstElement", "privacy": "public" }, { "kind": "method", "name": "focusLastElement", "privacy": "public" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether to manage focus state for the slotted children.", "fieldName": "disabled", "attribute": "disabled" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-focus-trap", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcFocusTrapComponent", "module": "src/components/focus-trap/focus-trap.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/validators.ts", "declarations": [ { "kind": "variable", "name": "stringValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, minLengthValidator, maxLengthValidator, patternValidator, { key: 'typeMismatch', isValid: (host) => { switch (host.type) { case 'email': return emailValidator.isValid(host); case 'url': return urlValidator.isValid(host); default: return true; } }, message: (host) => (host.type === 'email' ? emailValidator.message : urlValidator.message) as string, }, ]" }, { "kind": "variable", "name": "numberValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, minValidator, maxValidator, stepValidator, ]" } ], "exports": [ { "kind": "js", "name": "stringValidators", "declaration": { "name": "stringValidators", "module": "src/components/input/validators.ts" } }, { "kind": "js", "name": "numberValidators", "declaration": { "name": "numberValidators", "module": "src/components/input/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/input/input.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcInputComponent", "cssParts": [ { "description": "The main wrapper that holds all main input elements.", "name": "container" }, { "description": "The native input element.", "name": "input" }, { "description": "The native label element.", "name": "label" }, { "description": "The prefix wrapper.", "name": "prefix" }, { "description": "The suffix wrapper.", "name": "suffix" }, { "description": "The helper text wrapper.", "name": "helper-text" } ], "slots": [ { "description": "Renders content before the input.", "name": "prefix" }, { "description": "Renders content after input.", "name": "suffix" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when the a type url/email input pattern validation fails.", "name": "type-mismatch" }, { "description": "Renders content when the pattern validation fails.", "name": "pattern-mismatch" }, { "description": "Renders content when the maxlength validation fails.", "name": "too-long" }, { "description": "Renders content when the minlength validation fails.", "name": "too-short" }, { "description": "Renders content when the max validation fails.", "name": "range-overflow" }, { "description": "Renders content when the min validation fails.", "name": "range-underflow" }, { "description": "Renders content when the step validation fails.", "name": "step-mismatch" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-input'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_themes", "type": { "text": "ThemingController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_min", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_max", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_minLength", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_maxLength", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_pattern", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_step", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "value", "type": { "text": "string | Date | null" }, "privacy": "public", "description": "The value of the control.", "attribute": "value", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "InputType" }, "privacy": "public", "default": "'text'", "description": "The type attribute of the control.", "attribute": "type", "reflects": true, "expandedType": { "text": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url'" } }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readOnly", "reflects": true }, { "kind": "field", "name": "inputMode", "type": { "text": "string" }, "privacy": "public", "description": "The input mode attribute of the control.\nSee [relevant MDN article](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)", "attribute": "inputmode" }, { "kind": "field", "name": "pattern", "privacy": "public", "description": "The pattern attribute of the control.", "attribute": "pattern", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "minLength", "privacy": "public", "description": "The minimum string length required by the control.", "attribute": "minlength", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "maxLength", "privacy": "public", "description": "The maximum string length of the control.", "attribute": "maxlength", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "min", "privacy": "public", "description": "The min attribute of the control.", "attribute": "min", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The max attribute of the control.", "attribute": "max", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "step", "privacy": "public", "description": "The step attribute of the control.", "attribute": "step", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "privacy": "public", "description": "The autofocus attribute of the control.", "attribute": "autofocus" }, { "kind": "field", "name": "autocomplete", "type": { "text": "string" }, "privacy": "public", "description": "The autocomplete attribute of the control.", "attribute": "autocomplete" }, { "kind": "field", "name": "validateOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Enables validation rules to be evaluated without restricting user input. This applies to the `maxLength` property for\nstring-type inputs or allows spin buttons to exceed the predefined `min/max` limits for number-type inputs.", "attribute": "validate-only", "reflects": true }, { "kind": "method", "name": "setRangeText", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "replacement", "type": { "text": "string" } }, { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "selectMode", "default": "'preserve'", "type": { "text": "RangeTextSelectMode" } } ], "description": "Replaces the selected text in the input." }, { "kind": "method", "name": "setSelectionRange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "SelectionRangeDirection" } } ], "description": "Sets the text selection range of the control" }, { "kind": "method", "name": "stepUp", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ], "description": "Increments the numeric value of the input by one or more steps." }, { "kind": "method", "name": "stepDown", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "n", "optional": true, "type": { "text": "number" } } ], "description": "Decrements the numeric value of the input by one or more steps." }, { "kind": "method", "name": "_handleInput", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`input-${nextId++}`", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected", "parameters": [ { "name": "base", "type": { "text": "string" } } ], "description": "Resolves the part names for the container based on the current state.\nUsed to apply conditional styling via CSS parts.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all the text inside the input.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderFileParts", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderPrefix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderSuffix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderMaterial", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderStandard", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "events": [ { "description": "Emitted when the control input receives user input.", "name": "igcInput" }, { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "attributes": [ { "name": "value", "description": "The value of the control.", "fieldName": "value", "attribute": "value", "type": { "text": "string" } }, { "name": "type", "type": { "text": "InputType" }, "default": "'text'", "description": "The type attribute of the control.", "fieldName": "type", "attribute": "type", "expandedType": { "text": "'text' | 'email' | 'number' | 'password' | 'search' | 'tel' | 'url'" } }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly" }, { "name": "inputmode", "type": { "text": "string" }, "description": "The input mode attribute of the control.\nSee [relevant MDN article](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)", "fieldName": "inputMode", "attribute": "inputmode" }, { "name": "pattern", "description": "The pattern attribute of the control.", "fieldName": "pattern", "attribute": "pattern", "type": { "text": "string | undefined" } }, { "name": "minlength", "description": "The minimum string length required by the control.", "fieldName": "minLength", "attribute": "minlength", "type": { "text": "number | undefined" } }, { "name": "maxlength", "description": "The maximum string length of the control.", "fieldName": "maxLength", "attribute": "maxlength", "type": { "text": "number | undefined" } }, { "name": "min", "description": "The min attribute of the control.", "fieldName": "min", "attribute": "min", "type": { "text": "number | undefined" } }, { "name": "max", "description": "The max attribute of the control.", "fieldName": "max", "attribute": "max", "type": { "text": "number | undefined" } }, { "name": "step", "description": "The step attribute of the control.", "fieldName": "step", "attribute": "step", "type": { "text": "number | undefined" } }, { "name": "autofocus", "type": { "text": "boolean" }, "description": "The autofocus attribute of the control.", "fieldName": "autofocus", "attribute": "autofocus" }, { "name": "autocomplete", "type": { "text": "string" }, "description": "The autocomplete attribute of the control.", "fieldName": "autocomplete", "attribute": "autocomplete" }, { "name": "validate-only", "type": { "text": "boolean" }, "default": "false", "description": "Enables validation rules to be evaluated without restricting user input. This applies to the `maxLength` property for\nstring-type inputs or allows spin buttons to exceed the predefined `min/max` limits for number-type inputs.", "fieldName": "validateOnly", "attribute": "validate-only" }, { "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "fieldName": "readOnly" }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "superclass": { "name": "IgcInputBaseComponent", "module": "/src/components/input/input-base.js" }, "tagName": "igc-input", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcInputComponent", "module": "src/components/input/input.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/popover/popover.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcPopoverComponent", "cssParts": [ { "description": "The container wrapping the slotted content in the popover.", "name": "container" } ], "slots": [ { "description": "Content of the popover.", "name": "" }, { "description": "The element the popover will be anchored to.", "name": "anchor" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-popover'" }, { "kind": "field", "name": "_oppositeArrowSide", "privacy": "private", "static": true, "default": "new Map( Object.entries({ top: 'bottom', right: 'left', bottom: 'top', left: 'right', }) )" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_dispose", "type": { "text": "ReturnType | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_target", "type": { "text": "Element | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_container", "type": { "text": "HTMLElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "anchor", "type": { "text": "Element | string | undefined" }, "privacy": "public", "description": "Pass an IDREF or an DOM element reference to use as the\nanchor target for the floating element.", "attribute": "anchor" }, { "kind": "field", "name": "arrow", "type": { "text": "HTMLElement | null" }, "privacy": "public", "default": "null", "description": "Element to render as an \"arrow\" element for the current popover." }, { "kind": "field", "name": "arrowOffset", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "Additional offset to apply to the arrow element if enabled.", "attribute": "arrow-offset" }, { "kind": "field", "name": "inline", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Improves positioning for inline reference elements that span over multiple lines.\nUseful for tooltips or similar components.", "attribute": "inline", "reflects": true }, { "kind": "field", "name": "flip", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When enabled this changes the placement of the floating element in order to keep it\nin view along the main axis.", "attribute": "flip", "reflects": true }, { "kind": "field", "name": "offset", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "Placement modifier which translates the floating element along the main axis.", "attribute": "offset" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The visibility state of the popover component.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "placement", "type": { "text": "PopoverPlacement" }, "privacy": "public", "default": "'bottom-start'", "description": "Where to place the floating element relative to the parent anchor element.", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "kind": "field", "name": "sameWidth", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When enabled the floating element will match the width of its parent anchor element.", "attribute": "same-width", "reflects": true }, { "kind": "field", "name": "shift", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When enabled this tries to shift the floating element along the main axis\nkeeping it in view, preventing overflow while maintaining the desired placement.", "attribute": "shift", "reflects": true }, { "kind": "field", "name": "shiftPadding", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "Virtual padding for the resolved overflow detection offsets in pixels.", "attribute": "shift-padding" }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{\n isDefault,\n }", "type": { "text": "SlotChangeCallbackParameters" } } ] }, { "kind": "method", "name": "_setOpenState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_setPopoverState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "open", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_setDispose", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_clearDispose", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_updateState", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_createMiddleware", "privacy": "private", "return": { "type": { "text": "Middleware[]" } } }, { "kind": "method", "name": "_updatePosition", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_updateArrowPosition", "privacy": "private", "parameters": [ { "name": "placement", "type": { "text": "Placement" } }, { "name": "data", "type": { "text": "MiddlewareData" } } ] } ], "attributes": [ { "name": "anchor", "type": { "text": "Element | string | undefined" }, "description": "Pass an IDREF or an DOM element reference to use as the\nanchor target for the floating element.", "fieldName": "anchor" }, { "name": "arrow-offset", "type": { "text": "number" }, "default": "0", "description": "Additional offset to apply to the arrow element if enabled.", "fieldName": "arrowOffset" }, { "name": "inline", "type": { "text": "boolean" }, "default": "false", "description": "Improves positioning for inline reference elements that span over multiple lines.\nUseful for tooltips or similar components.", "fieldName": "inline" }, { "name": "flip", "type": { "text": "boolean" }, "default": "false", "description": "When enabled this changes the placement of the floating element in order to keep it\nin view along the main axis.", "fieldName": "flip" }, { "name": "offset", "type": { "text": "number" }, "default": "0", "description": "Placement modifier which translates the floating element along the main axis.", "fieldName": "offset" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "The visibility state of the popover component.", "fieldName": "open" }, { "name": "placement", "type": { "text": "PopoverPlacement" }, "default": "'bottom-start'", "description": "Where to place the floating element relative to the parent anchor element.", "fieldName": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "name": "same-width", "type": { "text": "boolean" }, "default": "false", "description": "When enabled the floating element will match the width of its parent anchor element.", "fieldName": "sameWidth" }, { "name": "shift", "type": { "text": "boolean" }, "default": "false", "description": "When enabled this tries to shift the floating element along the main axis\nkeeping it in view, preventing overflow while maintaining the desired placement.", "fieldName": "shift" }, { "name": "shift-padding", "type": { "text": "number" }, "default": "0", "description": "Virtual padding for the resolved overflow detection offsets in pixels.", "fieldName": "shiftPadding" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-popover", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcPopoverComponent", "module": "src/components/popover/popover.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chip/chip.ts", "declarations": [ { "kind": "class", "description": "Chips help people enter information, make selections, filter content, or trigger actions.", "name": "IgcChipComponent", "cssParts": [ { "description": "The base wrapper of the chip.", "name": "base" }, { "description": "The prefix container of the chip.", "name": "prefix" }, { "description": "The suffix container of the chip.", "name": "suffix" } ], "slots": [ { "description": "Renders content in the default slot of the chip.", "name": "" }, { "description": "Renders content at the start of the chip, before the default content.", "name": "prefix" }, { "description": "Renders content at the end of the chip after the default content.", "name": "suffix" }, { "description": "Content to render when the chip in selected state.", "name": "select" }, { "description": "Content to override the default remove chip icon.", "name": "remove" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-chip'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_removePartRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the disabled state for the chip.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "removable", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Defines if the chip is removable or not.", "attribute": "removable", "reflects": true }, { "kind": "field", "name": "selectable", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Defines if the chip is selectable or not.", "attribute": "selectable", "reflects": true }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Defines if the chip is selected or not.", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "StyleVariant" }, "privacy": "public", "description": "A property that sets the color variant of the chip component.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "attribute": "locale" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.\nCurrently only aria-labels for the default select/remove icons are localized.", "type": { "text": "IChipResourceStrings" } }, { "kind": "field", "name": "_i18nController", "privacy": "private", "readonly": true }, { "kind": "method", "name": "_handleSelect", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleRemove", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_renderPrefix", "privacy": "protected" }, { "kind": "method", "name": "_renderSuffix", "privacy": "protected" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emits an event when the chip component is removed. Returns the removed chip component.", "name": "igcRemove" }, { "description": "Emits event when the chip component is selected/deselected and any related animations and transitions also end.", "name": "igcSelect" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Sets the disabled state for the chip.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the chip is removable or not.", "fieldName": "removable", "attribute": "removable" }, { "name": "selectable", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the chip is selectable or not.", "fieldName": "selectable", "attribute": "selectable" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the chip is selected or not.", "fieldName": "selected", "attribute": "selected" }, { "name": "variant", "type": { "text": "StyleVariant" }, "description": "A property that sets the color variant of the chip component.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" } }, { "name": "locale", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "fieldName": "locale", "attribute": "locale" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-chip", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcChipComponent", "module": "src/components/chip/chip.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-range-picker/predefined-ranges-area.ts", "declarations": [ { "kind": "class", "description": "The predefined ranges area component is used within the `igc-date-range picker` element and it\ndisplays a set of chips with predefined date ranges. The component allows users to quickly select\na predefined date range value. Users can also provide custom ranges to be displayed as chips.", "name": "IgcPredefinedRangesAreaComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-predefined-ranges-area'" }, { "kind": "field", "name": "_i18nController", "privacy": "private", "readonly": true }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_predefinedRanges", "type": { "text": "CustomDateRange[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "usePredefinedRanges", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will show chips with predefined ranges.", "attribute": "use-predefined-ranges", "reflects": true }, { "kind": "field", "name": "customRanges", "type": { "text": "CustomDateRange[]" }, "privacy": "public", "default": "[]", "description": "Renders chips with custom ranges based on the elements of the array." }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings of the date range area component.", "type": { "text": "IgcDateRangePickerResourceStrings" } }, { "kind": "method", "name": "_updatePredefinedRanges", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleRangeSelect", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "range", "type": { "text": "DateRangeValue" } } ] }, { "kind": "method", "name": "_renderDateRanges", "privacy": "protected" } ], "events": [ { "name": "igcRangeSelect", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "use-predefined-ranges", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will show chips with predefined ranges.", "fieldName": "usePredefinedRanges", "attribute": "use-predefined-ranges" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-predefined-ranges-area", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcPredefinedRangesAreaComponent", "module": "src/components/date-range-picker/predefined-ranges-area.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-range-picker/validators.ts", "declarations": [ { "kind": "variable", "name": "minDateRangeValidator", "type": { "text": "Validator<{\n value?: DateRangeValue | null;\n min?: Date | null;\n}>" }, "default": "{ key: 'rangeUnderflow', message: ({ min }) => formatString(ValidationResourceStringsEN.min_validation_error!, min), isValid: ({ value, min }) => { if (!min) { return true; } const isStartInvalid = value?.start && CalendarDay.compare(value.start, min) < 0; const isEndInvalid = value?.end && CalendarDay.compare(value.end, min) < 0; return !(isStartInvalid || isEndInvalid); }, }" }, { "kind": "variable", "name": "maxDateRangeValidator", "type": { "text": "Validator<{\n value?: DateRangeValue | null;\n max?: Date | null;\n}>" }, "default": "{ key: 'rangeOverflow', message: ({ max }) => formatString(ValidationResourceStringsEN.max_validation_error!, max), isValid: ({ value, max }) => { if (!max) { return true; } const isStartInvalid = value?.start && CalendarDay.compare(value.start, max) > 0; const isEndInvalid = value?.end && CalendarDay.compare(value.end, max) > 0; return !(isStartInvalid || isEndInvalid); }, }" }, { "kind": "variable", "name": "requiredDateRangeValidator", "type": { "text": "Validator<{\n required: boolean;\n value: DateRangeValue | null;\n}>" }, "default": "{ key: 'valueMissing', message: ValidationResourceStringsEN.required_validation_error!, isValid: ({ required, value }) => { return required ? isCompleteDateRange(value) : true; }, }" }, { "kind": "variable", "name": "badInputDateRangeValidator", "type": { "text": "Validator<{\n required: boolean;\n value: DateRangeValue | null;\n disabledDates?: DateRangeDescriptor[];\n}>" }, "default": "{ key: 'badInput', message: ({ value }) => formatString( ValidationResourceStringsEN.disabled_date_validation_error!, value ), isValid: ({ value, disabledDates }) => { if ( !isCompleteDateRange(value) || !disabledDates || isEmpty(disabledDates) ) { return true; } return Array.from( calendarRange({ start: value.start, end: value.end, inclusive: true }) ).every((date) => !isDateInRanges(date, disabledDates)); }, }" }, { "kind": "variable", "name": "dateRangeValidators", "type": { "text": "Validator[]" }, "default": "[ requiredDateRangeValidator, minDateRangeValidator, maxDateRangeValidator, badInputDateRangeValidator, ]" }, { "kind": "function", "name": "isCompleteDateRange", "return": { "type": { "text": "value is { start: Date; end: Date }" } }, "parameters": [ { "name": "value", "type": { "text": "DateRangeValue | null" } } ] } ], "exports": [ { "kind": "js", "name": "minDateRangeValidator", "declaration": { "name": "minDateRangeValidator", "module": "src/components/date-range-picker/validators.ts" } }, { "kind": "js", "name": "maxDateRangeValidator", "declaration": { "name": "maxDateRangeValidator", "module": "src/components/date-range-picker/validators.ts" } }, { "kind": "js", "name": "requiredDateRangeValidator", "declaration": { "name": "requiredDateRangeValidator", "module": "src/components/date-range-picker/validators.ts" } }, { "kind": "js", "name": "badInputDateRangeValidator", "declaration": { "name": "badInputDateRangeValidator", "module": "src/components/date-range-picker/validators.ts" } }, { "kind": "js", "name": "dateRangeValidators", "declaration": { "name": "dateRangeValidators", "module": "src/components/date-range-picker/validators.ts" } }, { "kind": "js", "name": "isCompleteDateRange", "declaration": { "name": "isCompleteDateRange", "module": "src/components/date-range-picker/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-range-picker/date-range-picker.ts", "declarations": [ { "kind": "class", "description": "The igc-date-range-picker allows the user to select a range of dates.", "name": "IgcDateRangePickerComponent", "cssParts": [ { "description": "The separator element between the two inputs.", "name": "separator" }, { "description": "The wrapper that renders the custom and predefined ranges.", "name": "ranges" }, { "description": "The label wrapper that renders content above the target input.", "name": "label" }, { "description": "The calendar icon wrapper for closed state (single input).", "name": "calendar-icon" }, { "description": "The calendar icon wrapper for closed state for the start input (two inputs).", "name": "calendar-icon-start" }, { "description": "The calendar icon wrapper for closed state for the end input (two inputs).", "name": "calendar-icon-end" }, { "description": "The calendar icon wrapper for opened state (single input).", "name": "calendar-icon-open" }, { "description": "The calendar icon wrapper for opened state for the start input (two inputs).", "name": "calendar-icon-open-start" }, { "description": "The calendar icon wrapper for opened state for the end input (two inputs).", "name": "calendar-icon-open-end" }, { "description": "The clear icon wrapper (single input).", "name": "clear-icon" }, { "description": "The clear icon wrapper for the start input (two inputs).", "name": "clear-icon-start" }, { "description": "The clear icon wrapper for the end input (two inputs).", "name": "clear-icon-end" }, { "description": "The wrapper for the custom actions area.", "name": "actions" }, { "description": "The clear icon wrapper.", "name": "clear-icon" }, { "description": "The native input element.", "name": "input" }, { "description": "The prefix wrapper.", "name": "prefix" }, { "description": "The suffix wrapper.", "name": "suffix" }, { "description": "The helper-text wrapper that renders content below the target input.", "name": "helper-text" }, { "description": "The calendar header element.", "name": "header" }, { "description": "The calendar header title element.", "name": "header-title" }, { "description": "The calendar header date element.", "name": "header-date" }, { "description": "The calendar content element which contains the views and navigation elements.", "name": "calendar-content" }, { "description": "The calendar navigation container element.", "name": "navigation" }, { "description": "The calendar months navigation button element.", "name": "months-navigation" }, { "description": "The calendar years navigation button element.", "name": "years-navigation" }, { "description": "The calendar years range element.", "name": "years-range" }, { "description": "The calendar navigation buttons container.", "name": "navigation-buttons" }, { "description": "The calendar previous/next navigation button.", "name": "navigation-button" }, { "description": "The calendar days view container element.", "name": "days-view-container" }, { "description": "The calendar days view element.", "name": "days-view" }, { "description": "The calendar months view element.", "name": "months-view" }, { "description": "The calendar years view element.", "name": "years-view" }, { "description": "The calendar days row element.", "name": "days-row" }, { "description": "The calendar week header label element.", "name": "calendar-label" }, { "description": "The calendar week number element.", "name": "week-number" }, { "description": "The calendar week number inner element.", "name": "week-number-inner" }, { "description": "The calendar date element.", "name": "date" }, { "description": "The calendar date inner element.", "name": "date-inner" }, { "description": "The calendar first selected date element in range selection.", "name": "first" }, { "description": "The calendar last selected date element in range selection.", "name": "last" }, { "description": "The calendar inactive date element.", "name": "inactive" }, { "description": "The calendar hidden date element.", "name": "hidden" }, { "description": "The calendar weekend date element.", "name": "weekend" }, { "description": "The calendar range selected element.", "name": "range" }, { "description": "The calendar special date element.", "name": "special" }, { "description": "The calendar disabled date element.", "name": "disabled" }, { "description": "The calendar single selected date element.", "name": "single" }, { "description": "The calendar range selection preview date element.", "name": "preview" }, { "description": "The calendar month element.", "name": "month" }, { "description": "The calendar month inner element.", "name": "month-inner" }, { "description": "The calendar year element.", "name": "year" }, { "description": "The calendar year inner element.", "name": "year-inner" }, { "description": "The calendar selected state for element(s). Applies to date, month and year elements.", "name": "selected" }, { "description": "The calendar current state for element(s). Applies to date, month and year elements.", "name": "current" } ], "slots": [ { "description": "Renders content before the input (single input).", "name": "prefix" }, { "description": "Renders content before the start input (two inputs).", "name": "prefix-start" }, { "description": "Renders content before the end input (two inputs).", "name": "prefix-end" }, { "description": "Renders content after the input (single input).", "name": "suffix" }, { "description": "Renders content after the start input (single input).", "name": "suffix-start" }, { "description": "Renders content after the end input (single input).", "name": "suffix-end" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the value is in the disabledDates ranges.", "name": "bad-input" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when the max validation fails.", "name": "range-overflow" }, { "description": "Renders content when the min validation fails.", "name": "range-underflow" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" }, { "description": "Renders content in the calendar title.", "name": "title" }, { "description": "Renders content instead of the current date/range in the calendar header.", "name": "header-date" }, { "description": "Renders a clear icon template.", "name": "clear-icon" }, { "description": "Renders a clear icon template for the start input (two inputs).", "name": "clear-icon-start" }, { "description": "Renders a clear icon template for the end input (two inputs).", "name": "clear-icon-end" }, { "description": "Renders the icon/content for the calendar picker.", "name": "calendar-icon" }, { "description": "Renders the icon/content for the calendar picker for the start input (two inputs).", "name": "calendar-icon-start" }, { "description": "Renders the icon/content for the calendar picker for the end input (two inputs).", "name": "calendar-icon-end" }, { "description": "Renders the icon/content for the picker in open state.", "name": "calendar-icon-open" }, { "description": "Renders the icon/content for the picker in open state for the start input (two inputs).", "name": "calendar-icon-open-start" }, { "description": "Renders the icon/content for the picker in open state for the end input (two inputs).", "name": "calendar-icon-open-end" }, { "description": "Renders content in the action part of the picker in open state.", "name": "actions" }, { "description": "Renders the separator element between the two inputs.", "name": "separator" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-date-range-picker'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`date-range-picker-${nextId++}`" }, { "kind": "field", "name": "_themes", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_rootClickController", "type": { "text": "RootClickController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true, "description": "For now we use the core validation strings internally only, to avoid mixing with old resources by users.\nTo Do: Update resourceStrings type when the IgcDateRangePickerResourceStrings is changed to IDateRangePickerResourceStrings" }, { "kind": "field", "name": "_activeDate", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_min", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_max", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_disabledDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_dateConstraints", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_defaultDisplayFormat", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "_displayFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_inputFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_placeholder", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_defaultMask", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "_oldValue", "type": { "text": "DateRangeValue | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_visibleMonths", "type": { "text": "number" }, "privacy": "private", "default": "2" }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isDropDown", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_firstDefinedInRange", "type": { "text": "Date | null" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_maskedRangeValue", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_inputs", "type": { "text": "IgcDateTimeInputComponent[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_input", "type": { "text": "IgcInputComponent" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_calendar", "type": { "text": "IgcCalendarComponent" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_prefixes", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_startPrefixes", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_endPrefixes", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_suffixes", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_startSuffixes", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_endSuffixes", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_actions", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_headerDateSlotItems", "type": { "text": "HTMLElement[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value of the picker", "attribute": "value", "type": { "text": "DateRangeValue | null" } }, { "kind": "field", "name": "customRanges", "type": { "text": "CustomDateRange[]" }, "privacy": "public", "default": "[]", "description": "Renders chips with custom ranges based on the elements of the array." }, { "kind": "field", "name": "mode", "type": { "text": "PickerMode" }, "privacy": "public", "default": "'dropdown'", "description": "Determines whether the calendar is opened in a dropdown or a modal dialog", "attribute": "mode", "expandedType": { "text": "'dropdown' | 'dialog'" } }, { "kind": "field", "name": "useTwoInputs", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Use two inputs to display the date range values. Makes the input editable in dropdown mode.", "attribute": "use-two-inputs", "reflects": true }, { "kind": "field", "name": "usePredefinedRanges", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will show chips with predefined ranges.", "attribute": "use-predefined-ranges", "reflects": true }, { "kind": "field", "name": "locale", "privacy": "public", "description": "The locale settings used to display the value.", "attribute": "locale" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings of the date range picker.", "type": { "text": "IgcDateRangePickerResourceStrings" } }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "reflects": true }, { "kind": "field", "name": "nonEditable", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to allow typing in the input.", "attribute": "non-editable", "reflects": true }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label of the control (single input).", "attribute": "label" }, { "kind": "field", "name": "labelStart", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The label attribute of the start input.", "attribute": "label-start" }, { "kind": "field", "name": "labelEnd", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The label attribute of the end input.", "attribute": "label-end" }, { "kind": "field", "name": "placeholder", "privacy": "public", "description": "The placeholder attribute of the control (single input).", "attribute": "placeholder", "type": { "text": "string" } }, { "kind": "field", "name": "placeholderStart", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The placeholder attribute of the start input.", "attribute": "placeholder-start" }, { "kind": "field", "name": "placeholderEnd", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The placeholder attribute of the end input.", "attribute": "placeholder-end" }, { "kind": "field", "name": "prompt", "type": { "text": "string" }, "privacy": "public", "default": "'_'", "description": "The prompt symbol to use for unfilled parts of the mask.", "attribute": "prompt" }, { "kind": "field", "name": "displayFormat", "privacy": "public", "description": "Format to display the value in when not editing.\nDefaults to the locale format if not set.", "attribute": "display-format", "type": { "text": "string" } }, { "kind": "field", "name": "inputFormat", "privacy": "public", "description": "The date format to apply on the inputs.\nDefaults to the current locale Intl.DateTimeFormat", "attribute": "input-format", "type": { "text": "string" } }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum value required for the date range picker to remain valid.", "attribute": "min", "type": { "text": "Date | null" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value required for the date range picker to remain valid.", "attribute": "max", "type": { "text": "Date | null" } }, { "kind": "field", "name": "disabledDates", "privacy": "public", "description": "Gets/sets disabled dates." }, { "kind": "field", "name": "visibleMonths", "type": { "text": "number" }, "privacy": "public", "description": "The number of months displayed in the calendar.", "attribute": "visible-months" }, { "kind": "field", "name": "headerOrientation", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the calendar header.", "attribute": "header-orientation", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "orientation", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the multiple months displayed in the calendar's days view.", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "hideHeader", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the calendar hides its header.", "attribute": "hide-header", "reflects": true }, { "kind": "field", "name": "activeDate", "privacy": "public", "description": "Gets/Sets the date which is shown in the calendar picker and is highlighted.\nBy default it is the current date.", "type": { "text": "Date" }, "attribute": "active-date" }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show the number of the week in the calendar.", "attribute": "show-week-numbers", "reflects": true }, { "kind": "field", "name": "hideOutsideDays", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Controls the visibility of the dates that do not belong to the current month.", "attribute": "hide-outside-days", "reflects": true }, { "kind": "field", "name": "specialDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "public", "description": "Gets/sets special dates." }, { "kind": "field", "name": "weekStart", "type": { "text": "WeekDays" }, "privacy": "public", "default": "'sunday'", "description": "Sets the start day of the week for the calendar.", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "clear", "privacy": "public", "description": "Clears the input parts of the component of any user input" }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "DateRangeValue | null" } } ], "description": "Selects a date range value in the picker" }, { "kind": "method", "name": "_openChange", "privacy": "protected" }, { "kind": "method", "name": "_updateDefaultMask", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updateDateRange", "privacy": "protected" }, { "kind": "method", "name": "_modeChanged", "privacy": "protected" }, { "kind": "method", "name": "_handleClosing", "privacy": "protected" }, { "kind": "method", "name": "_handleDialogClosing", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_handleDialogClosed", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_dialogCancel", "privacy": "protected" }, { "kind": "method", "name": "_dialogDone", "privacy": "protected" }, { "kind": "method", "name": "_handleInputEvent", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleInputChangeEvent", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleFocusOut", "privacy": "protected", "parameters": [ { "name": "{ relatedTarget }", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "_handleInputClick", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_onEscapeKey", "privacy": "protected" }, { "kind": "method", "name": "handleAnchorClick", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_handleCalendarChangeEvent", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleCalendarIconSlotPointerDown", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_revertValue", "privacy": "protected" }, { "kind": "method", "name": "_setCalendarActiveDateAndViewIndex", "privacy": "private", "description": "Sets the active date of the calendar based on current selection, if any,\nor its current active date and its active day view index to always be the first one." }, { "kind": "method", "name": "_getUpdatedDateRange", "privacy": "private", "return": { "type": { "text": "DateRangeValue" } }, "parameters": [ { "name": "input", "type": { "text": "IgcDateTimeInputComponent" } }, { "name": "newValue", "type": { "text": "Date | null" } } ] }, { "kind": "method", "name": "_delegateInputsValidity", "privacy": "private" }, { "kind": "method", "name": "_setDateConstraints", "privacy": "private" }, { "kind": "method", "name": "_updateMaskedRangeValue", "privacy": "private" }, { "kind": "method", "name": "_setCalendarRangeValues", "privacy": "private" }, { "kind": "method", "name": "_swapDates", "privacy": "private", "return": { "type": { "text": "DateRangeValue" } }, "parameters": [ { "name": "range", "type": { "text": "DateRangeValue" } } ] }, { "kind": "method", "name": "_shouldCloseCalendarDropdown", "privacy": "private" }, { "kind": "method", "name": "_select", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "DateRangeValue | null" } }, { "name": "emitEvent", "default": "false" } ] }, { "kind": "method", "name": "_renderClearIcon", "privacy": "private", "parameters": [ { "name": "picker", "default": "'start'", "type": { "text": "DateRangePickerInput" } } ] }, { "kind": "method", "name": "_renderCalendarIcon", "privacy": "private", "parameters": [ { "name": "picker", "default": "'start'", "type": { "text": "DateRangePickerInput" } } ] }, { "kind": "method", "name": "_renderCalendarSlots", "privacy": "private" }, { "kind": "method", "name": "_renderCalendar", "privacy": "private", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderActions", "privacy": "protected" }, { "kind": "method", "name": "_renderPredefinedRanges", "privacy": "protected" }, { "kind": "method", "name": "_renderPicker", "privacy": "protected", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderHelperText", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "parameters": [ { "name": "id", "type": { "text": "string" } }, { "name": "picker", "default": "'start'", "type": { "text": "DateRangePickerInput" } } ] }, { "kind": "method", "name": "_renderInputs", "privacy": "private", "parameters": [ { "name": "idStart", "type": { "text": "string" } }, { "name": "idEnd", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderSingleInput", "privacy": "private", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "type": { "text": "<\n K extends keyof IgcBaseComboBoxEventMap,\n D extends UnpackCustomEvent,\n >(\n event: K,\n eventInitDict?: CustomEventInit\n ) => boolean" }, "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnSelect", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "attribute": "keep-open-on-select", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnOutsideClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "attribute": "keep-open-on-outside-click", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the open state of the component.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosing", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosed", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpening", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpened", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_hide", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_show", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "events": [ { "description": "Emitted just before the calendar dropdown is shown.", "name": "igcOpening" }, { "description": "Emitted after the calendar dropdown is shown.", "name": "igcOpened" }, { "description": "Emitted just before the calendar dropdown is hidden.", "name": "igcClosing" }, { "description": "Emitted after the calendar dropdown is hidden.", "name": "igcClosed" }, { "description": "Emitted when the user modifies and commits the elements's value.", "name": "igcChange" }, { "description": "Emitted when when the user types in the element.", "name": "igcInput" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "value", "description": "The value of the picker", "fieldName": "value", "attribute": "value", "type": { "text": "DateRangeValue | null" } }, { "name": "mode", "type": { "text": "PickerMode" }, "default": "'dropdown'", "description": "Determines whether the calendar is opened in a dropdown or a modal dialog", "fieldName": "mode", "attribute": "mode", "expandedType": { "text": "'dropdown' | 'dialog'" } }, { "name": "use-two-inputs", "type": { "text": "boolean" }, "default": "false", "description": "Use two inputs to display the date range values. Makes the input editable in dropdown mode.", "fieldName": "useTwoInputs", "attribute": "use-two-inputs" }, { "name": "usePredefinedRanges", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will show chips with predefined ranges.", "fieldName": "usePredefinedRanges" }, { "name": "locale", "description": "The locale settings used to display the value.", "fieldName": "locale", "attribute": "locale" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly", "attribute": "readonly" }, { "name": "non-editable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow typing in the input.", "fieldName": "nonEditable", "attribute": "non-editable" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "label", "type": { "text": "string" }, "description": "The label of the control (single input).", "fieldName": "label", "attribute": "label" }, { "name": "label-start", "type": { "text": "string" }, "default": "''", "description": "The label attribute of the start input.", "fieldName": "labelStart", "attribute": "label-start" }, { "name": "label-end", "type": { "text": "string" }, "default": "''", "description": "The label attribute of the end input.", "fieldName": "labelEnd", "attribute": "label-end" }, { "name": "placeholder", "description": "The placeholder attribute of the control (single input).", "fieldName": "placeholder", "attribute": "placeholder", "type": { "text": "string" } }, { "name": "placeholder-start", "type": { "text": "string" }, "default": "''", "description": "The placeholder attribute of the start input.", "fieldName": "placeholderStart", "attribute": "placeholder-start" }, { "name": "placeholder-end", "type": { "text": "string" }, "default": "''", "description": "The placeholder attribute of the end input.", "fieldName": "placeholderEnd", "attribute": "placeholder-end" }, { "name": "prompt", "type": { "text": "string" }, "default": "'_'", "description": "The prompt symbol to use for unfilled parts of the mask.", "fieldName": "prompt", "attribute": "prompt" }, { "name": "display-format", "description": "Format to display the value in when not editing.\nDefaults to the locale format if not set.", "fieldName": "displayFormat", "attribute": "display-format", "type": { "text": "string" } }, { "name": "input-format", "description": "The date format to apply on the inputs.\nDefaults to the current locale Intl.DateTimeFormat", "fieldName": "inputFormat", "attribute": "input-format", "type": { "text": "string" } }, { "name": "min", "description": "The minimum value required for the date range picker to remain valid.", "fieldName": "min", "attribute": "min", "type": { "text": "Date | null" } }, { "name": "max", "description": "The maximum value required for the date range picker to remain valid.", "fieldName": "max", "attribute": "max", "type": { "text": "Date | null" } }, { "name": "visible-months", "type": { "text": "number" }, "description": "The number of months displayed in the calendar.", "fieldName": "visibleMonths", "attribute": "visible-months" }, { "name": "header-orientation", "type": { "text": "ContentOrientation" }, "default": "'horizontal'", "description": "The orientation of the calendar header.", "fieldName": "headerOrientation", "attribute": "header-orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "orientation", "type": { "text": "ContentOrientation" }, "default": "'horizontal'", "description": "The orientation of the multiple months displayed in the calendar's days view.", "fieldName": "orientation", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "hide-header", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the calendar hides its header.", "fieldName": "hideHeader", "attribute": "hide-header" }, { "name": "show-week-numbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the number of the week in the calendar.", "fieldName": "showWeekNumbers", "attribute": "show-week-numbers" }, { "name": "hide-outside-days", "type": { "text": "boolean" }, "default": "false", "description": "Controls the visibility of the dates that do not belong to the current month.", "fieldName": "hideOutsideDays", "attribute": "hide-outside-days" }, { "name": "use-predefined-ranges", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will show chips with predefined ranges.", "attribute": "usePredefinedRanges", "fieldName": "usePredefinedRanges" }, { "name": "active-date", "description": "Gets/Sets the date which is shown in the calendar picker and is highlighted.\nBy default it is the current date.", "type": { "text": "Date" }, "fieldName": "activeDate" }, { "name": "week-start", "type": { "text": "WeekDays" }, "default": "'sunday'", "description": "Sets the start day of the week for the calendar.", "fieldName": "weekStart", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "keep-open-on-select", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "fieldName": "keepOpenOnSelect", "attribute": "keep-open-on-select", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "keep-open-on-outside-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "fieldName": "keepOpenOnOutsideClick", "attribute": "keep-open-on-outside-click", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the component.", "fieldName": "open", "attribute": "open", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "mixins": [ { "name": "FormAssociatedRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcBaseComboBoxLikeComponent", "module": "/src/components/common/mixins/combo-box.js" }, "tagName": "igc-date-range-picker", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDateRangePickerComponent", "module": "src/components/date-range-picker/date-range-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/calendar/helpers.ts", "declarations": [ { "kind": "variable", "name": "MONTHS_PER_ROW", "type": { "text": "number" }, "default": "3" }, { "kind": "variable", "name": "YEARS_PER_ROW", "type": { "text": "number" }, "default": "3" }, { "kind": "variable", "name": "YEARS_PER_PAGE", "type": { "text": "number" }, "default": "15" }, { "kind": "function", "name": "isValidDate", "return": { "type": { "text": "value is Date" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ], "description": "Type guard to check if a value is a valid Date object." }, { "kind": "function", "name": "parseISODate", "return": { "type": { "text": "Date | null" } }, "parameters": [ { "name": "string", "type": { "text": "string" } } ] }, { "kind": "function", "name": "convertToDate", "return": { "type": { "text": "Date | null" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "Date | string | null" } } ], "description": "Converts the given value to a Date object.\n\nIf the value is already a valid Date object, it is returned directly.\nIf the value is a string, it is parsed into a Date object.\nIf the value is null or undefined, null is returned.\nIf the parsing fails, null is returned." }, { "kind": "function", "name": "convertToDateRange", "return": { "type": { "text": "DateRangeValue | null" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "DateRangeValue | string | null" } } ], "description": "Converts the given value to a DateRangeValue object.\n\nIf the value is already a valid DateRangeValue object, it is returned directly.\nIf the value is a string, it is parsed to object and returned if it fields are valid dates.\nIf the value is null or undefined, null is returned.\nIf the parsing fails, null is returned." }, { "kind": "function", "name": "getDateFormValue", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "value", "type": { "text": "Date | null" } } ], "description": "Converts a Date object to an ISO 8601 string.\n\nIf the `value` is a `Date` object, it is converted to an ISO 8601 string.\nIf the `value` is null or undefined, null is returned." }, { "kind": "function", "name": "convertToDates", "return": { "type": { "text": "Date[] | null" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "(Date | string)[] | string | null" } } ], "description": "Converts a comma-separated string of ISO 8601 dates or an array of Date objects | ISO 8601 strings into\nan array of Date objects.\n\nIf the `value` is null or undefined, null is returned.\nIf the `value` is an array of `Date` objects, a filtered array of valid `Date` objects is returned.\nIf the `value` is a string, it is split by commas and each part is parsed into a `Date` object.\nIf the parsing fails for any date, it is skipped." }, { "kind": "function", "name": "getViewElement", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "description": "Returns the value of the selected/activated element (day/month/year) in the calendar view." }, { "kind": "function", "name": "getWeekDayNumber", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "value", "type": { "text": "WeekDays" } } ] }, { "kind": "function", "name": "areSameMonth", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "first", "type": { "text": "DayParameter" } }, { "name": "second", "type": { "text": "DayParameter" } } ] }, { "kind": "function", "name": "isNextMonth", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "target", "type": { "text": "DayParameter" } }, { "name": "origin", "type": { "text": "DayParameter" } } ] }, { "kind": "function", "name": "isPreviousMonth", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "target", "type": { "text": "DayParameter" } }, { "name": "origin", "type": { "text": "DayParameter" } } ] }, { "kind": "function", "name": "calendarRange", "return": { "type": { "text": "Generator" } }, "parameters": [ { "name": "options", "type": { "text": "CalendarRangeParams" } } ], "description": "Returns a generator yielding day values between `start` and `end` (non-inclusive by default)\nby a given `unit` as a step.\nTo include the end date set the `inclusive` option to true." }, { "kind": "function", "name": "generateMonth", "return": { "type": { "text": "Generator" } }, "parameters": [ { "name": "value", "type": { "text": "DayParameter" } }, { "name": "firstWeekDay", "type": { "text": "number" } } ] }, { "kind": "function", "name": "getYearRange", "return": { "type": { "text": "{ start: number; end: number }" } }, "parameters": [ { "name": "current", "type": { "text": "DayParameter" } }, { "name": "range", "type": { "text": "number" } } ] }, { "kind": "function", "name": "isDateInRanges", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "date", "type": { "text": "DayParameter" } }, { "name": "ranges", "type": { "text": "DateRangeDescriptor[]" } } ] }, { "kind": "function", "name": "createDateConstraints", "return": { "type": { "text": "DateRangeDescriptor[] | undefined" } }, "parameters": [ { "name": "min", "type": { "text": "Date | null" } }, { "name": "max", "type": { "text": "Date | null" } }, { "name": "disabledDates", "optional": true, "type": { "text": "DateRangeDescriptor[]" } } ] }, { "kind": "function", "name": "isDateExceedingMax", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "Date" } }, { "name": "maxValue", "type": { "text": "Date" } }, { "name": "includeTime", "default": "true" }, { "name": "includeDate", "default": "true" } ], "description": "Checks if a date is greater than a maximum date value." }, { "kind": "function", "name": "isDateLessThanMin", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "value", "type": { "text": "Date" } }, { "name": "minValue", "type": { "text": "Date" } }, { "name": "includeTime", "default": "true" }, { "name": "includeDate", "default": "true" } ], "description": "Checks if a date is less than a minimum date value." } ], "exports": [ { "kind": "js", "name": "MONTHS_PER_ROW", "declaration": { "name": "MONTHS_PER_ROW", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "YEARS_PER_ROW", "declaration": { "name": "YEARS_PER_ROW", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "YEARS_PER_PAGE", "declaration": { "name": "YEARS_PER_PAGE", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "isValidDate", "declaration": { "name": "isValidDate", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "parseISODate", "declaration": { "name": "parseISODate", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "convertToDate", "declaration": { "name": "convertToDate", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "convertToDateRange", "declaration": { "name": "convertToDateRange", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "getDateFormValue", "declaration": { "name": "getDateFormValue", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "convertToDates", "declaration": { "name": "convertToDates", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "getViewElement", "declaration": { "name": "getViewElement", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "getWeekDayNumber", "declaration": { "name": "getWeekDayNumber", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "areSameMonth", "declaration": { "name": "areSameMonth", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "isNextMonth", "declaration": { "name": "isNextMonth", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "isPreviousMonth", "declaration": { "name": "isPreviousMonth", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "calendarRange", "declaration": { "name": "calendarRange", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "generateMonth", "declaration": { "name": "generateMonth", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "getYearRange", "declaration": { "name": "getYearRange", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "isDateInRanges", "declaration": { "name": "isDateInRanges", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "createDateConstraints", "declaration": { "name": "createDateConstraints", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "isDateExceedingMax", "declaration": { "name": "isDateExceedingMax", "module": "src/components/calendar/helpers.ts" } }, { "kind": "js", "name": "isDateLessThanMin", "declaration": { "name": "isDateLessThanMin", "module": "src/components/calendar/helpers.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/forms/form-transformers.ts", "declarations": [ { "kind": "variable", "name": "FormValueDefaultTransformers", "type": { "text": "FormValueTransformers" }, "default": "{ setValue: (value) => value || '', getValue: (value) => value, setDefaultValue: (value) => value || '', getDefaultValue: (value) => value, setFormValue: (value, _) => value || null, }" }, { "kind": "variable", "name": "FormValueBooleanTransformers", "type": { "text": "Partial<\n FormValueTransformers\n>" }, "default": "{ setValue: Boolean, setDefaultValue: Boolean, setFormValue: (checked, host) => checked && 'value' in host ? (host.value as string) || 'on' : null, }" }, { "kind": "variable", "name": "FormValueNumberTransformers", "type": { "text": "Partial<\n FormValueTransformers\n>" }, "default": "{ setValue: asNumber, setDefaultValue: asNumber, setFormValue: (value) => value.toString(), }" }, { "kind": "variable", "name": "FormValueDateTimeTransformers", "type": { "text": "Partial<\n FormValueTransformers\n>" }, "default": "{ setValue: convertToDate, setDefaultValue: convertToDate, setFormValue: getDateFormValue, }" }, { "kind": "variable", "name": "FormValueDateRangeTransformers", "type": { "text": "Partial<\n FormValueTransformers\n>" }, "default": "{ setValue: convertToDateRange, setDefaultValue: convertToDateRange, setFormValue: (value, host) => { if (!host.name) { return null; } const start = value?.start?.toISOString(); const end = value?.end?.toISOString(); const formData = new FormData(); if (start) { formData.append(`${host.name}-start`, start); } if (end) { formData.append(`${host.name}-end`, end); } return formData; }, }" }, { "kind": "variable", "name": "FormValueFileListTransformers", "type": { "text": "FormValueTransformers" }, "default": "{ setValue: (value) => value || null, getValue: (value) => value, setDefaultValue: (value) => value || null, getDefaultValue: (value) => value, setFormValue: (files, host) => { if (!(host.name && files)) { return null; } const formData = new FormData(); for (const file of files) { formData.append(host.name, file); } return formData; }, }" }, { "kind": "variable", "name": "FormValueSelectTransformers", "type": { "text": "Partial<\n FormValueTransformers\n>" }, "default": "{ setValue: (value) => value || undefined, setDefaultValue: (value) => value || undefined, }" } ], "exports": [ { "kind": "js", "name": "FormValueDefaultTransformers", "declaration": { "name": "FormValueDefaultTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } }, { "kind": "js", "name": "FormValueBooleanTransformers", "declaration": { "name": "FormValueBooleanTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } }, { "kind": "js", "name": "FormValueNumberTransformers", "declaration": { "name": "FormValueNumberTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } }, { "kind": "js", "name": "FormValueDateTimeTransformers", "declaration": { "name": "FormValueDateTimeTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } }, { "kind": "js", "name": "FormValueDateRangeTransformers", "declaration": { "name": "FormValueDateRangeTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } }, { "kind": "js", "name": "FormValueFileListTransformers", "declaration": { "name": "FormValueFileListTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } }, { "kind": "js", "name": "FormValueSelectTransformers", "declaration": { "name": "FormValueSelectTransformers", "module": "src/components/common/mixins/forms/form-transformers.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/file-input/validators.ts", "declarations": [ { "kind": "variable", "name": "fileValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, ]" } ], "exports": [ { "kind": "js", "name": "fileValidators", "declaration": { "name": "fileValidators", "module": "src/components/file-input/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/file-input/file-input.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcFileInputComponent", "cssParts": [ { "description": "The main wrapper that holds all main input elements.", "name": "container" }, { "description": "The native input element.", "name": "input" }, { "description": "The native label element.", "name": "label" }, { "description": "The file names wrapper when input type is 'file'.", "name": "file-names" }, { "description": "The browse button when input type is 'file'.", "name": "file-selector-button" }, { "description": "The prefix wrapper.", "name": "prefix" }, { "description": "The suffix wrapper.", "name": "suffix" }, { "description": "The helper text wrapper.", "name": "helper-text" } ], "slots": [ { "description": "Renders content before the input.", "name": "prefix" }, { "description": "Renders content after input.", "name": "suffix" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content for the browse button when input type is file.", "name": "file-selector-text" }, { "description": "Renders content when input type is file and no file is chosen.", "name": "file-missing-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-file-input'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_themes", "type": { "text": "ThemingController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_fileNames", "type": { "text": "string | null" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_filePickerActive", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "description": "Indicates whether the file picker dialog is currently active.\nUsed to manage validation on blur." }, { "kind": "field", "name": "value", "type": { "text": "string | Date | null" }, "privacy": "public", "description": "The value of the control.\nSimilar to native file input, this property is read-only and cannot be set programmatically.", "attribute": "value", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.", "type": { "text": "IFileInputResourceStrings" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "attribute": "locale", "type": { "text": "string" } }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The multiple attribute of the control.\nUsed to indicate that a file input allows the user to select more than one file.", "attribute": "multiple", "reflects": true }, { "kind": "field", "name": "accept", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The accept attribute of the control.\nDefines the file types as a list of comma-separated values that the file input should accept.", "attribute": "accept" }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "privacy": "public", "description": "The autofocus attribute of the control.", "attribute": "autofocus" }, { "kind": "field", "name": "files", "type": { "text": "FileList" }, "privacy": "public", "description": "Returns the list of selected files.", "readonly": true }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleCancel", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_renderFileParts", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`input-${nextId++}`", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected", "parameters": [ { "name": "base", "type": { "text": "string" } } ], "description": "Resolves the part names for the container based on the current state.\nUsed to apply conditional styling via CSS parts.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all the text inside the input.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderPrefix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderSuffix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderMaterial", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderStandard", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "events": [ { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "description": "Emitted when the control's file picker dialog is canceled.", "name": "igcCancel" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "attributes": [ { "name": "value", "description": "The value of the control.\nSimilar to native file input, this property is read-only and cannot be set programmatically.", "fieldName": "value", "attribute": "value", "type": { "text": "string" } }, { "name": "locale", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "fieldName": "locale", "attribute": "locale", "type": { "text": "string" } }, { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "The multiple attribute of the control.\nUsed to indicate that a file input allows the user to select more than one file.", "fieldName": "multiple", "attribute": "multiple" }, { "name": "accept", "type": { "text": "string" }, "default": "''", "description": "The accept attribute of the control.\nDefines the file types as a list of comma-separated values that the file input should accept.", "fieldName": "accept", "attribute": "accept" }, { "name": "autofocus", "type": { "text": "boolean" }, "description": "The autofocus attribute of the control.", "fieldName": "autofocus", "attribute": "autofocus" }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcInputBaseComponent", "module": "/src/components/input/input-base.js" }, "tagName": "igc-file-input", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcFileInputComponent", "module": "src/components/file-input/file-input.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/util.ts", "declarations": [ { "kind": "function", "name": "asPercent", "parameters": [ { "name": "part", "type": { "text": "number" } }, { "name": "whole", "type": { "text": "number" } } ] }, { "kind": "function", "name": "clamp", "parameters": [ { "name": "number", "type": { "text": "number" } }, { "name": "min", "type": { "text": "number" } }, { "name": "max", "type": { "text": "number" } } ] }, { "kind": "function", "name": "numberOfDecimals", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "number", "type": { "text": "number" } } ] }, { "kind": "function", "name": "roundPrecise", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "number", "type": { "text": "number" } }, { "name": "magnitude", "default": "1" } ] }, { "kind": "function", "name": "numberInRangeInclusive", "parameters": [ { "name": "value", "type": { "text": "number" } }, { "name": "min", "type": { "text": "number" } }, { "name": "max", "type": { "text": "number" } } ] }, { "kind": "function", "name": "isLTR", "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ], "description": "Returns whether an element has a Left-to-Right directionality." }, { "kind": "function", "name": "formatString", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "template", "type": { "text": "string" } }, { "name": "params", "type": { "text": "unknown[]" } } ], "description": "Builds a string from format specifiers and replacement parameters.\nWill coerce non-string parameters to their string representations." }, { "kind": "function", "name": "asNumber", "parameters": [ { "name": "value", "type": { "text": "unknown" } }, { "name": "fallback", "default": "0" } ], "description": "Parse the passed `value` as a number or return the `fallback` if it can't be done." }, { "kind": "function", "name": "wrap", "parameters": [ { "name": "min", "type": { "text": "number" } }, { "name": "max", "type": { "text": "number" } }, { "name": "value", "type": { "text": "number" } } ], "description": "Returns the value wrapped between the min and max bounds.\n\nIf the value is greater than max, returns the min and vice-versa.\nIf the value is between the bounds, it is returned unchanged." }, { "kind": "function", "name": "isDefined", "parameters": [ { "name": "value", "type": { "text": "T" } } ] }, { "kind": "function", "name": "iterNodes", "return": { "type": { "text": "Generator" } }, "parameters": [ { "name": "root", "type": { "text": "Node" } }, { "name": "options", "optional": true, "type": { "text": "IterNodesOptions" } } ] }, { "kind": "function", "name": "getRoot", "return": { "type": { "text": "Document | ShadowRoot" } }, "parameters": [ { "name": "element", "type": { "text": "Element" } }, { "name": "options", "optional": true, "type": { "text": "GetRootNodeOptions" } } ] }, { "kind": "function", "name": "getElementByIdFromRoot", "parameters": [ { "name": "root", "type": { "text": "HTMLElement" } }, { "name": "id", "type": { "text": "string" } } ] }, { "kind": "function", "name": "isElement", "return": { "type": { "text": "node is Element" } }, "parameters": [ { "name": "node", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "findElementFromEventPath", "return": { "type": { "text": "HTMLElementTagNameMap[K] | undefined" } }, "parameters": [ { "name": "predicate", "type": { "text": "K" } }, { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "function", "name": "findElementFromEventPath", "return": { "type": { "text": "T | undefined" } }, "parameters": [ { "name": "predicate", "type": { "text": "string | ((element: Element) => boolean)" } }, { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "function", "name": "findElementFromEventPath", "parameters": [ { "name": "predicate", "type": { "text": "string | ((element: Element) => boolean)" } }, { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "function", "name": "first", "parameters": [ { "name": "arr", "type": { "text": "T[]" } } ] }, { "kind": "function", "name": "last", "parameters": [ { "name": "arr", "type": { "text": "T[]" } } ] }, { "kind": "function", "name": "modulo", "parameters": [ { "name": "n", "type": { "text": "number" } }, { "name": "d", "type": { "text": "number" } } ] }, { "kind": "function", "name": "chunk", "return": { "type": { "text": "Generator" } }, "parameters": [ { "name": "arr", "type": { "text": "T[]" } }, { "name": "size", "type": { "text": "number" } } ], "description": "Splits an array into chunks of a specified size and returns a generator that yields each chunk." }, { "kind": "function", "name": "splitToWords", "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "function", "name": "toKebabCase", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "function", "name": "isFunction", "return": { "type": { "text": "value is CallableFunction" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "isString", "return": { "type": { "text": "value is string" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "isObject", "return": { "type": { "text": "value is object" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "isPlainObject", "return": { "type": { "text": "value is Record" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "isEventListenerObject", "return": { "type": { "text": "x is EventListenerObject" } }, "parameters": [ { "name": "x", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "addWeakEventListener", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "Element" } }, { "name": "event", "type": { "text": "string" } }, { "name": "listener", "type": { "text": "EventListenerOrEventListenerObject" } }, { "name": "options", "optional": true, "type": { "text": "AddEventListenerOptions | boolean" } } ] }, { "kind": "function", "name": "addSafeEventListener", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "target", "type": { "text": "HTMLElement" } }, { "name": "eventName", "type": { "text": "E" } }, { "name": "handler", "type": { "text": "(event: EventTypeOf) => unknown" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "description": "Safely adds an event listener to an HTMLElement, automatically handling\nserver-side rendering environments by doing nothing if `isServer` is true.\nThis function also correctly binds the `handler`'s `this` context to the `target` element\nand ensures proper event type inference." }, { "kind": "function", "name": "isEmpty", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "x", "type": { "text": "ArrayLike | Set | Map" } } ], "description": "Returns whether a given collection is empty." }, { "kind": "function", "name": "asArray", "return": { "type": { "text": "T[]" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "T | T[]" } } ] }, { "kind": "function", "name": "partition", "return": { "type": { "text": "[truthy: T[], falsy: T[]]" } }, "parameters": [ { "name": "array", "type": { "text": "T[]" } }, { "name": "isTruthy", "type": { "text": "(value: T) => boolean" } } ] }, { "kind": "function", "name": "getCenterPoint", "return": { "type": { "text": "{ x: number; y: number }" } }, "parameters": [ { "name": "element", "type": { "text": "Element" } } ], "description": "Returns the center x/y coordinate of a given element." }, { "kind": "function", "name": "getScaleFactor", "return": { "type": { "text": "{ x: number; y: number }" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } } ], "description": "Returns the scale factor of a given element based on its bounding client rect and offset dimensions." }, { "kind": "function", "name": "roundByDPR", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "function", "name": "scrollIntoView", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "optional": true, "type": { "text": "HTMLElement | null" } }, { "name": "config", "optional": true, "type": { "text": "ScrollIntoViewOptions" } } ] }, { "kind": "function", "name": "isRegExp", "return": { "type": { "text": "value is RegExp" } }, "parameters": [ { "name": "value", "type": { "text": "unknown" } } ] }, { "kind": "function", "name": "equal", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "a", "type": { "text": "unknown" } }, { "name": "b", "type": { "text": "T" } }, { "name": "visited", "default": "new WeakSet()" } ] }, { "kind": "function", "name": "escapeRegex", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ], "description": "Escapes any potential regex syntax characters in a string, and returns a new string\nthat can be safely used as a literal pattern for the `RegExp()` constructor." }, { "kind": "function", "name": "setStyles", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLElement" } }, { "name": "styles", "type": { "text": "Partial" } } ] }, { "kind": "function", "name": "merge", "return": { "type": { "text": "T & S" } }, "parameters": [ { "name": "target", "type": { "text": "T" } }, { "name": "source", "type": { "text": "S" } } ], "description": "Merges the properties of `source` into `target` performing a recursive deep merge over POJOs and arrays." }, { "kind": "function", "name": "toMerged", "return": { "type": { "text": "T & S" } }, "parameters": [ { "name": "target", "type": { "text": "T" } }, { "name": "source", "type": { "text": "S" } } ], "description": "Just like merge but it does not mutate the `target` object instead\nmutating a structured clone of it." }, { "kind": "function", "name": "bindIf", "return": { "type": { "text": "NonNullable" } }, "parameters": [ { "name": "assertion", "type": { "text": "unknown" } }, { "name": "value", "type": { "text": "T" } } ], "description": "Similar to Lit's `ifDefined` directive except one can check `assertion`\nand bind a different `value` through this wrapper." }, { "kind": "function", "name": "nanoid", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "size", "default": "21" } ] }, { "kind": "function", "name": "hasFiles", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "input", "type": { "text": "HTMLInputElement | IgcFileInputComponent" } } ] } ], "exports": [ { "kind": "js", "name": "asPercent", "declaration": { "name": "asPercent", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "clamp", "declaration": { "name": "clamp", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "numberOfDecimals", "declaration": { "name": "numberOfDecimals", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "roundPrecise", "declaration": { "name": "roundPrecise", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "numberInRangeInclusive", "declaration": { "name": "numberInRangeInclusive", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isLTR", "declaration": { "name": "isLTR", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "formatString", "declaration": { "name": "formatString", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "asNumber", "declaration": { "name": "asNumber", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "wrap", "declaration": { "name": "wrap", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isDefined", "declaration": { "name": "isDefined", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "iterNodes", "declaration": { "name": "iterNodes", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "getRoot", "declaration": { "name": "getRoot", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "getElementByIdFromRoot", "declaration": { "name": "getElementByIdFromRoot", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isElement", "declaration": { "name": "isElement", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "findElementFromEventPath", "declaration": { "name": "findElementFromEventPath", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "findElementFromEventPath", "declaration": { "name": "findElementFromEventPath", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "findElementFromEventPath", "declaration": { "name": "findElementFromEventPath", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "first", "declaration": { "name": "first", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "last", "declaration": { "name": "last", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "modulo", "declaration": { "name": "modulo", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "chunk", "declaration": { "name": "chunk", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "splitToWords", "declaration": { "name": "splitToWords", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "toKebabCase", "declaration": { "name": "toKebabCase", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isFunction", "declaration": { "name": "isFunction", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isString", "declaration": { "name": "isString", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isObject", "declaration": { "name": "isObject", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isPlainObject", "declaration": { "name": "isPlainObject", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isEventListenerObject", "declaration": { "name": "isEventListenerObject", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "addWeakEventListener", "declaration": { "name": "addWeakEventListener", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "addSafeEventListener", "declaration": { "name": "addSafeEventListener", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isEmpty", "declaration": { "name": "isEmpty", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "asArray", "declaration": { "name": "asArray", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "partition", "declaration": { "name": "partition", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "getCenterPoint", "declaration": { "name": "getCenterPoint", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "getScaleFactor", "declaration": { "name": "getScaleFactor", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "roundByDPR", "declaration": { "name": "roundByDPR", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "scrollIntoView", "declaration": { "name": "scrollIntoView", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "isRegExp", "declaration": { "name": "isRegExp", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "equal", "declaration": { "name": "equal", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "escapeRegex", "declaration": { "name": "escapeRegex", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "setStyles", "declaration": { "name": "setStyles", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "merge", "declaration": { "name": "merge", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "toMerged", "declaration": { "name": "toMerged", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "bindIf", "declaration": { "name": "bindIf", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "nanoid", "declaration": { "name": "nanoid", "module": "src/components/common/util.ts" } }, { "kind": "js", "name": "hasFiles", "declaration": { "name": "hasFiles", "module": "src/components/common/util.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/validators.ts", "declarations": [ { "kind": "variable", "name": "requiredValidator", "type": { "text": "Validator<{\n required: boolean;\n value?: unknown;\n}>" }, "default": "{ key: 'valueMissing', message: ValidationResourceStringsEN.required_validation_error!, isValid: ({ required, value }) => (required ? !!value : true), }" }, { "kind": "variable", "name": "requiredBooleanValidator", "type": { "text": "Validator<{\n required: boolean;\n checked: boolean;\n}>" }, "default": "{ key: 'valueMissing', message: ValidationResourceStringsEN.required_validation_error!, isValid: ({ required, checked }) => (required ? checked : true), }" }, { "kind": "variable", "name": "minLengthValidator", "type": { "text": "Validator<{\n minLength?: number;\n value: string;\n}>" }, "default": "{ key: 'tooShort', message: ({ minLength }) => formatString( ValidationResourceStringsEN.min_length_validation_error!, minLength ), isValid: ({ minLength, value }) => minLength && value ? value.length >= asNumber(minLength) : true, }" }, { "kind": "variable", "name": "maxLengthValidator", "type": { "text": "Validator<{\n maxLength?: number;\n value: string;\n}>" }, "default": "{ key: 'tooLong', message: ({ maxLength }) => formatString( ValidationResourceStringsEN.max_length_validation_error!, maxLength ), isValid: ({ maxLength, value }) => maxLength && value ? value.length <= asNumber(maxLength) : true, }" }, { "kind": "variable", "name": "patternValidator", "type": { "text": "Validator<{ pattern?: string; value: string }>" }, "default": "{ key: 'patternMismatch', message: ValidationResourceStringsEN.pattern_validation_error!, isValid: ({ pattern, value }) => pattern && value ? new RegExp(pattern, 'u').test(value) : true, }" }, { "kind": "variable", "name": "minValidator", "type": { "text": "Validator<{\n min?: number;\n value: number | string;\n}>" }, "default": "{ key: 'rangeUnderflow', message: ({ min }) => formatString(ValidationResourceStringsEN.min_validation_error!, min), isValid: ({ min, value }) => isDefined(value) && value !== '' && isDefined(min) ? asNumber(value) >= asNumber(min) : true, }" }, { "kind": "variable", "name": "maxValidator", "type": { "text": "Validator<{\n max?: number;\n value: number | string;\n}>" }, "default": "{ key: 'rangeOverflow', message: ({ max }) => formatString(ValidationResourceStringsEN.max_validation_error!, max), isValid: ({ max, value }) => isDefined(value) && value !== '' && isDefined(max) ? asNumber(value) <= asNumber(max) : true, }" }, { "kind": "variable", "name": "stepValidator", "type": { "text": "Validator<{\n min?: number;\n step?: number;\n value: number | string;\n}>" }, "default": "{ key: 'stepMismatch', message: 'Value does not conform to step constraint', isValid: ({ min, step, value }) => { if (isDefined(value) && value !== '' && isDefined(step)) { const _value = asNumber(value) - asNumber(min); const _step = asNumber(step); const magnitude = numberOfDecimals(_step) + 1; const rem = roundPrecise( Math.abs(_value - _step * Math.round(_value / _step)), magnitude ); return !rem; } return true; }, }" }, { "kind": "variable", "name": "emailValidator", "type": { "text": "Validator<{ value: string }>" }, "default": "{ key: 'typeMismatch', message: ValidationResourceStringsEN.email_validation_error!, isValid: ({ value }) => (value ? emailRegex.test(value) : true), }" }, { "kind": "variable", "name": "urlValidator", "type": { "text": "Validator<{ value: string }>" }, "default": "{ key: 'typeMismatch', message: ValidationResourceStringsEN.url_validation_error!, isValid: ({ value }) => (value ? URL.canParse(value) : true), }" }, { "kind": "variable", "name": "minDateValidator", "type": { "text": "Validator<{\n value?: Date | null;\n min?: Date | null;\n}>" }, "default": "{ key: 'rangeUnderflow', message: ({ min }) => formatString(ValidationResourceStringsEN.min_validation_error!, min), isValid: ({ value, min }) => value && min ? CalendarDay.compare(value, min) >= 0 : true, }" }, { "kind": "variable", "name": "maxDateValidator", "type": { "text": "Validator<{\n value?: Date | null;\n max?: Date | null;\n}>" }, "default": "{ key: 'rangeOverflow', message: ({ max }) => formatString(ValidationResourceStringsEN.max_validation_error!, max), isValid: ({ value, max }) => value && max ? CalendarDay.compare(value, max) <= 0 : true, }" } ], "exports": [ { "kind": "js", "name": "requiredValidator", "declaration": { "name": "requiredValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "requiredBooleanValidator", "declaration": { "name": "requiredBooleanValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "minLengthValidator", "declaration": { "name": "minLengthValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "maxLengthValidator", "declaration": { "name": "maxLengthValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "patternValidator", "declaration": { "name": "patternValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "minValidator", "declaration": { "name": "minValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "maxValidator", "declaration": { "name": "maxValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "stepValidator", "declaration": { "name": "stepValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "emailValidator", "declaration": { "name": "emailValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "urlValidator", "declaration": { "name": "urlValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "minDateValidator", "declaration": { "name": "minDateValidator", "module": "src/components/common/validators.ts" } }, { "kind": "js", "name": "maxDateValidator", "declaration": { "name": "maxDateValidator", "module": "src/components/common/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/forms/types.ts", "declarations": [ { "kind": "class", "description": "", "name": "FormAssociatedElementInterface", "members": [ { "kind": "field", "name": "defaultValue", "privacy": "public", "description": "The initial value of the component.", "type": { "text": "unknown" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "__internals", "type": { "text": "ElementInternalsController" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "unknown" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Sets the **touched** state of the component and invokes BaseFormAssociatedElement._validate| `_validate()` method.\n\nAs the naming of the method suggests, this should be invoked either on **blur** or **focusout**, depending\non the DOM structure and how focus state is managed by the component.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Sets the **touched** state of the component and **DOES NOT** invoke BaseFormAssociatedElement._validate| `_validate()` method.\n\nThis should be called whenever a user interaction triggers a response, usually an event, from the component in\nregards to its value.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "description": "Sets the default value of the component.\nCalled in `attributeChangedCallback`(i.e. when the `value` attribute of the control is set).", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Called when the associated parent form is reset.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "description": "Sets the component's submission value and state.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "form", "type": { "text": "HTMLFormElement" } } ], "description": "Called by the browser when it associates/disassociates the component with/from a given form element.\nReceives the form element as a parameter.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "description": "Called whenever the component or a parent `fieldset` elements are disabled.\nReceives the current disabled state.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Called when the form is reset.\nResets the component value/checked state to the default one, internal state and validation.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "FormValueType" } }, { "name": "mode", "type": { "text": "FormRestoreMode" } } ], "description": "Called when the browser attempts to automatically fill out the component.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } } ], "superclass": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" }, "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "name": "invalid", "type": { "text": "boolean" }, "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } } ] }, { "kind": "class", "description": "", "name": "FormAssociatedCheckboxElementInterface", "members": [ { "kind": "field", "name": "defaultChecked", "privacy": "public", "description": "The initial checked state of the component.", "type": { "text": "boolean" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "__internals", "type": { "text": "ElementInternalsController" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "unknown" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Sets the **touched** state of the component and invokes BaseFormAssociatedElement._validate| `_validate()` method.\n\nAs the naming of the method suggests, this should be invoked either on **blur** or **focusout**, depending\non the DOM structure and how focus state is managed by the component.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Sets the **touched** state of the component and **DOES NOT** invoke BaseFormAssociatedElement._validate| `_validate()` method.\n\nThis should be called whenever a user interaction triggers a response, usually an event, from the component in\nregards to its value.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "description": "Sets the default value of the component.\nCalled in `attributeChangedCallback`(i.e. when the `value` attribute of the control is set).", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Called when the associated parent form is reset.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "description": "Sets the component's submission value and state.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "form", "type": { "text": "HTMLFormElement" } } ], "description": "Called by the browser when it associates/disassociates the component with/from a given form element.\nReceives the form element as a parameter.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "description": "Called whenever the component or a parent `fieldset` elements are disabled.\nReceives the current disabled state.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Called when the form is reset.\nResets the component value/checked state to the default one, internal state and validation.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "FormValueType" } }, { "name": "mode", "type": { "text": "FormRestoreMode" } } ], "description": "Called when the browser attempts to automatically fill out the component.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } } ], "superclass": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" }, "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "name": "invalid", "type": { "text": "boolean" }, "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "inheritedFrom": { "name": "BaseFormAssociatedElement", "module": "src/components/common/mixins/forms/types.ts" } } ] }, { "kind": "class", "description": "", "name": "FormRequiredInterface", "members": [ { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected" }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" } } ], "attributes": [ { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required" } ] }, { "kind": "variable", "name": "InternalInvalidEvent", "type": { "text": "string" }, "default": "'igc-form-internal-invalid'" }, { "kind": "variable", "name": "InternalResetEvent", "type": { "text": "string" }, "default": "'igc-form-internal-reset'" } ], "exports": [ { "kind": "js", "name": "FormAssociatedElementInterface", "declaration": { "name": "FormAssociatedElementInterface", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "js", "name": "FormAssociatedCheckboxElementInterface", "declaration": { "name": "FormAssociatedCheckboxElementInterface", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "js", "name": "FormRequiredInterface", "declaration": { "name": "FormRequiredInterface", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "js", "name": "InternalInvalidEvent", "declaration": { "name": "InternalInvalidEvent", "module": "src/components/common/mixins/forms/types.ts" } }, { "kind": "js", "name": "InternalResetEvent", "declaration": { "name": "InternalResetEvent", "module": "src/components/common/mixins/forms/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/internals.ts", "declarations": [ { "kind": "class", "description": "A Lit ReactiveController to manage `ElementInternals` for a host element.\nProvides methods to interact with custom element states and ARIA attributes..", "name": "ElementInternalsController", "members": [ { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & LitElement" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_internals", "type": { "text": "ElementInternals" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Gets the closest ancestor `
` element or `null`.", "readonly": true }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a `ValidityState` object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "Returns a string containing the validation message of this element.", "readonly": true }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "Returns a boolean value which returns true if the element is a submittable element\nwhich is a candidate for constraint validation.", "readonly": true }, { "kind": "method", "name": "setARIA", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "Partial>" } } ], "description": "Sets ARIA attributes on the element's internals." }, { "kind": "method", "name": "setState", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "string" } }, { "name": "value", "type": { "text": "boolean" } } ], "description": "Adds or removes a custom state from the element's internals.\nCustom states can be styled via `:state()` selector in CSS." }, { "kind": "method", "name": "setFormValue", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "description": "Sets both the state and submission value of internals's target element to value.\n\nIf value is null, the element won't participate in form submission." }, { "kind": "method", "name": "setValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "flags", "optional": true, "type": { "text": "ValidityStateFlags" } }, { "name": "message", "optional": true, "type": { "text": "string" } } ], "description": "Sets the internal validity state of the host element as well as the validation\nmessage." }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks the internal validity of the host element and fires an `invalid` event if\nthe host element fails validation constraints." }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks the internal validity of the host element and fires an `invalid` event if\nthe host element fails validation constraints." } ] }, { "kind": "function", "name": "addInternalsController", "return": { "type": { "text": "ElementInternalsController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & LitElement" } }, { "name": "config", "optional": true, "type": { "text": "ElementInternalsConfig" } } ], "description": "Creates and adds a ElementInternalsController to a LitElement host." } ], "exports": [ { "kind": "js", "name": "addInternalsController", "declaration": { "name": "addInternalsController", "module": "src/components/common/controllers/internals.ts" } }, { "kind": "js", "name": "ElementInternalsController", "declaration": { "name": "ElementInternalsController", "module": "src/components/common/controllers/internals.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/avatar/avatar.ts", "declarations": [ { "kind": "class", "description": "An avatar component is used as a representation of a user identity\ntypically in a user profile.", "name": "IgcAvatarComponent", "cssParts": [ { "description": "The base wrapper of the avatar.", "name": "base" }, { "description": "The initials wrapper of the avatar.", "name": "initials" }, { "description": "The image wrapper of the avatar.", "name": "image" }, { "description": "The icon wrapper of the avatar.", "name": "icon" } ], "slots": [ { "description": "Renders an icon inside the default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-avatar'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "src", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The image source to use.", "attribute": "src" }, { "kind": "field", "name": "alt", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Alternative text for the image.", "attribute": "alt" }, { "kind": "field", "name": "initials", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Initials to use as a fallback when no image is available.", "attribute": "initials" }, { "kind": "field", "name": "shape", "type": { "text": "AvatarShape" }, "privacy": "public", "default": "'square'", "description": "The shape of the avatar.", "attribute": "shape", "reflects": true, "expandedType": { "text": "'square' | 'circle' | 'rounded'" } }, { "kind": "method", "name": "_handleError", "privacy": "protected", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "src", "type": { "text": "string | undefined" }, "description": "The image source to use.", "fieldName": "src", "attribute": "src" }, { "name": "alt", "type": { "text": "string | undefined" }, "description": "Alternative text for the image.", "fieldName": "alt", "attribute": "alt" }, { "name": "initials", "type": { "text": "string | undefined" }, "description": "Initials to use as a fallback when no image is available.", "fieldName": "initials", "attribute": "initials" }, { "name": "shape", "type": { "text": "AvatarShape" }, "default": "'square'", "description": "The shape of the avatar.", "fieldName": "shape", "attribute": "shape", "expandedType": { "text": "'square' | 'circle' | 'rounded'" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-avatar", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcAvatarComponent", "module": "src/components/avatar/avatar.ts" } } ] }, { "kind": "javascript-module", "path": "src/animations/presets/grow/index.ts", "declarations": [ { "kind": "function", "name": "growVerIn", "parameters": [ { "name": "options", "default": "baseOptions" } ] }, { "kind": "function", "name": "growVerOut", "parameters": [ { "name": "options", "default": "baseOptions" } ] } ], "exports": [ { "kind": "js", "name": "growVerIn", "declaration": { "name": "growVerIn", "module": "src/animations/presets/grow/index.ts" } }, { "kind": "js", "name": "growVerOut", "declaration": { "name": "growVerOut", "module": "src/animations/presets/grow/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/expansion-panel/expansion-panel.ts", "declarations": [ { "kind": "class", "description": "The Expansion Panel Component provides a way to display information in a toggleable way -\ncompact summary view containing title and description and expanded detail view containing\nadditional content to the summary header.", "name": "IgcExpansionPanelComponent", "cssParts": [ { "description": "The container of the expansion indicator, title and subtitle.", "name": "header" }, { "description": " The title container.", "name": "title" }, { "description": "The subtitle container.", "name": "subtitle" }, { "description": "The indicator container.", "name": "indicator" }, { "description": "The expansion panel's content wrapper.", "name": "content" } ], "slots": [ { "description": "renders the default content of the panel", "name": "" }, { "description": "renders the title of the panel's header", "name": "title" }, { "description": "renders the subtitle of the panel's header", "name": "subtitle" }, { "description": "renders the expand/collapsed indicator", "name": "indicator" }, { "description": "renders the expanded state of the indicator", "name": "indicator-expanded" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-expansion-panel'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_panelId", "privacy": "private", "default": "`${IgcExpansionPanelComponent.tagName}-${nextId++}`" }, { "kind": "field", "name": "_headerRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_panelRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_player", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Indicates whether the contents of the control should be visible.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Get/Set whether the expansion panel is disabled. Disabled panels are ignored for user interactions.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "indicatorPosition", "type": { "text": "ExpansionPanelIndicatorPosition" }, "privacy": "public", "default": "'start'", "description": "The indicator position of the expansion panel.", "attribute": "indicator-position", "reflects": true, "expandedType": { "text": "'start' | 'end' | 'none'" } }, { "kind": "method", "name": "_handleClick", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setOpenState", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "{\n state,\n withEvent,\n }", "type": { "text": "{\n state: boolean;\n withEvent?: boolean;\n }" } } ] }, { "kind": "method", "name": "_toggle", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_show", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_hide", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the panel open/close state." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the panel content." }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the panel content." }, { "kind": "method", "name": "_renderIndicator", "privacy": "private" }, { "kind": "method", "name": "_renderHeader", "privacy": "private" }, { "kind": "method", "name": "_renderPanel", "privacy": "private" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted before opening the expansion panel.", "name": "igcOpening" }, { "description": "Emitted after the expansion panel is opened.", "name": "igcOpened" }, { "description": "Emitted before closing the expansion panel.", "name": "igcClosing" }, { "description": "Emitted after the expansion panel is closed.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the contents of the control should be visible.", "fieldName": "open", "attribute": "open" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Get/Set whether the expansion panel is disabled. Disabled panels are ignored for user interactions.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "indicator-position", "type": { "text": "ExpansionPanelIndicatorPosition" }, "default": "'start'", "description": "The indicator position of the expansion panel.", "fieldName": "indicatorPosition", "attribute": "indicator-position", "expandedType": { "text": "'start' | 'end' | 'none'" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-expansion-panel", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcExpansionPanelComponent", "module": "src/components/expansion-panel/expansion-panel.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/accordion/accordion.ts", "declarations": [ { "kind": "class", "description": "The Accordion is a container-based component that can house multiple expansion panels\nand offers keyboard navigation.", "name": "IgcAccordionComponent", "slots": [ { "description": "Renders the expansion panels inside default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-accordion'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_panels", "type": { "text": "IgcExpansionPanelComponent[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_interactivePanels", "type": { "text": "IgcExpansionPanelComponent[]" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "singleExpand", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Allows only one panel to be expanded at a time.", "attribute": "single-expand", "reflects": true }, { "kind": "field", "name": "panels", "type": { "text": "IgcExpansionPanelComponent[]" }, "privacy": "public", "description": "Returns all of the accordions's direct igc-expansion-panel children.", "readonly": true }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handlePanelOpening", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_skipKeybinding", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "target", "type": { "text": "Element" } } ] }, { "kind": "method", "name": "_navigateToFirst", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_navigateToLast", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_navigateToPrevious", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_navigateToNext", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_collapseAll", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_expandAll", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_getPanelHeader", "privacy": "private", "return": { "type": { "text": "HTMLElement | undefined" } }, "parameters": [ { "name": "panel", "type": { "text": "IgcExpansionPanelComponent" } } ] }, { "kind": "method", "name": "_getNextPanel", "privacy": "private", "return": { "type": { "text": "IgcExpansionPanelComponent" } }, "parameters": [ { "name": "panel", "type": { "text": "IgcExpansionPanelComponent" } }, { "name": "dir", "default": "1", "type": { "text": "1 | -1" } } ] }, { "kind": "method", "name": "_closePanel", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "p", "type": { "text": "IgcExpansionPanelComponent" } } ] }, { "kind": "method", "name": "_openPanel", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "p", "type": { "text": "IgcExpansionPanelComponent" } } ] }, { "kind": "method", "name": "hideAll", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides all of the child expansion panels' contents." }, { "kind": "method", "name": "showAll", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows all of the child expansion panels' contents." } ], "attributes": [ { "name": "single-expand", "type": { "text": "boolean" }, "default": "false", "description": "Allows only one panel to be expanded at a time.", "fieldName": "singleExpand", "attribute": "single-expand" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-accordion", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcAccordionComponent", "module": "src/components/accordion/accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.ts", "declarations": [ { "kind": "class", "description": "The badge is a component indicating a status on a related item or an area\nwhere some active indication is required.", "name": "IgcBadgeComponent", "cssParts": [ { "description": "The base wrapper of the badge.", "name": "base" }, { "description": "The icon container, present when an igc-icon element is slotted.", "name": "icon" } ], "slots": [ { "description": "Default slot for the badge content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-badge'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hasIcon", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "variant", "type": { "text": "StyleVariant" }, "privacy": "public", "default": "'primary'", "description": "The type (style variant) of the badge.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets whether to draw an outlined version of the badge.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "shape", "type": { "text": "BadgeShape" }, "privacy": "public", "default": "'rounded'", "description": "The shape of the badge.", "attribute": "shape", "reflects": true, "expandedType": { "text": "'rounded' | 'square'" } }, { "kind": "field", "name": "dot", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets whether to render a dot type badge.\nWhen enabled, the badge appears as a small dot without any content.", "attribute": "dot", "reflects": true }, { "kind": "method", "name": "_handleSlotChange", "privacy": "protected", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "variant", "type": { "text": "StyleVariant" }, "default": "'primary'", "description": "The type (style variant) of the badge.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Sets whether to draw an outlined version of the badge.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "shape", "type": { "text": "BadgeShape" }, "default": "'rounded'", "description": "The shape of the badge.", "fieldName": "shape", "attribute": "shape", "expandedType": { "text": "'rounded' | 'square'" } }, { "name": "dot", "type": { "text": "boolean" }, "default": "false", "description": "Sets whether to render a dot type badge.\nWhen enabled, the badge appears as a small dot without any content.", "fieldName": "dot", "attribute": "dot" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-badge", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcBadgeComponent", "module": "src/components/badge/badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/banner/banner.ts", "declarations": [ { "kind": "class", "description": "The `igc-banner` component displays important and concise message(s) for a user to address, that is specific to a page or feature.", "name": "IgcBannerComponent", "cssParts": [ { "description": "The base wrapper of the banner component.", "name": "base" }, { "description": "The inner wrapper that sets the space around the banner.", "name": "spacer" }, { "description": "The part that holds the text and the illustration.", "name": "message" }, { "description": "The part that holds the banner icon/illustration.", "name": "illustration" }, { "description": "The part that holds the banner text content.", "name": "content" }, { "description": "The part that holds the banner action buttons.", "name": "actions" } ], "slots": [ { "description": "Renders the text content of the banner message.", "name": "" }, { "description": "Renders additional content at the start of the message block.", "name": "prefix" }, { "description": "Renders any action elements.", "name": "actions" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-banner'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_bannerRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_player", "privacy": "private", "readonly": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the banner is being shown/hidden.", "attribute": "open", "reflects": true }, { "kind": "method", "name": "_handleClick", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the banner if not already shown. Returns `true` when the animation has completed." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the banner if not already hidden. Returns `true` when the animation has completed." }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles between shown/hidden state. Returns `true` when the animation has completed." }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted before closing the banner - when a user interacts (click) with the default action of the banner.", "name": "igcClosing" }, { "description": "Emitted after the banner is closed - when a user interacts (click) with the default action of the banner.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the banner is being shown/hidden.", "fieldName": "open", "attribute": "open" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-banner", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcBannerComponent", "module": "src/components/banner/banner.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/mutation-observer.ts", "declarations": [ { "kind": "function", "name": "createMutationController", "return": { "type": { "text": "MutationController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & Element" } }, { "name": "config", "type": { "text": "MutationControllerConfig" } } ], "description": "Creates and attaches a mutation controller with `config` to the passed in `host`.\n\nAutomatically starts/stops observing for mutation changes\nin the respective component connect/disconnect callbacks.\n\nThe mutation observer is disconnected before invoking the passed in callback and re-attached\nafter that in order to not loop itself in endless stream of changes." } ], "exports": [ { "kind": "js", "name": "createMutationController", "declaration": { "name": "createMutationController", "module": "src/components/common/controllers/mutation-observer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button-group/toggle-button.ts", "declarations": [ { "kind": "class", "description": "The `igc-toggle-button` wraps a native button element and exposes additional `value` and `selected` properties.\nIt is used in the context of an `igc-button-group` to facilitate the creation of group/toolbar like UX behaviors.", "name": "IgcToggleButtonComponent", "cssParts": [ { "description": "The native button element.", "name": "toggle" } ], "slots": [ { "description": "the label/content of the button.", "name": "Renders" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-toggle-button'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_focusRingManager", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_nativeButton", "type": { "text": "HTMLButtonElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "value", "type": { "text": "string" }, "privacy": "public", "description": "The value attribute of the control.", "attribute": "value" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the button is selected.", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the button is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the button." }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the button." }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a mouse click on the element." } ], "attributes": [ { "name": "value", "type": { "text": "string" }, "description": "The value attribute of the control.", "fieldName": "value", "attribute": "value" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the button is selected.", "fieldName": "selected", "attribute": "selected" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the button is disabled.", "fieldName": "disabled", "attribute": "disabled" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-toggle-button", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcToggleButtonComponent", "module": "src/components/button-group/toggle-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button-group/button-group.ts", "declarations": [ { "kind": "class", "description": "The `igc-button-group` groups a series of `igc-toggle-button`s together, exposing features such as layout and selection.", "name": "IgcButtonGroupComponent", "cssParts": [ { "description": "The button group container.", "name": "group" } ], "slots": [ { "description": "Renders `igc-toggle-button` component.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-button-group'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "isMultiple", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_selectedItems", "type": { "text": "Set" }, "privacy": "private", "default": "new Set()" }, { "kind": "method", "name": "_observerCallback", "privacy": "private", "parameters": [ { "name": "{\n changes: { added, attributes },\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "field", "name": "_selectedButtons", "type": { "text": "Array" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "toggleButtons", "type": { "text": "Array" }, "privacy": "private" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Disables all buttons inside the group.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "alignment", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "Sets the orientation of the buttons in the group.", "attribute": "alignment", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "selection", "type": { "text": "ButtonGroupSelection" }, "privacy": "public", "default": "'single'", "description": "Controls the mode of selection for the button group.", "attribute": "selection", "expandedType": { "text": "'single' | 'single-required' | 'multiple'" } }, { "kind": "field", "name": "selectedItems", "type": { "text": "string[]" }, "privacy": "public", "description": "Gets/Sets the currently selected buttons (their values).", "attribute": "selected-items" }, { "kind": "method", "name": "updateDisabledState", "privacy": "protected" }, { "kind": "method", "name": "updateSelectionState", "privacy": "protected" }, { "kind": "method", "name": "handleClick", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "handleSingleSelection", "privacy": "private", "parameters": [ { "name": "button", "type": { "text": "IgcToggleButtonComponent" } } ] }, { "kind": "method", "name": "handleMultipleSelection", "privacy": "private", "parameters": [ { "name": "button", "type": { "text": "IgcToggleButtonComponent" } } ] }, { "kind": "method", "name": "emitSelectEvent", "privacy": "private", "parameters": [ { "name": "button", "type": { "text": "IgcToggleButtonComponent" } } ] }, { "kind": "method", "name": "emitDeselectEvent", "privacy": "private", "parameters": [ { "name": "button", "type": { "text": "IgcToggleButtonComponent" } } ] }, { "kind": "method", "name": "setSelection", "privacy": "private", "parameters": [ { "name": "values", "type": { "text": "Set" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when a button is selected through user interaction.", "name": "igcSelect" }, { "description": "Emitted when a button is deselected through user interaction.", "name": "igcDeselect" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables all buttons inside the group.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "alignment", "type": { "text": "ContentOrientation" }, "default": "'horizontal'", "description": "Sets the orientation of the buttons in the group.", "fieldName": "alignment", "attribute": "alignment", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "selection", "type": { "text": "ButtonGroupSelection" }, "default": "'single'", "description": "Controls the mode of selection for the button group.", "fieldName": "selection", "attribute": "selection", "expandedType": { "text": "'single' | 'single-required' | 'multiple'" } }, { "name": "selectedItems", "type": { "text": "string[]" }, "description": "Gets/Sets the currently selected buttons (their values).", "fieldName": "selectedItems" }, { "name": "selected-items", "type": { "text": "string[]" }, "description": "Gets/Sets the currently selected buttons (their values).", "attribute": "selectedItems", "fieldName": "selectedItems" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-button-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcButtonGroupComponent", "module": "src/components/button-group/button-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.actions.ts", "declarations": [ { "kind": "class", "description": "A container component for card action items such as buttons or icon buttons.\nActions can be positioned at the start, center, or end of the container.", "name": "IgcCardActionsComponent", "slots": [ { "description": "Renders items at the beginning of the actions area.", "name": "start" }, { "description": "Renders items in the center of the actions area.", "name": "" }, { "description": "Renders items at the end of the actions area.", "name": "end" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-card-actions'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "orientation", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the actions layout.", "attribute": "orientation", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } } ], "attributes": [ { "name": "orientation", "type": { "text": "ContentOrientation" }, "default": "'horizontal'", "description": "The orientation of the actions layout.", "fieldName": "orientation", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-card-actions", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCardActionsComponent", "module": "src/components/card/card.actions.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.content.ts", "declarations": [ { "kind": "class", "description": "A container component for the card's main text content.\nThis component should be used within an igc-card element to display the primary content.", "name": "IgcCardContentComponent", "slots": [ { "description": "Renders the card text content (e.g., paragraphs, lists).", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-card-content'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-card-content", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCardContentComponent", "module": "src/components/card/card.content.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.header.ts", "declarations": [ { "kind": "class", "description": "A container component for the card's header section.\nDisplays header content including an optional thumbnail, title, subtitle, and additional content.", "name": "IgcCardHeaderComponent", "cssParts": [ { "description": "The card header text container.", "name": "header" }, { "description": "The title slot wrapper.", "name": "title" }, { "description": "The subtitle slot wrapper.", "name": "subtitle" } ], "slots": [ { "description": "Renders header media such as an icon or small image.", "name": "thumbnail" }, { "description": "Renders the card title (typically a heading element).", "name": "title" }, { "description": "Renders the card subtitle (typically a smaller heading or text).", "name": "subtitle" }, { "description": "Renders additional content displayed next to the title area.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-card-header'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-card-header", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCardHeaderComponent", "module": "src/components/card/card.header.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.media.ts", "declarations": [ { "kind": "class", "description": "A container component for card media content such as images, GIFs, or videos.\nThis component should be used within an igc-card element to display visual content.", "name": "IgcCardMediaComponent", "slots": [ { "description": "Renders the card media content (e.g., img, video elements).", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-card-media'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-card-media", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCardMediaComponent", "module": "src/components/card/card.media.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/card/card.ts", "declarations": [ { "kind": "class", "description": "A container component that wraps different elements related to a single subject.\nThe card component provides a flexible container for organizing content such as headers,\nmedia, text content, and actions.", "name": "IgcCardComponent", "slots": [ { "description": "Renders the card content. Typically contains igc-card-header, igc-card-media, igc-card-content, and igc-card-actions.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-card'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "elevated", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the card to have an elevated appearance with shadow.\nWhen false, the card uses an outlined style with a border.", "attribute": "elevated", "reflects": true } ], "attributes": [ { "name": "elevated", "type": { "text": "boolean" }, "default": "false", "description": "Sets the card to have an elevated appearance with shadow.\nWhen false, the card uses an outlined style with a border.", "fieldName": "elevated", "attribute": "elevated" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-card", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCardComponent", "module": "src/components/card/card.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/i18n/EN/chat.resources.ts", "declarations": [ { "kind": "variable", "name": "IgcChatResourceStringEN", "type": { "text": "IgcChatResourceStrings" }, "default": "{ suggestionsHeader: 'Suggestions', reactionCopy: 'Copy', reactionLike: 'Like', reactionDislike: 'Dislike', reactionRegenerate: 'Regenerate', attachmentLabel: 'Attachment', attachmentsListLabel: 'Attachments', messageCopied: 'Message copied to clipboard', }" } ], "exports": [ { "kind": "js", "name": "IgcChatResourceStringEN", "declaration": { "name": "IgcChatResourceStringEN", "module": "src/components/common/i18n/EN/chat.resources.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/alert.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcBaseAlertLikeComponent", "members": [ { "kind": "field", "name": "_player", "type": { "text": "AnimationController" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_autoHideTimeout", "type": { "text": "ReturnType | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component is in shown state.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "displayTime", "type": { "text": "number" }, "privacy": "public", "default": "4000", "description": "Determines the duration in ms in which the component will be visible.", "attribute": "display-time" }, { "kind": "field", "name": "keepOpen", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the component should close after the `displayTime` is over.", "attribute": "keep-open", "reflects": true }, { "kind": "field", "name": "position", "type": { "text": "AbsolutePosition" }, "privacy": "public", "default": "'bottom'", "description": "Sets the position of the component in the viewport.", "attribute": "position", "reflects": true, "expandedType": { "text": "'bottom' | 'middle' | 'top'" } }, { "kind": "method", "name": "_setOpenState", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "open", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_setAutoHideTimer", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Opens the component." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Closes the component." }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component." } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component is in shown state.", "fieldName": "open", "attribute": "open" }, { "name": "display-time", "type": { "text": "number" }, "default": "4000", "description": "Determines the duration in ms in which the component will be visible.", "fieldName": "displayTime", "attribute": "display-time" }, { "name": "keep-open", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the component should close after the `displayTime` is over.", "fieldName": "keepOpen", "attribute": "keep-open" }, { "name": "position", "type": { "text": "AbsolutePosition" }, "default": "'bottom'", "description": "Sets the position of the component in the viewport.", "fieldName": "position", "attribute": "position", "expandedType": { "text": "'bottom' | 'middle' | 'top'" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "IgcBaseAlertLikeComponent", "declaration": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/toast/toast.ts", "declarations": [ { "kind": "class", "description": "A toast component is used to show a notification", "name": "IgcToastComponent", "cssParts": [ { "description": "The base wrapper of the toast.", "name": "base" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-toast'" }, { "kind": "field", "name": "_player", "type": { "text": "AnimationController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_autoHideTimeout", "type": { "text": "ReturnType | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component is in shown state.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "displayTime", "type": { "text": "number" }, "privacy": "public", "default": "4000", "description": "Determines the duration in ms in which the component will be visible.", "attribute": "display-time", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "keepOpen", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the component should close after the `displayTime` is over.", "attribute": "keep-open", "reflects": true, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "position", "type": { "text": "AbsolutePosition" }, "privacy": "public", "default": "'bottom'", "description": "Sets the position of the component in the viewport.", "attribute": "position", "reflects": true, "expandedType": { "text": "'bottom' | 'middle' | 'top'" }, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "_setOpenState", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "open", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "_setAutoHideTimer", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Opens the component.", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Closes the component.", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component.", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } } ], "superclass": { "name": "IgcBaseAlertLikeComponent", "module": "/src/components/common/mixins/alert.js" }, "tagName": "igc-toast", "customElement": true, "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component is in shown state.", "fieldName": "open", "attribute": "open", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "name": "display-time", "type": { "text": "number" }, "default": "4000", "description": "Determines the duration in ms in which the component will be visible.", "fieldName": "displayTime", "attribute": "display-time", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "name": "keep-open", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the component should close after the `displayTime` is over.", "fieldName": "keepOpen", "attribute": "keep-open", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "name": "position", "type": { "text": "AbsolutePosition" }, "default": "'bottom'", "description": "Sets the position of the component in the viewport.", "fieldName": "position", "attribute": "position", "expandedType": { "text": "'bottom' | 'middle' | 'top'" }, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcToastComponent", "module": "src/components/toast/toast.ts" } } ] }, { "kind": "javascript-module", "path": "src/animations/presets/scale/index.ts", "declarations": [ { "kind": "function", "name": "scaleInCenter", "parameters": [ { "name": "options", "default": "baseOptions" } ] } ], "exports": [ { "kind": "js", "name": "scaleInCenter", "declaration": { "name": "scaleInCenter", "module": "src/animations/presets/scale/index.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tooltip/service.ts", "declarations": [ { "kind": "variable", "name": "service", "default": "new TooltipEscapeCallbacks()" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "service", "module": "src/components/tooltip/service.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tooltip/controller.ts", "declarations": [ { "kind": "variable", "name": "TooltipRegexes" }, { "kind": "function", "name": "addTooltipController", "return": { "type": { "text": "TooltipController" } }, "parameters": [ { "name": "host", "type": { "text": "IgcTooltipComponent" } }, { "name": "options", "type": { "text": "TooltipCallbacks" } } ] } ], "exports": [ { "kind": "js", "name": "TooltipRegexes", "declaration": { "name": "TooltipRegexes", "module": "src/components/tooltip/controller.ts" } }, { "kind": "js", "name": "addTooltipController", "declaration": { "name": "addTooltipController", "module": "src/components/tooltip/controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tooltip/tooltip.ts", "declarations": [ { "kind": "class", "description": "Provides a way to display supplementary information related to an element when a user interacts with it (e.g., hover, focus).\nIt offers features such as placement customization, delays, sticky mode, and animations.", "name": "IgcTooltipComponent", "cssParts": [ { "description": "The wrapping container of the tooltip content.", "name": "base" }, { "description": "The container where the message property of the tooltip is rendered.", "name": "simple-text" } ], "slots": [ { "description": "Default slot of the tooltip component.", "name": "" }, { "description": "Slot for custom sticky-mode close action (e.g., an icon/button).", "name": "close-button" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tooltip'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_controller", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_containerRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_player", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_showAnimation", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hideAnimation", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_timeoutId", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_autoHideDelay", "type": { "text": "number" }, "privacy": "private", "default": "180" }, { "kind": "field", "name": "_showDelay", "type": { "text": "number" }, "privacy": "private", "default": "200" }, { "kind": "field", "name": "_hideDelay", "type": { "text": "number" }, "privacy": "private", "default": "300" }, { "kind": "field", "name": "_arrowElement", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "_arrowOffset", "privacy": "private", "readonly": true }, { "kind": "field", "name": "open", "privacy": "public", "description": "Whether the tooltip is showing.", "default": "false", "attribute": "open", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "withArrow", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to render an arrow indicator for the tooltip.", "attribute": "with-arrow", "reflects": true }, { "kind": "field", "name": "offset", "type": { "text": "number" }, "privacy": "public", "default": "6", "description": "The offset of the tooltip from the anchor in pixels.", "attribute": "offset" }, { "kind": "field", "name": "placement", "type": { "text": "PopoverPlacement" }, "privacy": "public", "default": "'bottom'", "description": "Where to place the floating element relative to the parent anchor element.", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "kind": "field", "name": "anchor", "type": { "text": "Element | string | undefined" }, "privacy": "public", "description": "An element instance or an IDREF to use as the anchor for the tooltip.", "attribute": "anchor" }, { "kind": "field", "name": "showTriggers", "privacy": "public", "description": "Which event triggers will show the tooltip.\nExpects a comma separate string of different event triggers.", "default": "pointerenter", "attribute": "show-triggers", "type": { "text": "string" } }, { "kind": "field", "name": "hideTriggers", "privacy": "public", "description": "Which event triggers will hide the tooltip.\nExpects a comma separate string of different event triggers.", "default": "pointerleave, click", "attribute": "hide-triggers", "type": { "text": "string" } }, { "kind": "field", "name": "showDelay", "privacy": "public", "description": "Specifies the number of milliseconds that should pass before showing the tooltip.", "default": "200", "attribute": "show-delay", "type": { "text": "number" } }, { "kind": "field", "name": "hideDelay", "privacy": "public", "description": "Specifies the number of milliseconds that should pass before hiding the tooltip.", "default": "300", "attribute": "hide-delay", "type": { "text": "number" } }, { "kind": "field", "name": "message", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "Specifies a plain text as tooltip content.", "attribute": "message" }, { "kind": "field", "name": "sticky", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Specifies if the tooltip remains visible until the user closes it via the close button or Esc key.", "attribute": "sticky", "reflects": true }, { "kind": "method", "name": "_emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "keyof IgcTooltipComponentEventMap" } } ] }, { "kind": "method", "name": "_applyTooltipState", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "{\n show,\n withDelay = false,\n withEvents = false,\n }", "type": { "text": "TooltipStateOptions" } } ] }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "target", "optional": true, "type": { "text": "Element | string" } } ], "description": "Shows the tooltip if not already showing.\nIf a target is provided, sets it as a transient anchor." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the tooltip if not already hidden." }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the tooltip between shown/hidden state" }, { "kind": "method", "name": "_showWithEvent", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_hideWithEvent", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_showOnInteraction", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_stopTimeoutAndAnimation", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setAutoHide", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_hideOnInteraction", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_hideOnEscape", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted before the tooltip begins to open. Can be canceled to prevent opening.", "name": "igcOpening" }, { "description": "Emitted after the tooltip has successfully opened and is visible.", "name": "igcOpened" }, { "description": "Emitted before the tooltip begins to close. Can be canceled to prevent closing.", "name": "igcClosing" }, { "description": "Emitted after the tooltip has been fully removed from view.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "open", "description": "Whether the tooltip is showing.", "default": "false", "fieldName": "open", "attribute": "open", "type": { "text": "boolean" } }, { "name": "with-arrow", "type": { "text": "boolean" }, "default": "false", "description": "Whether to render an arrow indicator for the tooltip.", "fieldName": "withArrow", "attribute": "with-arrow" }, { "name": "offset", "type": { "text": "number" }, "default": "6", "description": "The offset of the tooltip from the anchor in pixels.", "fieldName": "offset", "attribute": "offset" }, { "name": "placement", "type": { "text": "PopoverPlacement" }, "default": "'bottom'", "description": "Where to place the floating element relative to the parent anchor element.", "fieldName": "placement", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "name": "anchor", "type": { "text": "Element | string | undefined" }, "description": "An element instance or an IDREF to use as the anchor for the tooltip.", "fieldName": "anchor", "attribute": "anchor" }, { "name": "show-triggers", "description": "Which event triggers will show the tooltip.\nExpects a comma separate string of different event triggers.", "default": "pointerenter", "fieldName": "showTriggers", "attribute": "show-triggers", "type": { "text": "string" } }, { "name": "hide-triggers", "description": "Which event triggers will hide the tooltip.\nExpects a comma separate string of different event triggers.", "default": "pointerleave, click", "fieldName": "hideTriggers", "attribute": "hide-triggers", "type": { "text": "string" } }, { "name": "show-delay", "description": "Specifies the number of milliseconds that should pass before showing the tooltip.", "default": "200", "fieldName": "showDelay", "attribute": "show-delay", "type": { "text": "number" } }, { "name": "hide-delay", "description": "Specifies the number of milliseconds that should pass before hiding the tooltip.", "default": "300", "fieldName": "hideDelay", "attribute": "hide-delay", "type": { "text": "number" } }, { "name": "message", "type": { "text": "string" }, "default": "''", "description": "Specifies a plain text as tooltip content.", "fieldName": "message", "attribute": "message" }, { "name": "sticky", "type": { "text": "boolean" }, "default": "false", "description": "Specifies if the tooltip remains visible until the user closes it via the close button or Esc key.", "fieldName": "sticky", "attribute": "sticky" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tooltip", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTooltipComponent", "module": "src/components/tooltip/tooltip.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list/list-header.ts", "declarations": [ { "kind": "class", "description": "Header list item.", "name": "IgcListHeaderComponent", "slots": [ { "description": "Renders header list item's content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-list-header'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-list-header", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcListHeaderComponent", "module": "src/components/list/list-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list/list-item.ts", "declarations": [ { "kind": "class", "description": "The list-item component is a container\nintended for row items in the list component.", "name": "IgcListItemComponent", "cssParts": [ { "description": "The start container.", "name": "start" }, { "description": "The end container.", "name": "end" }, { "description": "The header and custom content container.", "name": "content" }, { "description": "The title and subtitle container.", "name": "header" }, { "description": "The title container.", "name": "title" }, { "description": "The subtitle container.", "name": "subtitle" } ], "slots": [ { "description": "Renders custom content.", "name": "" }, { "description": "Renders content before all other content.", "name": "start" }, { "description": "Renders content after all other content.", "name": "end" }, { "description": "Renders the title.", "name": "title" }, { "description": "Renders the subtitle.", "name": "subtitle" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-list-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Defines if the list item is selected or not.", "attribute": "selected", "reflects": true } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Defines if the list item is selected or not.", "fieldName": "selected", "attribute": "selected" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-list-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcListItemComponent", "module": "src/components/list/list-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/list/list.ts", "declarations": [ { "kind": "class", "description": "Displays a collection of data items in a templatable list format.", "name": "IgcListComponent", "slots": [ { "description": "Renders the list items and list headers inside default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-list'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-list", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcListComponent", "module": "src/components/list/list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/button/icon-button.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcIconButtonComponent", "cssParts": [ { "description": "The wrapping element of the icon button.", "name": "base" }, { "description": "The icon element of the icon button.", "name": "icon" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-icon-button'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "name", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The name of the icon.", "attribute": "name" }, { "kind": "field", "name": "collection", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The name of the icon collection.", "attribute": "collection" }, { "kind": "field", "name": "mirrored", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to flip the icon button. Useful for RTL layouts.", "attribute": "mirrored" }, { "kind": "field", "name": "variant", "type": { "text": "IconButtonVariant" }, "privacy": "public", "default": "'contained'", "description": "The visual variant of the icon button.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'contained' | 'flat' | 'outlined'" } }, { "kind": "method", "name": "renderContent", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "registerIcon", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "url", "type": { "text": "string" } }, { "name": "collection", "default": "'default'" } ] }, { "kind": "method", "name": "registerIconFromText", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "iconText", "type": { "text": "string" } }, { "name": "collection", "default": "'default'" } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_internals", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_focusRingManager", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "_nativeButton", "type": { "text": "HTMLButtonElement" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'reset' | 'submit'" }, "privacy": "public", "default": "'button'", "description": "The type of the button. Defaults to `button`.", "attribute": "type", "reflects": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The URL the button points to.", "attribute": "href", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "download", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Prompts to save the linked URL instead of navigating to it.", "attribute": "download", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "privacy": "public", "description": "Where to display the linked URL, as the name for a browsing context.", "attribute": "target", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "rel", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The relationship of the linked URL.\nSee https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types", "attribute": "rel", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus in the button.", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a mouse click on the element", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the button.", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "renderButton", "privacy": "private", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "kind": "method", "name": "renderLinkButton", "privacy": "private", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ], "attributes": [ { "name": "name", "type": { "text": "string | undefined" }, "description": "The name of the icon.", "fieldName": "name", "attribute": "name" }, { "name": "collection", "type": { "text": "string | undefined" }, "description": "The name of the icon collection.", "fieldName": "collection", "attribute": "collection" }, { "name": "mirrored", "type": { "text": "boolean" }, "default": "false", "description": "Whether to flip the icon button. Useful for RTL layouts.", "fieldName": "mirrored", "attribute": "mirrored" }, { "name": "variant", "type": { "text": "IconButtonVariant" }, "default": "'contained'", "description": "The visual variant of the icon button.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'contained' | 'flat' | 'outlined'" } }, { "name": "type", "type": { "text": "'button' | 'reset' | 'submit'" }, "default": "'button'", "description": "The type of the button. Defaults to `button`.", "fieldName": "type", "attribute": "type", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "href", "type": { "text": "string | undefined" }, "description": "The URL the button points to.", "fieldName": "href", "attribute": "href", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "download", "type": { "text": "string | undefined" }, "description": "Prompts to save the linked URL instead of navigating to it.", "fieldName": "download", "attribute": "download", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Where to display the linked URL, as the name for a browsing context.", "fieldName": "target", "attribute": "target", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "rel", "type": { "text": "string | undefined" }, "description": "The relationship of the linked URL.\nSee https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types", "fieldName": "rel", "attribute": "rel", "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ], "superclass": { "name": "IgcButtonBaseComponent", "module": "/src/components/button/button-base.js" }, "tagName": "igc-icon-button", "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcButtonBaseComponent", "module": "src/components/button/button-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcIconButtonComponent", "module": "src/components/button/icon-button.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/adopt-styles.ts", "declarations": [ { "kind": "class", "description": "Controller that manages the adoption of document-level styles into a\ncomponent's Shadow DOM.\n\nThis controller provides:\n- Automatic caching of cloned stylesheets per document\n- Efficient adoption and removal of document styles\n- Cache invalidation for theme changes\n- Automatic cleanup on component disconnection", "name": "AdoptedStylesController", "members": [ { "kind": "field", "name": "_cachedSheets", "privacy": "private", "static": true, "default": "new WeakMap()" }, { "kind": "method", "name": "_invalidateCache", "privacy": "private", "static": true, "return": { "type": { "text": "void" } }, "parameters": [ { "name": "doc", "type": { "text": "Document" } } ] }, { "kind": "field", "name": "_host", "type": { "text": "ReactiveControllerHost & LitElement" }, "privacy": "private", "readonly": true, "default": "host" }, { "kind": "field", "name": "_hasAdoptedStyles", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "hasAdoptedStyles", "type": { "text": "boolean" }, "privacy": "public", "description": "Indicates whether document styles have been adopted into the host's Shadow DOM.", "readonly": true }, { "kind": "method", "name": "shouldAdoptStyles", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "condition", "type": { "text": "boolean" }, "description": "If true, adopts document styles; if false, clears adopted styles" } ], "description": "Conditionally adopts or clears document styles based on the provided condition." }, { "kind": "method", "name": "invalidateCache", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "doc", "optional": true, "type": { "text": "Document" }, "description": "The document whose cache to invalidate. Defaults to the global document." } ], "description": "Invalidates the stylesheet cache for the specified document.\n\nThis should be called when the document's stylesheets change (e.g., theme changes)\nto ensure the next adoption uses the updated styles." }, { "kind": "method", "name": "_adoptRootStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Adopts document-level styles into the host's Shadow DOM.\n\nThis method:\n1. Checks the cache for previously cloned stylesheets\n2. Clones document stylesheets if not cached\n3. Applies both component styles and cloned document styles to the Shadow Root" }, { "kind": "method", "name": "_clearAdoptedStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Removes previously adopted document styles from the Shadow DOM.\n\nOnly removes stylesheets that were added by this controller, preserving\nthe component's original styles." }, { "kind": "method", "name": "_cloneDocumentStyleSheets", "privacy": "private", "return": { "type": { "text": "" } }, "parameters": [ { "name": "ownerDocument", "type": { "text": "Document" }, "description": "The document whose stylesheets should be cloned" } ], "description": "Clones all accessible stylesheets from the document into constructable stylesheets.\n\nThis method:\n- Iterates through all document stylesheets\n- Skips cross-origin stylesheets (CORS restrictions)\n- Skips" } ] }, { "kind": "function", "name": "addAdoptedStylesController", "return": { "type": { "text": "" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & LitElement" }, "description": "The Lit component that will host the controller" } ], "description": "Creates and attaches an AdoptedStylesController to a Lit component." } ], "exports": [ { "kind": "js", "name": "addAdoptedStylesController", "declaration": { "name": "addAdoptedStylesController", "module": "src/components/common/controllers/adopt-styles.ts" } }, { "kind": "js", "name": "AdoptedStylesController", "declaration": { "name": "AdoptedStylesController", "module": "src/components/common/controllers/adopt-styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/resize-observer.ts", "declarations": [ { "kind": "function", "name": "createResizeObserverController", "return": { "type": { "text": "ResizeObserverController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & Element" } }, { "name": "config", "type": { "text": "ResizeObserverControllerConfig" } } ], "description": "Creates a new resize controller bound to the given `host`\nwith ResizeObserverControllerConfig| `config`." } ], "exports": [ { "kind": "js", "name": "createResizeObserverController", "declaration": { "name": "createResizeObserverController", "module": "src/components/common/controllers/resize-observer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/validators.ts", "declarations": [ { "kind": "variable", "name": "textAreaValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, minLengthValidator, maxLengthValidator, ]" } ], "exports": [ { "kind": "js", "name": "textAreaValidators", "declaration": { "name": "textAreaValidators", "module": "src/components/textarea/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/textarea/textarea.ts", "declarations": [ { "kind": "class", "description": "This element represents a multi-line plain-text editing control,\nuseful when you want to allow users to enter a sizeable amount of free-form text,\nfor example a comment on a review or feedback form.", "name": "IgcTextareaComponent", "cssParts": [ { "description": "The main wrapper that holds all main input elements of the textarea.", "name": "container" }, { "description": "The native input element of the igc-textarea.", "name": "input" }, { "description": "The native label element of the igc-textarea.", "name": "label" }, { "description": "The prefix wrapper of the igc-textarea.", "name": "prefix" }, { "description": "The suffix wrapper of the igc-textarea.", "name": "suffix" }, { "description": "The helper text wrapper of the igc-textarea.", "name": "helper-text" } ], "slots": [ { "description": "Text content from the default slot will be used as the value of the component.", "name": "" }, { "description": "Renders content before the input.", "name": "prefix" }, { "description": "Renders content after input.", "name": "suffix" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when the maxlength validation fails.", "name": "too-long" }, { "description": "Renders content when the minlength validation fails.", "name": "too-short" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-textarea'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_inputId", "privacy": "private", "readonly": true, "default": "`textarea-${nextId++}`" }, { "kind": "field", "name": "_themes", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_input", "type": { "text": "HTMLTextAreaElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "autocomplete", "type": { "text": "string" }, "privacy": "public", "description": "Specifies what if any permission the browser has to provide for automated assistance in filling out form field values,\nas well as guidance to the browser as to the type of information expected in the field.\nRefer to [this page](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for additional information.", "attribute": "autocomplete" }, { "kind": "field", "name": "autocapitalize", "type": { "text": "string" }, "privacy": "public", "description": "Controls whether and how text input is automatically capitalized as it is entered/edited by the user.\n\n[MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize).", "attribute": "autocapitalize" }, { "kind": "field", "name": "inputMode", "type": { "text": "string" }, "privacy": "public", "description": "Hints at the type of data that might be entered by the user while editing the element or its contents.\nThis allows a browser to display an appropriate virtual keyboard.\n\n[MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)", "attribute": "inputmode" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label" }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "privacy": "public", "description": "The maximum number of characters (UTF-16 code units) that the user can enter.\nIf this value isn't specified, the user can enter an unlimited number of characters.", "attribute": "maxlength" }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "privacy": "public", "description": "The minimum number of characters (UTF-16 code units) required that the user should enter.", "attribute": "minlength" }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder" }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "reflects": true }, { "kind": "field", "name": "resize", "type": { "text": "TextareaResize" }, "privacy": "public", "default": "'vertical'", "description": "Controls whether the control can be resized.\nWhen `auto` is set, the control will try to expand and fit its content.", "attribute": "resize", "expandedType": { "text": "'vertical' | 'auto' | 'none'" } }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "privacy": "public", "default": "3", "description": "The number of visible text lines for the control. If it is specified, it must be a positive integer.\nIf it is not specified, the default value is 3.", "attribute": "rows" }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value of the component", "attribute": "value", "type": { "text": "string" } }, { "kind": "field", "name": "spellcheck", "type": { "text": "boolean" }, "privacy": "public", "default": "true", "description": "Controls whether the element may be checked for spelling errors.", "attribute": "spellcheck" }, { "kind": "field", "name": "wrap", "type": { "text": "'hard' | 'soft' | 'off'" }, "privacy": "public", "default": "'soft'", "description": "Indicates how the control should wrap the value for form submission.\nRefer to [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attributes)\nfor explanation of the available values.", "attribute": "wrap" }, { "kind": "field", "name": "validateOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Enables validation rules to be evaluated without restricting user input. This applies to the `maxLength` property\nwhen it is defined.", "attribute": "validate-only", "reflects": true }, { "kind": "method", "name": "_setAutoHeight", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "method", "name": "_setAreaHeight", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected" }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{\n isDefault,\n }", "type": { "text": "SlotChangeCallbackParameters>" } } ] }, { "kind": "method", "name": "_handleInput", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all text within the control." }, { "kind": "method", "name": "setSelectionRange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "SelectionRangeDirection" } } ], "description": "Sets the text selection range of the control" }, { "kind": "method", "name": "setRangeText", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "replacement", "type": { "text": "string" } }, { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "selectMode", "default": "'preserve'", "type": { "text": "RangeTextSelectMode" } } ], "description": "Replaces the selected text in the control." }, { "kind": "method", "name": "scrollTo", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "ScrollToOptions | undefined" } } ] }, { "kind": "method", "name": "scrollTo", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "x", "type": { "text": "number" } }, { "name": "y", "type": { "text": "number" } } ] }, { "kind": "method", "name": "scrollTo", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "x", "optional": true, "type": { "text": "unknown" } }, { "name": "y", "optional": true, "type": { "text": "unknown" } } ] }, { "kind": "method", "name": "_renderSlot", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "InferSlotNames" } } ] }, { "kind": "method", "name": "_renderLabel", "privacy": "protected" }, { "kind": "method", "name": "_renderStandard", "privacy": "protected" }, { "kind": "method", "name": "_renderMaterial", "privacy": "protected" }, { "kind": "method", "name": "_renderInput", "privacy": "protected" }, { "kind": "method", "name": "_renderValidationContainer", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the control receives user input.", "name": "igcInput" }, { "description": "Emitted when the a change to the control value is committed by the user.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "autocomplete", "type": { "text": "string" }, "description": "Specifies what if any permission the browser has to provide for automated assistance in filling out form field values,\nas well as guidance to the browser as to the type of information expected in the field.\nRefer to [this page](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for additional information.", "fieldName": "autocomplete", "attribute": "autocomplete" }, { "name": "autocapitalize", "type": { "text": "string" }, "description": "Controls whether and how text input is automatically capitalized as it is entered/edited by the user.\n\n[MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize).", "fieldName": "autocapitalize", "attribute": "autocapitalize" }, { "name": "inputmode", "type": { "text": "string" }, "description": "Hints at the type of data that might be entered by the user while editing the element or its contents.\nThis allows a browser to display an appropriate virtual keyboard.\n\n[MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode)", "fieldName": "inputMode", "attribute": "inputmode" }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label" }, { "name": "maxlength", "type": { "text": "number" }, "description": "The maximum number of characters (UTF-16 code units) that the user can enter.\nIf this value isn't specified, the user can enter an unlimited number of characters.", "fieldName": "maxLength", "attribute": "maxlength" }, { "name": "minlength", "type": { "text": "number" }, "description": "The minimum number of characters (UTF-16 code units) required that the user should enter.", "fieldName": "minLength", "attribute": "minlength" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly", "attribute": "readonly" }, { "name": "resize", "type": { "text": "TextareaResize" }, "default": "'vertical'", "description": "Controls whether the control can be resized.\nWhen `auto` is set, the control will try to expand and fit its content.", "fieldName": "resize", "attribute": "resize", "expandedType": { "text": "'vertical' | 'auto' | 'none'" } }, { "name": "rows", "type": { "text": "number" }, "default": "3", "description": "The number of visible text lines for the control. If it is specified, it must be a positive integer.\nIf it is not specified, the default value is 3.", "fieldName": "rows", "attribute": "rows" }, { "name": "value", "description": "The value of the component", "fieldName": "value", "attribute": "value", "type": { "text": "string" } }, { "name": "spellcheck", "type": { "text": "boolean" }, "default": "true", "description": "Controls whether the element may be checked for spelling errors.", "fieldName": "spellcheck", "attribute": "spellcheck" }, { "name": "wrap", "type": { "text": "'hard' | 'soft' | 'off'" }, "default": "'soft'", "description": "Indicates how the control should wrap the value for form submission.\nRefer to [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attributes)\nfor explanation of the available values.", "fieldName": "wrap", "attribute": "wrap" }, { "name": "validate-only", "type": { "text": "boolean" }, "default": "false", "description": "Enables validation rules to be evaluated without restricting user input. This applies to the `maxLength` property\nwhen it is defined.", "fieldName": "validateOnly", "attribute": "validate-only" }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-textarea", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTextareaComponent", "module": "src/components/textarea/textarea.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chat/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/chat/utils.ts", "declarations": [ { "kind": "variable", "name": "ChatFileTypeIcons", "default": "new Map( Object.entries({ css: 'file_css', csv: 'file_csv', doc: 'file_doc', docx: 'file_doc', htm: 'file_htm', html: 'file_html', js: 'file_js', json: 'file_json', pdf: 'file_pdf', rtf: 'file_rtf', svg: 'file_svg', txt: 'file_txt', url: 'file_link', xls: 'file_xls', xlsx: 'file_xls', xml: 'file_xml', zip: 'file_zip', default: 'file_generic', }) )" }, { "kind": "function", "name": "parseAcceptedFileTypes", "return": { "type": { "text": "ChatAcceptedFileTypes" } }, "parameters": [ { "name": "fileTypes", "type": { "text": "string" } } ] }, { "kind": "function", "name": "isAcceptedFileType", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "file", "type": { "text": "File" } }, { "name": "accepted", "type": { "text": "ChatAcceptedFileTypes | null" } } ] }, { "kind": "function", "name": "getChatAcceptedFiles", "return": { "type": { "text": "File[]" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } }, { "name": "accepted", "type": { "text": "ChatAcceptedFileTypes | null" } } ] }, { "kind": "function", "name": "getIconName", "parameters": [ { "name": "fileType", "optional": true, "type": { "text": "string" } } ] }, { "kind": "function", "name": "createAttachmentURL", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "attachment", "type": { "text": "IgcChatMessageAttachment" } } ] }, { "kind": "function", "name": "getFileExtension", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "name", "type": { "text": "string" } } ] }, { "kind": "function", "name": "isImageAttachment", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "attachment", "type": { "text": "IgcChatMessageAttachment | File" } } ] } ], "exports": [ { "kind": "js", "name": "ChatFileTypeIcons", "declaration": { "name": "ChatFileTypeIcons", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "parseAcceptedFileTypes", "declaration": { "name": "parseAcceptedFileTypes", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "isAcceptedFileType", "declaration": { "name": "isAcceptedFileType", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "getChatAcceptedFiles", "declaration": { "name": "getChatAcceptedFiles", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "getIconName", "declaration": { "name": "getIconName", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "createAttachmentURL", "declaration": { "name": "createAttachmentURL", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "getFileExtension", "declaration": { "name": "getFileExtension", "module": "src/components/chat/utils.ts" } }, { "kind": "js", "name": "isImageAttachment", "declaration": { "name": "isImageAttachment", "module": "src/components/chat/utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chat/chat-input.ts", "declarations": [ { "kind": "class", "description": "A web component that provides the input area for the `igc-chat` interface.\n\nIt supports:\n- Text input with automatic resizing\n- Sending messages on Enter key (with Shift+Enter for newlines)\n- File attachments via file picker or drag-and-drop\n- Customizable templates for send button, attachments, and text input\n- Emits various chat-related events (typing, input focus/blur, attachment drop, etc.)", "name": "IgcChatInputComponent", "cssParts": [ { "description": "Container for the input section", "name": "input-container" }, { "description": "Wrapper around the text input", "name": "input-wrapper" }, { "description": "The `` component", "name": "text-input" }, { "description": "Container for file upload/send buttons", "name": "actions-container" }, { "description": "The send icon button", "name": "send-button" }, { "description": "Container for rendering attachments", "name": "attachments" }, { "description": "Wrapper for individual attachment", "name": "attachment-wrapper" }, { "description": "Display name of an attachment", "name": "attachment-name" } ], "slots": [ { "description": "Default unnamed slot for rendering inside the component", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-chat-input'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_defaults", "type": { "text": "Readonly" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_userIsTyping", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_userLastTypeTime", "privacy": "private" }, { "kind": "field", "name": "_typingTimeout", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_adoptedStyles", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stateChanged", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stateConsumer", "privacy": "private", "readonly": true, "default": "new ContextConsumer(this, { context: chatContext, callback: this._stateChanged, subscribe: true, })" }, { "kind": "field", "name": "_userInputState", "type": { "text": "ChatState" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_textInputElement", "type": { "text": "IgcTextareaComponent | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_fileInput", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_parts", "type": { "text": "object" }, "privacy": "private", "default": "{ 'input-container': true, dragging: false }" }, { "kind": "field", "name": "_shouldAdoptRootStyles", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_state", "type": { "text": "ChatState" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_acceptedTypes", "type": { "text": "ChatAcceptedFileTypes | null" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "_adoptPageStyles", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getRenderer", "privacy": "private", "return": { "type": { "text": "DefaultInputRenderers[U]" } }, "parameters": [ { "name": "name", "type": { "text": "U" } } ] }, { "kind": "method", "name": "_sendMessage", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_setTypingStateAndEmit", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_handleAttachmentRemoved", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "attachment", "type": { "text": "IgcChatMessageAttachment" } } ] }, { "kind": "method", "name": "_handleKeydown", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_handleFileInputClick", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleFocusState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "_handleDragEnter", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_handleDragOver", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_handleDragLeave", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_handleDrop", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_handleInput", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ detail }", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleFileUpload", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_renderAttachmentsArea", "privacy": "private", "parameters": [ { "name": "attachments", "type": { "text": "IgcChatMessageAttachment[]" } } ], "description": "Default attachments area template used when no custom template is provided.\nRenders the list of input attachments as chips.", "return": { "type": { "text": "" } } }, { "kind": "method", "name": "_renderTextArea", "privacy": "private", "description": "Default text area template used when no custom template is provided.\nRenders a text area for user input.", "return": { "type": { "text": "" } } }, { "kind": "method", "name": "_renderFileUploadButton", "privacy": "private" }, { "kind": "method", "name": "_renderSendButton", "privacy": "private" }, { "kind": "method", "name": "_renderActionsArea", "privacy": "private" } ], "events": [ { "description": "Fired when the user starts/stops typing", "name": "igcTypingChange" }, { "description": "Fired when the input area receives focus", "name": "igcInputFocus" }, { "description": "Fired when the input area loses focus", "name": "igcInputBlur" }, { "description": "Fired when dragging a file over the input", "name": "igcAttachmentDrag" }, { "description": "Fired when a file is dropped into the input", "name": "igcAttachmentDrop" }, { "description": "Fired when file input changes (delegated from ``)", "name": "igcChange" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-chat-input", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcChatInputComponent", "module": "src/components/chat/chat-input.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chat/message-attachments.ts", "declarations": [ { "kind": "class", "description": "A component that renders message attachments within a chat.\n\nDisplays attachments such as images or files, supporting custom templates\nand default rendering using expansion panels.", "name": "IgcMessageAttachmentsComponent", "cssParts": [ { "description": "Container wrapping all attachments.", "name": "attachments-container" }, { "description": "Wrapper for a single attachment.", "name": "attachment" }, { "description": "Wrapper for a single attachment header.", "name": "attachment-header" }, { "description": "Part representing the attachment preview.", "name": "attachments-content" }, { "description": "Icon part representing the attachment type.", "name": "attachment-icon" }, { "description": "Part representing the attachment's file name.", "name": "file-name" }, { "description": "Container for header action buttons.", "name": "actions" }, { "description": "Part for the image element inside an image attachment.", "name": "image-attachment" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-message-attachments'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_defaults", "type": { "text": "Readonly" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_state", "type": { "text": "ChatState" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "message", "type": { "text": "IgcChatMessage | undefined" }, "privacy": "public", "description": "The array of attachments to render." }, { "kind": "method", "name": "_getRenderer", "privacy": "private", "parameters": [ { "name": "name", "type": { "text": "keyof DefaultAttachmentRenderers" } } ] }, { "kind": "field", "name": "_handleHeaderClick", "privacy": "private" }, { "kind": "method", "name": "renderHeader", "privacy": "private", "parameters": [ { "name": "attachment", "type": { "text": "IgcChatMessageAttachment" }, "description": "The message attachment to render" } ], "description": "Default attachment header template used when no custom template is provided.\nRenders the attachment icon and name.", "return": { "type": { "text": "" } } }, { "kind": "method", "name": "_renderContent", "privacy": "private", "parameters": [ { "name": "attachment", "type": { "text": "IgcChatMessageAttachment" }, "description": "The message attachment to render" } ], "description": "Default attachment content template used when no custom template is provided.\nRenders the attachment content based on its type.", "return": { "type": { "text": "" } } }, { "kind": "method", "name": "_renderAttachment", "privacy": "private", "parameters": [ { "name": "attachment", "type": { "text": "IgcChatMessageAttachment" } } ] } ], "events": [ { "description": "Fired when an attachment header is toggled (clicked).", "name": "igcAttachmentClick" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-message-attachments", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcMessageAttachmentsComponent", "module": "src/components/chat/message-attachments.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chat/chat-message.ts", "declarations": [ { "kind": "class", "description": "A chat message component for displaying individual messages in ``.", "name": "IgcChatMessageComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-chat-message'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_adoptedStyles", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_defaults", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stateChanged", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stateConsumer", "privacy": "private", "readonly": true, "default": "new ContextConsumer(this, { context: chatContext, callback: this._stateChanged, subscribe: true, })" }, { "kind": "field", "name": "_shouldAdoptRootStyles", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_state", "type": { "text": "ChatState" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "message", "type": { "text": "IgcChatMessage" }, "privacy": "public", "description": "The chat message to render." }, { "kind": "method", "name": "_adoptPageStyles", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getRenderer", "privacy": "private", "parameters": [ { "name": "name", "type": { "text": "keyof DefaultMessageRenderers" } } ] }, { "kind": "method", "name": "_handleCopy", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleMessageActionClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_renderHeader", "privacy": "private" }, { "kind": "method", "name": "_renderContent", "privacy": "private" }, { "kind": "method", "name": "_renderActions", "privacy": "private" }, { "kind": "method", "name": "_renderActionButton", "privacy": "private", "parameters": [ { "name": "name", "type": { "text": "string" } }, { "name": "tooltipMessage", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderAttachments", "privacy": "private" }, { "kind": "method", "name": "_renderMessage", "privacy": "private" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-chat-message", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcChatMessageComponent", "module": "src/components/chat/chat-message.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chat/chat.ts", "declarations": [ { "kind": "class", "description": "A chat UI component for displaying messages, attachments, and input interaction.", "name": "IgcChatComponent", "cssParts": [ { "description": "Styles the main chat container.", "name": "chat-container" }, { "description": "Styles the chat header container.", "name": "header" }, { "description": "Styles the element before the chat title (e.g., avatar).", "name": "prefix" }, { "description": "Styles the chat header title.", "name": "title" }, { "description": "Styles the container holding the messages and (optional) suggestions.", "name": "message-area-container" }, { "description": "Styles the message list container.", "name": "message-list" }, { "description": "Styles each message wrapper.", "name": "message-item" }, { "description": "Styles the typing indicator container.", "name": "typing-indicator" }, { "description": "Styles individual typing indicator dots.", "name": "typing-dot" }, { "description": "Styles the container holding all suggestions.", "name": "suggestions-container" }, { "description": "Styles the suggestions header.", "name": "suggestions-header" }, { "description": "Styles each suggestion item.", "name": "suggestion" }, { "description": "Styles the icon or prefix in a suggestion.", "name": "suggestion-prefix" }, { "description": "Styles the text/title of a suggestion.", "name": "suggestion-title" }, { "description": "Styles the empty state container when there are no messages.", "name": "empty-state" }, { "description": "Styles the wrapper around the chat input area.", "name": "input-area-container" }, { "description": "Styles the main text input area.", "name": "input-area" }, { "description": "Styles the container for attachments in the input.", "name": "input-attachments-container" }, { "description": "Styles a single attachment in the input area.", "name": "input-attachment-container" }, { "description": "Styles the file name of an attachment.", "name": "input-attachment-name" }, { "description": "Styles the icon of an attachment.", "name": "input-attachment-icon" }, { "description": "Styles the text input field for typing messages.", "name": "text-input" }, { "description": "Styles the container for input actions.", "name": "input-actions-container" }, { "description": "Styles the group of actions at the start of the input after the default file upload.", "name": "input-actions-start" }, { "description": "Styles the group of actions at the end of the input.", "name": "input-actions-end" }, { "description": "Styles the container for the file upload input.", "name": "file-upload-container" }, { "description": "Styles the file upload input itself.", "name": "file-upload" }, { "description": "Styles the container around the send button.", "name": "send-button-container" }, { "description": "Styles the send button.", "name": "send-button" }, { "description": "Styles the container of a single message.", "name": "message-container" }, { "description": "(forwarded) - Styles the internal list of messages.", "name": "message-list" }, { "description": "Styles the header of a message (e.g., sender, timestamp).", "name": "message-header" }, { "description": "Styles the text content of a message.", "name": "message-content" }, { "description": "Styles the container for message attachments.", "name": "message-attachments-container" }, { "description": "Styles a single message attachment.", "name": "message-attachment" }, { "description": "Styles the container holding message actions.", "name": "message-actions-container" }, { "description": "Styles messages marked as sent by the current user.", "name": "message-sent" }, { "description": "Styles the header of an attachment block.", "name": "attachment-header" }, { "description": "Styles the content of an attachment block.", "name": "attachment-content" }, { "description": "Styles the icon of an attachment.", "name": "attachment-icon" }, { "description": "Styles the file name shown in an attachment.", "name": "file-name" } ], "slots": [ { "description": "Slot for injecting content (e.g., avatar or icon) before the chat title.", "name": "prefix" }, { "description": "Slot for overriding the chat title content.", "name": "title" }, { "description": "Slot for injecting header actions (e.g., buttons, menus).", "name": "actions" }, { "description": "Slot for rendering a custom header for the suggestions list.", "name": "suggestions-header" }, { "description": "Slot for rendering a custom list of quick reply suggestions.", "name": "suggestions" }, { "description": "Slot for rendering additional actions.", "name": "suggestions-actions" }, { "description": "Slot for rendering a single suggestion item.", "name": "suggestion" }, { "description": "Slot shown when there are no messages.", "name": "empty-state" }, { "description": "Slot for the \"is typing\" indicator.", "name": "typing-indicator" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-chat'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_state", "privacy": "private", "readonly": true, "default": "new ChatState( this, this._updateContext, this._updateUserInputContext )" }, { "kind": "field", "name": "_defaults", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_context", "privacy": "private", "readonly": true, "default": "new ContextProvider(this, { context: chatContext, initialValue: this._state, })" }, { "kind": "field", "name": "_userInputContext", "privacy": "private", "readonly": true, "default": "new ContextProvider(this, { context: chatUserInputContext, initialValue: this._state, })" }, { "kind": "field", "name": "_input", "type": { "text": "IgcChatInputComponent | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_typingIndicator", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_suggestionsContainer", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_scrollContainer", "type": { "text": "HTMLElement" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "_updateContext", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updateUserInputContext", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "messages", "privacy": "public", "description": "The list of chat messages currently displayed.\nUse this property to set or update the message history.", "type": { "text": "IgcChatMessage[]" } }, { "kind": "field", "name": "draftMessage", "privacy": "public", "description": "The chat message currently being composed but not yet sent.\nIncludes the draft text and any attachments.", "type": { "text": "{\n text: string;\n attachments?: IgcChatMessageAttachment[];\n }" } }, { "kind": "field", "name": "options", "privacy": "public", "description": "Controls the chat behavior and appearance through a configuration object.\nUse this to toggle UI options, provide suggestions, templates, etc.", "type": { "text": "IgcChatOptions | undefined" } }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "default": "IgcChatResourceStringEN", "description": "The resource strings of the chat." }, { "kind": "method", "name": "_getRenderer", "privacy": "private", "return": { "type": { "text": "DefaultChatRenderers[U]" } }, "parameters": [ { "name": "name", "type": { "text": "U" } } ] }, { "kind": "method", "name": "_handleSuggestionClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "text", "type": { "text": "string" } } ] }, { "kind": "method", "name": "scrollToMessage", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "messageId", "type": { "text": "string" } } ], "description": "Scrolls the view to a specific message by id." }, { "kind": "method", "name": "_scrollToBottom", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_renderHeader", "privacy": "private" }, { "kind": "method", "name": "_renderMessages", "privacy": "private" }, { "kind": "method", "name": "_renderLoadingTemplate", "privacy": "private" }, { "kind": "method", "name": "_renderSuggestionPrefix", "privacy": "private" }, { "kind": "method", "name": "_renderSuggestions", "privacy": "private" }, { "kind": "method", "name": "_renderEmptyState", "privacy": "private" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Dispatched when a new chat message is created (sent).", "name": "igcMessageCreated" }, { "description": "Dispatched when a message is reacted to.", "name": "igcMessageReact" }, { "description": "Dispatched when a chat message attachment is clicked.", "name": "igcAttachmentClick" }, { "description": "Dispatched when attachment(s) are added either through drag & drop or through the default file input.", "name": "igcAttachmentAdded" }, { "description": "Dispatched when an attachment is removed by the user.", "name": "igcAttachmentRemoved" }, { "description": "Dispatched during an attachment drag operation.", "name": "igcAttachmentDrag" }, { "description": "Dispatched when an attachment is dropped (e.g., in a drag-and-drop operation).", "name": "igcAttachmentDrop" }, { "description": "Dispatched when the typing status changes (e.g., user starts or stops typing).", "name": "igcTypingChange" }, { "description": "Dispatched when the chat input field gains focus.", "name": "igcInputFocus" }, { "description": "Dispatched when the chat input field loses focus.", "name": "igcInputBlur" }, { "description": "Dispatched when the content of the chat input changes.", "name": "igcInputChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-chat", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcChatComponent", "module": "src/components/chat/chat.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/chat/chat-state.ts", "declarations": [ { "kind": "class", "description": "Internal state manager for the `` component.\n\nManages messages, input value, attachments, options, and event emissions.", "name": "ChatState", "members": [ { "kind": "field", "name": "_host", "type": { "text": "IgcChatComponent" }, "privacy": "private", "readonly": true, "default": "chat" }, { "kind": "field", "name": "_contextUpdateFn", "type": { "text": "() => unknown" }, "privacy": "private", "readonly": true, "default": "contextUpdateFn" }, { "kind": "field", "name": "_userInputContextUpdateFn", "type": { "text": "() => unknown" }, "privacy": "private", "readonly": true, "default": "userInputContextUpdateFn" }, { "kind": "field", "name": "_actionsTooltip", "type": { "text": "IgcTooltipComponent | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_actionToast", "type": { "text": "IgcToastComponent | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_messages", "type": { "text": "IgcChatMessage[]" }, "privacy": "private", "default": "[]", "description": "The current list of messages" }, { "kind": "field", "name": "_options", "type": { "text": "IgcChatOptions | undefined" }, "privacy": "private", "description": "Chat options/configuration" }, { "kind": "field", "name": "_inputAttachments", "type": { "text": "IgcChatMessageAttachment[]" }, "privacy": "private", "default": "[]", "description": "List of current input attachments" }, { "kind": "field", "name": "_inputValue", "type": { "text": "string" }, "privacy": "private", "default": "''", "description": "Current input text" }, { "kind": "field", "name": "_acceptedTypesCache", "type": { "text": "ChatAcceptedFileTypes | null" }, "privacy": "private", "default": "null", "description": "Cache of accepted file types, organized into extensions, mimeTypes, and wildcardTypes" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "default": "IgcChatResourceStringEN" }, { "kind": "field", "name": "host", "type": { "text": "IgcChatComponent" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "acceptedFileTypes", "type": { "text": "ChatAcceptedFileTypes | null" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "disableAutoScroll", "type": { "text": "boolean" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "messages", "type": { "text": "IgcChatMessage[]" }, "privacy": "public", "description": "Sets the list of chat messages." }, { "kind": "field", "name": "options", "type": { "text": "IgcChatOptions | undefined" }, "privacy": "public", "description": "Sets chat options and requests host update." }, { "kind": "field", "name": "currentUserId", "type": { "text": "string" }, "privacy": "public", "description": "Gets the current user ID from options or returns 'user' as fallback.", "readonly": true }, { "kind": "field", "name": "suggestionsPosition", "type": { "text": "ChatSuggestionsPosition" }, "privacy": "public", "description": "Gets the current suggestionsPosition from options or returns the default value 'below-messages'.", "readonly": true, "expandedType": { "text": "'below-input' | 'below-messages'" } }, { "kind": "field", "name": "stopTypingDelay", "type": { "text": "number" }, "privacy": "public", "description": "Gets the current stopTypingDelay from options or returns the default value `3000`.", "readonly": true }, { "kind": "field", "name": "inputAttachments", "type": { "text": "IgcChatMessageAttachment[]" }, "privacy": "public", "description": "Sets the input attachments and requests host update." }, { "kind": "field", "name": "inputValue", "type": { "text": "string" }, "privacy": "public", "description": "Sets the current input value and requests host update." }, { "kind": "method", "name": "isCurrentUserMessage", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "message", "optional": true, "type": { "text": "IgcChatMessage" } } ] }, { "kind": "method", "name": "emitEvent", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "name", "type": { "text": "keyof IgcChatComponentEventMap" } }, { "name": "args", "optional": true, "type": { "text": "any" } } ] }, { "kind": "method", "name": "_setAcceptedTypesCache", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Updates the internal cache for accepted file types.\nParses the acceptedFiles string option into extensions, mimeTypes, and wildcard types." }, { "kind": "method", "name": "_createMessage", "privacy": "protected", "return": { "type": { "text": "IgcChatMessage" } }, "parameters": [ { "name": "message", "type": { "text": "Partial" } } ] }, { "kind": "method", "name": "addMessage", "privacy": "public", "parameters": [ { "name": "message", "type": { "text": "Partial" } } ] } ] }, { "kind": "variable", "name": "url" } ], "exports": [ { "kind": "js", "name": "ChatState", "declaration": { "name": "ChatState", "module": "src/components/chat/chat-state.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/async-consumer.ts", "declarations": [ { "kind": "class", "description": "", "name": "AsyncContextConsumer", "members": [ { "kind": "field", "name": "_host", "type": { "text": "Host" }, "privacy": "protected", "default": "host" }, { "kind": "field", "name": "_options", "type": { "text": "AsyncContextOptions" }, "privacy": "protected", "default": "options" }, { "kind": "field", "name": "_consumer", "type": { "text": "ContextConsumer | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "value", "type": { "text": "ContextType | undefined" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "hostConnected", "privacy": "public", "return": { "type": { "text": "Promise" } } } ] }, { "kind": "function", "name": "createAsyncContext", "return": { "type": { "text": "AsyncContextConsumer" } }, "parameters": [ { "name": "host", "type": { "text": "Host" } }, { "name": "context", "type": { "text": "T" } }, { "name": "callback", "optional": true, "type": { "text": "(value: ContextType, dispose?: () => void) => void" } } ] } ], "exports": [ { "kind": "js", "name": "AsyncContextConsumer", "declaration": { "name": "AsyncContextConsumer", "module": "src/components/common/controllers/async-consumer.ts" } }, { "kind": "js", "name": "createAsyncContext", "declaration": { "name": "createAsyncContext", "module": "src/components/common/controllers/async-consumer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/resize-container/default-ghost.ts", "declarations": [ { "kind": "function", "name": "createDefaultGhostElement", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "{\n x,\n y,\n width,\n height,\n}", "type": { "text": "DOMRect" } } ], "description": "Default ghost element factory for the igc-resize implementation." }, { "kind": "function", "name": "getDefaultLayer", "return": { "type": { "text": "HTMLElement" } } } ], "exports": [ { "kind": "js", "name": "createDefaultGhostElement", "declaration": { "name": "createDefaultGhostElement", "module": "src/components/resize-container/default-ghost.ts" } }, { "kind": "js", "name": "getDefaultLayer", "declaration": { "name": "getDefaultLayer", "module": "src/components/resize-container/default-ghost.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/drag.ts", "declarations": [ { "kind": "function", "name": "addDragController", "return": { "type": { "text": "DragController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & LitElement" } }, { "name": "options", "optional": true, "type": { "text": "DragControllerConfiguration" } } ], "description": "Adds a drag and drop controller to the given host" } ], "exports": [ { "kind": "js", "name": "addDragController", "declaration": { "name": "addDragController", "module": "src/components/common/controllers/drag.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/fullscreen.ts", "declarations": [ { "kind": "function", "name": "addFullscreenController", "return": { "type": { "text": "FullscreenController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & HTMLElement" } }, { "name": "options", "optional": true, "type": { "text": "FullscreenControllerConfiguration" } } ] } ], "exports": [ { "kind": "js", "name": "addFullscreenController", "declaration": { "name": "addFullscreenController", "module": "src/components/common/controllers/fullscreen.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/divider/divider.ts", "declarations": [ { "kind": "class", "description": "The igc-divider allows the content author to easily create a horizontal/vertical rule as a break between content to better organize information on a page.", "name": "IgcDividerComponent", "cssProperties": [ { "description": "Sets the color of the divider.", "name": "--color" }, { "description": "Shrinks the divider by the given amount from the start. If `middle` is set it will shrink from both sides.", "name": "--inset" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-divider'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_vertical", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "vertical", "privacy": "public", "description": "Whether to render a vertical divider line.", "default": "false", "attribute": "vertical", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "middle", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When set and inset is provided, it will shrink the divider line from both sides.", "attribute": "middle", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "DividerType" }, "privacy": "public", "default": "'solid'", "description": "Whether to render a solid or a dashed divider line.", "attribute": "type", "reflects": true, "expandedType": { "text": "'solid' | 'dashed'" } } ], "attributes": [ { "name": "vertical", "description": "Whether to render a vertical divider line.", "default": "false", "fieldName": "vertical", "attribute": "vertical", "type": { "text": "boolean" } }, { "name": "middle", "type": { "text": "boolean" }, "default": "false", "description": "When set and inset is provided, it will shrink the divider line from both sides.", "fieldName": "middle", "attribute": "middle" }, { "name": "type", "type": { "text": "DividerType" }, "default": "'solid'", "description": "Whether to render a solid or a dashed divider line.", "fieldName": "type", "attribute": "type", "expandedType": { "text": "'solid' | 'dashed'" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-divider", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDividerComponent", "module": "src/components/divider/divider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/resize-container/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/resize-container/resize-controller.ts", "declarations": [ { "kind": "function", "name": "addResizeController", "return": { "type": { "text": "ResizeController" } }, "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & HTMLElement" } }, { "name": "options", "optional": true, "type": { "text": "ResizeControllerConfiguration" } } ] } ], "exports": [ { "kind": "js", "name": "addResizeController", "declaration": { "name": "addResizeController", "module": "src/components/resize-container/resize-controller.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/resize-container/resize-container.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcResizeContainerComponent", "slots": [ { "description": "renders the element(s) that should be resized", "name": "" }, { "description": "renders the side resize handle.", "name": "side-adorner" }, { "description": "renders the corner resize handle.", "name": "corner-adorner" }, { "description": "renders the bottom resize handle.", "name": "bottom-adorner" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-resize'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_controller", "type": { "text": "ReturnType" }, "privacy": "private" }, { "kind": "field", "name": "_mode", "type": { "text": "ResizeMode" }, "privacy": "private", "default": "'immediate'", "expandedType": { "text": "'immediate' | 'deferred'" } }, { "kind": "field", "name": "_ghostFactory", "type": { "text": "ResizeGhostFactory | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_container", "type": { "text": "Ref" }, "privacy": "private", "description": "The DOM container doing the actual resizing" }, { "kind": "field", "name": "_adorners", "type": { "text": "Record<'side' | 'corner' | 'bottom', Ref>" }, "privacy": "private", "default": "{ side: createRef(), corner: createRef(), bottom: createRef(), }", "description": "Resize component adorners" }, { "kind": "field", "name": "_isActive", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to always show the resize element adorners.", "attribute": "active", "reflects": true }, { "kind": "field", "name": "ghostFactory", "privacy": "public", "type": { "text": "ResizeGhostFactory | undefined" } }, { "kind": "field", "name": "mode", "privacy": "public", "description": "Get/Set the mode of the resizing operation.", "type": { "text": "ResizeMode" }, "attribute": "mode", "expandedType": { "text": "'immediate' | 'deferred'" } }, { "kind": "method", "name": "_updateResizingState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "params", "type": { "text": "ResizeCallbackParams" } } ] }, { "kind": "method", "name": "_handlePointerEnter", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handlePointerLeave", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleResizeStart", "privacy": "private", "parameters": [ { "name": "params", "type": { "text": "ResizeCallbackParams" } } ] }, { "kind": "method", "name": "_handleResize", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "params", "type": { "text": "ResizeCallbackParams" } } ] }, { "kind": "method", "name": "_handleResizeEnd", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "params", "type": { "text": "ResizeCallbackParams" } } ] }, { "kind": "method", "name": "_handleResizeCancel", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ initial }", "type": { "text": "ResizeState" } } ] }, { "kind": "method", "name": "_renderAdorner", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "'side' | 'corner' | 'bottom'" } }, { "name": "part", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderAdorners", "privacy": "protected" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether to always show the resize element adorners.", "fieldName": "active" }, { "name": "mode", "description": "Get/Set the mode of the resizing operation.", "type": { "text": "ResizeMode" }, "fieldName": "mode", "expandedType": { "text": "'immediate' | 'deferred'" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-resize", "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcResizeContainerComponent", "module": "src/components/resize-container/resize-container.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/tile-manager/resize-util.ts", "declarations": [ { "kind": "class", "description": "", "name": "ResizeUtil", "members": [ { "kind": "field", "name": "gap", "type": { "text": "number" }, "privacy": "private", "default": "gap" }, { "kind": "method", "name": "calculateSnappedDimension", "privacy": "public", "return": { "type": { "text": "SnappedDimension" } }, "parameters": [ { "name": "resizeProps", "type": { "text": "ResizeProps" } } ] }, { "kind": "method", "name": "calculateResizedSpan", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "props", "type": { "text": "ResizeSpanProps" } } ] }, { "kind": "method", "name": "calculatePosition", "privacy": "public", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "targetPosition", "type": { "text": "number" } }, { "name": "sizes", "type": { "text": "number[]" } } ] } ] } ], "exports": [ { "kind": "js", "name": "ResizeUtil", "declaration": { "name": "ResizeUtil", "module": "src/components/tile-manager/resize-util.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/resize-state.ts", "declarations": [ { "kind": "function", "name": "createTileResizeState", "return": { "type": { "text": "TileResizeState" } } } ], "exports": [ { "kind": "js", "name": "createTileResizeState", "declaration": { "name": "createTileResizeState", "module": "src/components/tile-manager/resize-state.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/tile-ghost-util.ts", "declarations": [ { "kind": "function", "name": "createTileDragGhost", "return": { "type": { "text": "IgcTileComponent" } }, "parameters": [ { "name": "tile", "type": { "text": "IgcTileComponent" } } ] }, { "kind": "function", "name": "createTileGhost", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "tile", "type": { "text": "IgcTileComponent" } } ] } ], "exports": [ { "kind": "js", "name": "createTileDragGhost", "declaration": { "name": "createTileDragGhost", "module": "src/components/tile-manager/tile-ghost-util.ts" } }, { "kind": "js", "name": "createTileGhost", "declaration": { "name": "createTileGhost", "module": "src/components/tile-manager/tile-ghost-util.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/tile.ts", "declarations": [ { "kind": "class", "description": "The tile component is used within the `igc-tile-manager` as a container\nfor displaying various types of information.", "name": "IgcTileComponent", "cssParts": [ { "description": "The wrapper for the entire tile content, header and content.", "name": "base" }, { "description": "The container for the tile header, including title and actions.", "name": "header" }, { "description": "The title container of the tile.", "name": "title" }, { "description": "The actions container of the tile header.", "name": "actions" }, { "description": "The container wrapping the tile’s main content.", "name": "content-container" }, { "description": "The part for the side adorner of the encapsulated resize element in the tile.", "name": "trigger-side" }, { "description": "The part for the corner adorner of the encapsulated resize element in the tile.", "name": "trigger" }, { "description": "The part for the bottom adorner of the encapsulated resize element in the tile.", "name": "trigger-bottom" } ], "slots": [ { "description": "Default slot for the tile's content.", "name": "" }, { "description": "Renders the title of the tile header.", "name": "title" }, { "description": "Renders the maximize action element of the tile header.", "name": "maximize-action" }, { "description": "Renders the fullscreen action element of the tile header.", "name": "fullscreen-action" }, { "description": "Renders items after the default actions in the tile header.", "name": "actions" }, { "description": "Renders the side resize handle of the tile.", "name": "side-adorner" }, { "description": "Renders the corner resize handle of the tile.", "name": "corner-adorner" }, { "description": "Renders the bottom resize handle of the tile.", "name": "bottom-adorner" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tile'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_dragController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_fullscreenController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_resizeState", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_dragStack", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_colSpan", "type": { "text": "number" }, "privacy": "private", "default": "1" }, { "kind": "field", "name": "_rowSpan", "type": { "text": "number" }, "privacy": "private", "default": "1" }, { "kind": "field", "name": "_colStart", "type": { "text": "number | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_rowStart", "type": { "text": "number | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_position", "type": { "text": "number" }, "privacy": "private", "default": "-1" }, { "kind": "field", "name": "_setDragConfiguration", "privacy": "private", "description": "Context consumer callback that sets the updated configuration of the internal drag controller\nbased on the passed tile manager properties." }, { "kind": "field", "name": "_context", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_tileManagerCtx", "type": { "text": "TileManagerContext | undefined" }, "privacy": "private", "description": "Returns the parent tile manager context.", "readonly": true }, { "kind": "field", "name": "_tileManager", "type": { "text": "IgcTileManagerComponent | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_cssContainer", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "description": "Returns the tile manager internal CSS grid container.", "readonly": true }, { "kind": "field", "name": "_resizeMode", "type": { "text": "TileManagerResizeMode" }, "privacy": "private", "description": "Returns the tile manager current resize mode.", "readonly": true, "expandedType": { "text": "'none' | 'hover' | 'always'" } }, { "kind": "field", "name": "_headerRef", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_resizeContainer", "type": { "text": "IgcResizeContainerComponent | undefined" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_tileContent", "type": { "text": "HTMLElement" }, "privacy": "public" }, { "kind": "field", "name": "_maximized", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_isDragging", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_isResizing", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_resizeDisabled", "type": { "text": "boolean" }, "privacy": "private", "description": "Whether to render the resize container based on tile and tile manager configuration.", "readonly": true }, { "kind": "field", "name": "colSpan", "privacy": "public", "description": "The number of columns the tile will span.", "default": "1", "attribute": "col-span", "type": { "text": "number" } }, { "kind": "field", "name": "rowSpan", "privacy": "public", "description": "The number of rows the tile will span.", "default": "1", "attribute": "row-span", "type": { "text": "number" } }, { "kind": "field", "name": "colStart", "privacy": "public", "description": "The starting column for the tile.", "attribute": "col-start", "type": { "text": "number | null" } }, { "kind": "field", "name": "rowStart", "privacy": "public", "description": "The starting row for the tile.", "attribute": "row-start", "type": { "text": "number | null" } }, { "kind": "field", "name": "fullscreen", "type": { "text": "boolean" }, "privacy": "public", "description": "Indicates whether the tile occupies the whole screen.", "readonly": true }, { "kind": "field", "name": "maximized", "privacy": "public", "description": "Indicates whether the tile occupies all available space within the layout.", "attribute": "maximized", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "disableResize", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Indicates whether to disable tile resize behavior regardless\not its tile manager parent settings.", "attribute": "disable-resize", "reflects": true }, { "kind": "field", "name": "disableFullscreen", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to disable the rendering of the tile `fullscreen-action` slot and its\ndefault fullscreen action button.", "attribute": "disable-fullscreen", "reflects": true }, { "kind": "field", "name": "disableMaximize", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to disable the rendering of the tile `maximize-action` slot and its\ndefault maximize action button.", "attribute": "disable-maximize", "reflects": true }, { "kind": "field", "name": "position", "privacy": "public", "description": "Gets/sets the tile's visual position in the layout.\nCorresponds to the CSS `order` property.", "attribute": "position", "type": { "text": "number" } }, { "kind": "method", "name": "_setDragState", "privacy": "private", "parameters": [ { "name": "state", "default": "true" } ] }, { "kind": "method", "name": "_handleDragStart", "privacy": "private" }, { "kind": "method", "name": "_handleDragOver", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ event, state }", "type": { "text": "DragCallbackParameters" } } ] }, { "kind": "method", "name": "_handleDragCancel", "privacy": "private" }, { "kind": "method", "name": "_handleDragEnd", "privacy": "private" }, { "kind": "method", "name": "_performSwap", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "match", "type": { "text": "IgcTileComponent" } } ] }, { "kind": "method", "name": "_shouldSwap", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "{ clientX, clientY }", "type": { "text": "PointerEvent" } }, { "name": "state", "type": { "text": "DragCallbackParameters['state']" } }, { "name": "match", "type": { "text": "IgcTileComponent" } } ] }, { "kind": "method", "name": "_skipDrag", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_match", "privacy": "private", "return": { "type": { "text": "element is IgcTileComponent" } }, "parameters": [ { "name": "element", "type": { "text": "Element" } } ] }, { "kind": "method", "name": "_createDragGhost", "privacy": "private", "return": { "type": { "text": "IgcTileComponent" } } }, { "kind": "field", "name": "_createResizeGhost", "privacy": "private" }, { "kind": "method", "name": "_setResizeState", "privacy": "private", "parameters": [ { "name": "state", "default": "true" } ] }, { "kind": "method", "name": "_handleResizeStart", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleResize", "privacy": "private", "parameters": [ { "name": "{\n detail: { state },\n }", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleResizeEnd", "privacy": "private", "parameters": [ { "name": "{\n detail: { state },\n }", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleResizeCancel", "privacy": "private" }, { "kind": "method", "name": "_handleFullscreen", "privacy": "private" }, { "kind": "method", "name": "_handleMaximize", "privacy": "private" }, { "kind": "method", "name": "_emitFullScreenEvent", "privacy": "private", "parameters": [ { "name": "state", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_emitMaximizedEvent", "privacy": "private" }, { "kind": "method", "name": "_emitTileDragStart", "privacy": "private" }, { "kind": "method", "name": "_emitTileResizeStart", "privacy": "private" }, { "kind": "method", "name": "_renderDefaultAction", "privacy": "protected", "parameters": [ { "name": "type", "type": { "text": "'maximize' | 'fullscreen'" } } ] }, { "kind": "method", "name": "_renderHeader", "privacy": "protected" }, { "kind": "method", "name": "_renderContent", "privacy": "protected" }, { "kind": "method", "name": "_renderAdornerSlot", "privacy": "private", "parameters": [ { "name": "name", "type": { "text": "AdornerType" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Fired when tile the fullscreen state changes.", "name": "igcTileFullscreen" }, { "description": "Fired when tile the maximize state changes.", "name": "igcTileMaximize" }, { "description": "Fired when a drag operation on a tile is about to begin. Cancelable.", "name": "igcTileDragStart" }, { "description": "Fired when a drag operation with a tile is successfully completed.", "name": "igcTileDragEnd" }, { "description": "Fired when a tile drag operation is canceled by the user.", "name": "igcTileDragCancel" }, { "description": "Fired when a resize operation on a tile is about to begin. Cancelable.", "name": "igcTileResizeStart" }, { "description": "Fired when a resize operation on a tile is successfully completed.", "name": "igcTileResizeEnd" }, { "description": "Fired when a resize operation on a tile is canceled by the user.", "name": "igcTileResizeCancel" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "col-span", "description": "The number of columns the tile will span.", "default": "1", "fieldName": "colSpan", "attribute": "col-span", "type": { "text": "number" } }, { "name": "row-span", "description": "The number of rows the tile will span.", "default": "1", "fieldName": "rowSpan", "attribute": "row-span", "type": { "text": "number" } }, { "name": "col-start", "description": "The starting column for the tile.", "fieldName": "colStart", "attribute": "col-start", "type": { "text": "number | null" } }, { "name": "row-start", "description": "The starting row for the tile.", "fieldName": "rowStart", "attribute": "row-start", "type": { "text": "number | null" } }, { "name": "maximized", "description": "Indicates whether the tile occupies all available space within the layout.", "fieldName": "maximized", "attribute": "maximized", "type": { "text": "boolean" } }, { "name": "disable-resize", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether to disable tile resize behavior regardless\not its tile manager parent settings.", "fieldName": "disableResize", "attribute": "disable-resize" }, { "name": "disable-fullscreen", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the rendering of the tile `fullscreen-action` slot and its\ndefault fullscreen action button.", "fieldName": "disableFullscreen", "attribute": "disable-fullscreen" }, { "name": "disable-maximize", "type": { "text": "boolean" }, "default": "false", "description": "Whether to disable the rendering of the tile `maximize-action` slot and its\ndefault maximize action button.", "fieldName": "disableMaximize", "attribute": "disable-maximize" }, { "name": "position", "description": "Gets/sets the tile's visual position in the layout.\nCorresponds to the CSS `order` property.", "fieldName": "position", "attribute": "position", "type": { "text": "number" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tile", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTileComponent", "module": "src/components/tile-manager/tile.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/position.ts", "declarations": [ { "kind": "function", "name": "createTilesState", "parameters": [ { "name": "manager", "type": { "text": "IgcTileManagerComponent" } } ] }, { "kind": "function", "name": "createTileDragStack", "return": { "type": { "text": "TileDragStack" } } }, { "kind": "function", "name": "swapTiles", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "a", "type": { "text": "IgcTileComponent" } }, { "name": "b", "type": { "text": "IgcTileComponent" } } ] } ], "exports": [ { "kind": "js", "name": "createTilesState", "declaration": { "name": "createTilesState", "module": "src/components/tile-manager/position.ts" } }, { "kind": "js", "name": "createTileDragStack", "declaration": { "name": "createTileDragStack", "module": "src/components/tile-manager/position.ts" } }, { "kind": "js", "name": "swapTiles", "declaration": { "name": "swapTiles", "module": "src/components/tile-manager/position.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/serializer.ts", "declarations": [ { "kind": "function", "name": "createSerializer", "parameters": [ { "name": "host", "type": { "text": "IgcTileManagerComponent" } } ] } ], "exports": [ { "kind": "js", "name": "createSerializer", "declaration": { "name": "createSerializer", "module": "src/components/tile-manager/serializer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tile-manager/tile-manager.ts", "declarations": [ { "kind": "class", "description": "The tile manager component enables the dynamic arrangement, resizing, and interaction of tiles.", "name": "IgcTileManagerComponent", "cssProperties": [ { "description": "The number of columns for the tile manager. The `column-count` attribute sets this variable.", "name": "--column-count" }, { "description": "The minimum size of the columns in the tile-manager. The `min-column-width` attribute sets this variable.", "name": "--min-col-width" }, { "description": "The minimum size of the rows in the tile-manager. The `min-row-height` attribute sets this variable.", "name": "--min-row-height" }, { "description": "The gap size of the underlying CSS grid container. The `gap` attributes sts this variable.", "name": "--grid-gap" } ], "cssParts": [ { "description": "The tile manager CSS Grid container.", "name": "base" } ], "slots": [ { "description": "Default slot for the tile manager. Only `igc-tile` elements will be projected inside the CSS grid container.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tile-manager'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "_internalStyles", "type": { "text": "StyleInfo" }, "privacy": "private", "default": "{}" }, { "kind": "field", "name": "_dragMode", "type": { "text": "TileManagerDragMode" }, "privacy": "private", "default": "'none'", "expandedType": { "text": "'none' | 'tile-header' | 'tile'" } }, { "kind": "field", "name": "_resizeMode", "type": { "text": "TileManagerResizeMode" }, "privacy": "private", "default": "'none'", "expandedType": { "text": "'none' | 'hover' | 'always'" } }, { "kind": "field", "name": "_columnCount", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_gap", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_minColWidth", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_minRowHeight", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_serializer", "privacy": "private" }, { "kind": "field", "name": "_tilesState", "privacy": "private" }, { "kind": "field", "name": "_grid", "privacy": "private" }, { "kind": "field", "name": "_context", "privacy": "private", "default": "new ContextProvider(this, { context: tileManagerContext, initialValue: this._createContext(), })" }, { "kind": "method", "name": "_createContext", "privacy": "private", "return": { "type": { "text": "TileManagerContext" } } }, { "kind": "method", "name": "_setManagerContext", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "resizeMode", "privacy": "public", "description": "Whether resize operations are enabled.", "default": "none", "attribute": "resize-mode", "type": { "text": "TileManagerResizeMode" }, "expandedType": { "text": "'none' | 'hover' | 'always'" } }, { "kind": "field", "name": "dragMode", "privacy": "public", "description": "Whether drag and drop operations are enabled.", "default": "none", "attribute": "drag-mode", "type": { "text": "TileManagerDragMode" }, "expandedType": { "text": "'none' | 'tile-header' | 'tile'" } }, { "kind": "field", "name": "columnCount", "privacy": "public", "description": "Sets the number of columns for the tile manager.\nSetting value <= than zero will trigger a responsive layout.", "default": "0", "attribute": "column-count", "type": { "text": "number" } }, { "kind": "field", "name": "minColumnWidth", "privacy": "public", "description": "Sets the minimum width for a column unit in the tile manager.", "attribute": "min-column-width", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "minRowHeight", "privacy": "public", "description": "Sets the minimum height for a row unit in the tile manager.", "attribute": "min-row-height", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "gap", "privacy": "public", "description": "Sets the gap size between tiles in the tile manager.", "attribute": "gap", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "tiles", "privacy": "public", "description": "Gets the tiles sorted by their position in the layout.", "readonly": true }, { "kind": "method", "name": "_observerCallback", "privacy": "private", "parameters": [ { "name": "{\n changes: { added, removed },\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "method", "name": "saveLayout", "privacy": "public", "return": { "type": { "text": "string" } }, "description": "Returns the properties of the current tile collections as a JSON payload." }, { "kind": "method", "name": "loadLayout", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "data", "type": { "text": "string" } } ], "description": "Restores a previously serialized state produced by `saveLayout`." } ], "attributes": [ { "name": "resize-mode", "description": "Whether resize operations are enabled.", "default": "none", "fieldName": "resizeMode", "attribute": "resize-mode", "type": { "text": "TileManagerResizeMode" }, "expandedType": { "text": "'none' | 'hover' | 'always'" } }, { "name": "drag-mode", "description": "Whether drag and drop operations are enabled.", "default": "none", "fieldName": "dragMode", "attribute": "drag-mode", "type": { "text": "TileManagerDragMode" }, "expandedType": { "text": "'none' | 'tile-header' | 'tile'" } }, { "name": "column-count", "description": "Sets the number of columns for the tile manager.\nSetting value <= than zero will trigger a responsive layout.", "default": "0", "fieldName": "columnCount", "attribute": "column-count", "type": { "text": "number" } }, { "name": "min-column-width", "description": "Sets the minimum width for a column unit in the tile manager.", "fieldName": "minColumnWidth", "attribute": "min-column-width", "type": { "text": "string | undefined" } }, { "name": "min-row-height", "description": "Sets the minimum height for a row unit in the tile manager.", "fieldName": "minRowHeight", "attribute": "min-row-height", "type": { "text": "string | undefined" } }, { "name": "gap", "description": "Sets the gap size between tiles in the tile manager.", "fieldName": "gap", "attribute": "gap", "type": { "text": "string | undefined" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tile-manager", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTileManagerComponent", "module": "src/components/tile-manager/tile-manager.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/context.ts", "declarations": [ { "kind": "variable", "name": "carouselContext" }, { "kind": "variable", "name": "tileManagerContext" }, { "kind": "variable", "name": "chatContext" }, { "kind": "variable", "name": "chatUserInputContext" } ], "exports": [ { "kind": "js", "name": "carouselContext", "declaration": { "name": "carouselContext", "module": "src/components/common/context.ts" } }, { "kind": "js", "name": "tileManagerContext", "declaration": { "name": "tileManagerContext", "module": "src/components/common/context.ts" } }, { "kind": "js", "name": "chatContext", "declaration": { "name": "chatContext", "module": "src/components/common/context.ts" } }, { "kind": "js", "name": "chatUserInputContext", "declaration": { "name": "chatUserInputContext", "module": "src/components/common/context.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/gestures.ts", "declarations": [ { "kind": "class", "description": "", "name": "SwipeEvent", "members": [ { "kind": "field", "name": "data", "type": { "text": "GestureData" }, "privacy": "public", "readonly": true, "default": "data" }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "readonly": true, "default": "name" } ], "superclass": { "name": "Event", "module": "src/components/common/controllers/gestures.ts" } }, { "kind": "function", "name": "addGesturesController", "parameters": [ { "name": "host", "type": { "text": "ReactiveControllerHost & HTMLElement" } }, { "name": "options", "optional": true, "type": { "text": "GesturesOptions" } } ], "description": "Adds a GesturesController responsible for managing gesture behaviors\nfor the given host element." } ], "exports": [ { "kind": "js", "name": "SwipeEvent", "declaration": { "name": "SwipeEvent", "module": "src/components/common/controllers/gestures.ts" } }, { "kind": "js", "name": "addGesturesController", "declaration": { "name": "addGesturesController", "module": "src/components/common/controllers/gestures.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/carousel/carousel-indicator.ts", "declarations": [ { "kind": "class", "description": "Used when a custom indicator needs to be passed to the `igc-carousel` component.", "name": "IgcCarouselIndicatorComponent", "cssParts": [ { "description": "The wrapping container of the carousel dot indicator.", "name": "indicator" }, { "description": "The wrapping container of the inactive dot indicator.", "name": "inactive" }, { "description": "The wrapping container of the active dot indicator.", "name": "active" } ], "slots": [ { "description": "Default slot for projected inactive indicator.", "name": "" }, { "description": "Default slot for projected active indicator.", "name": "active" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-carousel-indicator'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_carousel", "type": { "text": "IgcCarouselComponent | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_labelFormat", "type": { "text": "string" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "index", "type": { "text": "number" }, "privacy": "public", "default": "0" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-carousel-indicator", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCarouselIndicatorComponent", "module": "src/components/carousel/carousel-indicator.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/carousel/carousel-indicator-container.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcCarouselIndicatorContainerComponent", "cssParts": [ { "description": "The wrapping container of all carousel indicators.", "name": "base" } ], "slots": [ { "description": "Default slot for the carousel indicator container.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-carousel-indicator-container'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_focusRingManager", "privacy": "private", "readonly": true }, { "kind": "method", "name": "_handleFocusOut", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ] } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-carousel-indicator-container", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCarouselIndicatorContainerComponent", "module": "src/components/carousel/carousel-indicator-container.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/carousel/animations.ts", "declarations": [ { "kind": "variable", "name": "animations", "default": "new Map( Object.entries({ fade: new Map( Object.entries({ in: fadeIn, out: fadeOut, }) ), slideHor: new Map( Object.entries({ in: slideInHor, out: slideOutHor, }) ), slideVer: new Map( Object.entries({ in: slideInVer, out: slideOutVer, }) ), none: new Map( Object.entries({ in: noopAnimation, out: noopAnimation, }) ), }) )" } ], "exports": [ { "kind": "js", "name": "animations", "declaration": { "name": "animations", "module": "src/components/carousel/animations.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/carousel/carousel-slide.ts", "declarations": [ { "kind": "class", "description": "A single content container within a set of containers used in the context of an `igc-carousel`.", "name": "IgcCarouselSlideComponent", "slots": [ { "description": "slot for the carousel slide.", "name": "Default" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-carousel-slide'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_player", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_carousel", "type": { "text": "IgcCarouselComponent | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_index", "type": { "text": "number" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_total", "type": { "text": "number" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_animation", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_labelFormat", "type": { "text": "string" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The current active slide for the carousel component.", "attribute": "active", "reflects": true }, { "kind": "field", "name": "previous", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "attribute": "previous", "reflects": true } ], "attributes": [ { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "The current active slide for the carousel component.", "fieldName": "active", "attribute": "active" }, { "name": "previous", "type": { "text": "boolean" }, "default": "false", "fieldName": "previous" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-carousel-slide", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCarouselSlideComponent", "module": "src/components/carousel/carousel-slide.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/carousel/carousel.ts", "declarations": [ { "kind": "class", "description": "The `igc-carousel` presents a set of `igc-carousel-slide`s by sequentially displaying a subset of one or more slides.", "name": "IgcCarouselComponent", "cssParts": [ { "description": "The wrapper container of each carousel navigation button.", "name": "navigation" }, { "description": "The wrapper container of the carousel previous navigation button.", "name": "previous" }, { "description": "The wrapper container of the carousel next navigation button.", "name": "next" }, { "description": "The carousel dot indicator container.", "name": "dot" }, { "description": "The carousel active dot indicator container.", "name": "active" }, { "description": "The label container of the carousel indicators.", "name": "label" }, { "description": "The wrapping container of all carousel indicators when indicators-orientation is set to start.", "name": "start" } ], "slots": [ { "description": "slot for the carousel. Any projected `igc-carousel-slide` components should be projected here.", "name": "Default" }, { "description": "Renders content inside the previous button.", "name": "previous-button" }, { "description": "Renders content inside the next button.", "name": "next-button" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-carousel'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_carouselId", "privacy": "private", "readonly": true, "default": "`igc-carousel-${nextId++}`" }, { "kind": "field", "name": "_paused", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_lastInterval", "type": { "text": "ReturnType | null" }, "privacy": "private" }, { "kind": "field", "name": "_hasKeyboardInteractionOnIndicators", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_hasPointerInteraction", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_hasInnerFocus", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_slides", "type": { "text": "IgcCarouselSlideComponent[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_projectedIndicators", "type": { "text": "IgcCarouselIndicatorComponent[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_activeSlide", "type": { "text": "IgcCarouselSlideComponent" }, "privacy": "private" }, { "kind": "field", "name": "_playing", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_i18nController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_context", "privacy": "private", "readonly": true, "default": "new ContextProvider(this, { context: carouselContext, initialValue: this, })" }, { "kind": "method", "name": "_setCarouselContext", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_defaultIndicators", "type": { "text": "NodeListOf" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_carouselSlidesContainerRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_indicatorsContainerRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_prevButtonRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_nextButtonRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hasProjectedIndicators", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_showIndicatorsLabel", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_nextIndex", "type": { "text": "number" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_previousIndex", "type": { "text": "number" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "disableLoop", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the carousel should skip rotating to the first slide after it reaches the last.", "attribute": "disable-loop", "reflects": true }, { "kind": "field", "name": "disablePauseOnInteraction", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the carousel should ignore use interactions and not pause on them.", "attribute": "disable-pause-on-interaction", "reflects": true }, { "kind": "field", "name": "hideNavigation", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the carousel should skip rendering of the default navigation buttons.", "attribute": "hide-navigation", "reflects": true }, { "kind": "field", "name": "hideIndicators", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the carousel should render the indicator controls (dots).", "attribute": "hide-indicators", "reflects": true }, { "kind": "field", "name": "vertical", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the carousel has vertical alignment.", "attribute": "vertical", "reflects": true }, { "kind": "field", "name": "indicatorsOrientation", "type": { "text": "CarouselIndicatorsOrientation" }, "privacy": "public", "default": "'end'", "description": "Sets the orientation of the indicator controls (dots).", "attribute": "indicators-orientation", "expandedType": { "text": "'end' | 'start'" } }, { "kind": "field", "name": "indicatorsLabelFormat", "privacy": "public", "description": "The format used to set the aria-label on the carousel indicators.\nInstances of '{0}' will be replaced with the index of the corresponding slide.", "attribute": "indicators-label-format" }, { "kind": "field", "name": "_indicatorsLabelFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "slidesLabelFormat", "privacy": "public", "description": "The format used to set the aria-label on the carousel slides and the text displayed\nwhen the number of indicators is greater than tha maximum indicator count.\nInstances of '{0}' will be replaced with the index of the corresponding slide.\nInstances of '{1}' will be replaced with the total amount of slides.", "attribute": "slides-label-format" }, { "kind": "field", "name": "_slidesLabelFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "interval", "type": { "text": "number | undefined" }, "privacy": "public", "description": "The duration in milliseconds between changing the active slide.", "attribute": "interval" }, { "kind": "field", "name": "maximumIndicatorsCount", "type": { "text": "number" }, "privacy": "public", "default": "10", "description": "Controls the maximum indicator controls (dots) that can be shown. Default value is `10`.", "attribute": "maximum-indicators-count" }, { "kind": "field", "name": "animationType", "type": { "text": "HorizontalTransitionAnimation" }, "privacy": "public", "default": "'slide'", "description": "The animation type.", "attribute": "animation-type", "expandedType": { "text": "'slide' | 'fade' | 'none'" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "attribute": "locale" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.\nCurrently only aria-label attributes are localized for the carousel.", "type": { "text": "ICarouselResourceStrings" } }, { "kind": "field", "name": "slides", "type": { "text": "IgcCarouselSlideComponent[]" }, "privacy": "public", "description": "The slides of the carousel.", "readonly": true }, { "kind": "field", "name": "total", "type": { "text": "number" }, "privacy": "public", "description": "The total number of slides.", "readonly": true }, { "kind": "field", "name": "current", "type": { "text": "number" }, "privacy": "public", "description": "The index of the current active slide.", "readonly": true }, { "kind": "field", "name": "isPlaying", "type": { "text": "boolean" }, "privacy": "public", "description": "Whether the carousel is in playing state.", "readonly": true }, { "kind": "field", "name": "isPaused", "type": { "text": "boolean" }, "privacy": "public", "description": "Whether the carousel in in paused state.", "readonly": true }, { "kind": "method", "name": "_contextChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_intervalChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_observerCallback", "privacy": "private", "parameters": [ { "name": "{\n changes: { added, attributes },\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "params", "type": { "text": "SlotChangeCallbackParameters>" } } ] }, { "kind": "method", "name": "_handlePointerInteraction", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleFocusInteraction", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "_handleIndicatorClick", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleArrowLeft", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleArrowRight", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleHomeKey", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleEndKey", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleVerticalSwipe", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ data: { direction } }", "type": { "text": "SwipeEvent" } } ] }, { "kind": "method", "name": "_handleHorizontalSwipe", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ data: { direction } }", "type": { "text": "SwipeEvent" } } ] }, { "kind": "method", "name": "_handleNavigationInteractionNext", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleNavigationInteractionPrevious", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleInteraction", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "callback", "type": { "text": "() => Promise" } } ] }, { "kind": "method", "name": "_handlePauseOnInteraction", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_activateSlide", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "slide", "type": { "text": "IgcCarouselSlideComponent" } } ] }, { "kind": "method", "name": "_updateProjectedIndicators", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_resetInterval", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_restartInterval", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_animateSlides", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "nextSlide", "type": { "text": "IgcCarouselSlideComponent" } }, { "name": "currentSlide", "type": { "text": "IgcCarouselSlideComponent" } }, { "name": "dir", "type": { "text": "'next' | 'prev'" } } ] }, { "kind": "method", "name": "play", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Resumes playing of the carousel slides." }, { "kind": "method", "name": "pause", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Pauses the carousel rotation of slides." }, { "kind": "method", "name": "next", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Switches to the next slide, runs any animations, and returns if the operation was successful." }, { "kind": "method", "name": "prev", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Switches to the previous slide, runs any animations, and returns if the operation was successful." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "slide", "type": { "text": "IgcCarouselSlideComponent" } }, { "name": "animationDirection", "optional": true, "type": { "text": "'next' | 'prev'" } } ], "description": "Switches to the passed-in slide, runs any animations, and returns if the operation was successful." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "index", "type": { "text": "number" } }, { "name": "animationDirection", "optional": true, "type": { "text": "'next' | 'prev'" } } ], "description": "Switches to slide by index, runs any animations, and returns if the operation was successful." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "slideOrIndex", "type": { "text": "IgcCarouselSlideComponent | number" } }, { "name": "animationDirection", "optional": true, "type": { "text": "'next' | 'prev'" } } ] }, { "kind": "method", "name": "_renderNavigation", "privacy": "private" }, { "kind": "method", "name": "_renderIndicators", "privacy": "protected" }, { "kind": "method", "name": "_renderIndicatorContainer", "privacy": "private" }, { "kind": "method", "name": "_renderLabel", "privacy": "private" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the current active slide is changed either by user interaction or by the interval callback.", "name": "igcSlideChanged" }, { "description": "Emitted when the carousel enters playing state by a user interaction.", "name": "igcPlaying" }, { "description": "Emitted when the carousel enters paused state by a user interaction.", "name": "igcPaused" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "disable-loop", "type": { "text": "boolean" }, "default": "false", "description": "Whether the carousel should skip rotating to the first slide after it reaches the last.", "fieldName": "disableLoop", "attribute": "disable-loop" }, { "name": "disable-pause-on-interaction", "type": { "text": "boolean" }, "default": "false", "description": "Whether the carousel should ignore use interactions and not pause on them.", "fieldName": "disablePauseOnInteraction", "attribute": "disable-pause-on-interaction" }, { "name": "hide-navigation", "type": { "text": "boolean" }, "default": "false", "description": "Whether the carousel should skip rendering of the default navigation buttons.", "fieldName": "hideNavigation", "attribute": "hide-navigation" }, { "name": "hide-indicators", "type": { "text": "boolean" }, "default": "false", "description": "Whether the carousel should render the indicator controls (dots).", "fieldName": "hideIndicators", "attribute": "hide-indicators" }, { "name": "vertical", "type": { "text": "boolean" }, "default": "false", "description": "Whether the carousel has vertical alignment.", "fieldName": "vertical", "attribute": "vertical" }, { "name": "indicators-orientation", "type": { "text": "CarouselIndicatorsOrientation" }, "default": "'end'", "description": "Sets the orientation of the indicator controls (dots).", "fieldName": "indicatorsOrientation", "attribute": "indicators-orientation", "expandedType": { "text": "'end' | 'start'" } }, { "name": "indicators-label-format", "description": "The format used to set the aria-label on the carousel indicators.\nInstances of '{0}' will be replaced with the index of the corresponding slide.", "fieldName": "indicatorsLabelFormat", "attribute": "indicators-label-format" }, { "name": "slides-label-format", "description": "The format used to set the aria-label on the carousel slides and the text displayed\nwhen the number of indicators is greater than tha maximum indicator count.\nInstances of '{0}' will be replaced with the index of the corresponding slide.\nInstances of '{1}' will be replaced with the total amount of slides.", "fieldName": "slidesLabelFormat", "attribute": "slides-label-format" }, { "name": "interval", "type": { "text": "number | undefined" }, "description": "The duration in milliseconds between changing the active slide.", "fieldName": "interval", "attribute": "interval" }, { "name": "maximum-indicators-count", "type": { "text": "number" }, "default": "10", "description": "Controls the maximum indicator controls (dots) that can be shown. Default value is `10`.", "fieldName": "maximumIndicatorsCount", "attribute": "maximum-indicators-count" }, { "name": "animation-type", "type": { "text": "HorizontalTransitionAnimation" }, "default": "'slide'", "description": "The animation type.", "fieldName": "animationType", "attribute": "animation-type", "expandedType": { "text": "'slide' | 'fade' | 'none'" } }, { "name": "locale", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "fieldName": "locale", "attribute": "locale" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-carousel", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCarouselComponent", "module": "src/components/carousel/carousel.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/validators.ts", "declarations": [ { "kind": "variable", "name": "checkBoxValidators", "type": { "text": "Validator[]" }, "default": "[ requiredBooleanValidator, ]" } ], "exports": [ { "kind": "js", "name": "checkBoxValidators", "declaration": { "name": "checkBoxValidators", "module": "src/components/checkbox/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcCheckboxBaseComponent", "members": [ { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_slots", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_focusRingManager", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected" }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_hideLabel", "type": { "text": "boolean" }, "privacy": "protected", "default": "true" }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value attribute of the control.", "attribute": "value", "type": { "text": "string" } }, { "kind": "field", "name": "checked", "privacy": "public", "description": "The checked state of the control.", "attribute": "checked", "type": { "text": "boolean" } }, { "kind": "field", "name": "labelPosition", "type": { "text": "ToggleLabelPosition" }, "privacy": "public", "default": "'after'", "description": "The label position of the control.", "attribute": "label-position", "reflects": true, "expandedType": { "text": "'after' | 'before'" } }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a click on the control." }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control." }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control." }, { "kind": "method", "name": "_handleSlotChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultChecked", "privacy": "public", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedCheckboxMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "value", "description": "The value attribute of the control.", "fieldName": "value", "attribute": "value", "type": { "text": "string" } }, { "name": "checked", "description": "The checked state of the control.", "fieldName": "checked", "attribute": "checked", "type": { "text": "boolean" } }, { "name": "label-position", "type": { "text": "ToggleLabelPosition" }, "default": "'after'", "description": "The label position of the control.", "fieldName": "labelPosition", "attribute": "label-position", "expandedType": { "text": "'after' | 'before'" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedCheckboxRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true, "events": [ { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ] } ], "exports": [ { "kind": "js", "name": "IgcCheckboxBaseComponent", "declaration": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/checkbox.ts", "declarations": [ { "kind": "class", "description": "A check box allowing single values to be selected/deselected.", "name": "IgcCheckboxComponent", "cssParts": [ { "description": "The base wrapper of the checkbox.", "name": "base" }, { "description": "The checkbox input element.", "name": "control" }, { "description": "The checkbox label.", "name": "label" }, { "description": "The checkbox indicator icon.", "name": "indicator" } ], "slots": [ { "description": "The checkbox label.", "name": "" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-checkbox'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_themes", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_inputId", "privacy": "private", "readonly": true, "default": "`checkbox-${nextId++}`" }, { "kind": "field", "name": "_labelId", "privacy": "private", "readonly": true, "default": "`checkbox-label-${this._inputId}`" }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Draws the checkbox in indeterminate state.", "attribute": "indeterminate", "reflects": true }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderStandard", "privacy": "protected" }, { "kind": "method", "name": "_renderIndigo", "privacy": "protected" }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "defaultChecked", "privacy": "public", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_slots", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_focusRingManager", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_hideLabel", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value attribute of the control.", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "checked", "privacy": "public", "description": "The checked state of the control.", "attribute": "checked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "labelPosition", "type": { "text": "ToggleLabelPosition" }, "privacy": "public", "default": "'after'", "description": "The label position of the control.", "attribute": "label-position", "reflects": true, "expandedType": { "text": "'after' | 'before'" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a click on the control.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleSlotChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ], "events": [ { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ], "attributes": [ { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "Draws the checkbox in indeterminate state.", "fieldName": "indeterminate", "attribute": "indeterminate" }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "value", "description": "The value attribute of the control.", "fieldName": "value", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "checked", "description": "The checked state of the control.", "fieldName": "checked", "attribute": "checked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "label-position", "type": { "text": "ToggleLabelPosition" }, "default": "'after'", "description": "The label position of the control.", "fieldName": "labelPosition", "attribute": "label-position", "expandedType": { "text": "'after' | 'before'" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ], "superclass": { "name": "IgcCheckboxBaseComponent", "module": "/src/components/checkbox/checkbox-base.js" }, "tagName": "igc-checkbox", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCheckboxComponent", "module": "src/components/checkbox/checkbox.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/progress/base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcProgressBaseComponent", "members": [ { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected" }, { "kind": "field", "name": "_base", "type": { "text": "HTMLElement" }, "privacy": "protected" }, { "kind": "field", "name": "_percentage", "type": { "text": "number" }, "privacy": "protected", "default": "0" }, { "kind": "field", "name": "_progress", "type": { "text": "number" }, "privacy": "protected", "default": "0" }, { "kind": "field", "name": "_hasFraction", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "_styleInfo", "type": { "text": "StyleInfo" }, "privacy": "protected", "default": "{ '--_progress-whole': '0.00', '--_progress-integer': '0', '--_progress-fraction': '0', '--_transition-duration': '0ms', }" }, { "kind": "field", "name": "max", "type": { "text": "number" }, "privacy": "public", "default": "100", "description": "Maximum value of the control.", "attribute": "max" }, { "kind": "field", "name": "value", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The value of the control.", "attribute": "value" }, { "kind": "field", "name": "variant", "type": { "text": "StyleVariant" }, "privacy": "public", "default": "'primary'", "description": "The variant of the control.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" } }, { "kind": "field", "name": "animationDuration", "type": { "text": "number" }, "privacy": "public", "default": "500", "description": "Animation duration in milliseconds.", "attribute": "animation-duration" }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The indeterminate state of the control.", "attribute": "indeterminate" }, { "kind": "field", "name": "hideLabel", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Shows/hides the label of the control.", "attribute": "hide-label" }, { "kind": "field", "name": "labelFormat", "type": { "text": "string" }, "privacy": "public", "description": "Format string for the default label of the control.\nPlaceholders:\n {0} - current value of the control.\n {1} - max value of the control.", "attribute": "label-format" }, { "kind": "method", "name": "_indeterminateChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_maxChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_valueChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updateARIA", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updateProgress", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_renderLabel", "privacy": "protected" }, { "kind": "method", "name": "_renderLabelFormat", "privacy": "protected", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "_renderDefaultSlot", "privacy": "protected" } ], "attributes": [ { "name": "max", "type": { "text": "number" }, "default": "100", "description": "Maximum value of the control.", "fieldName": "max", "attribute": "max" }, { "name": "value", "type": { "text": "number" }, "default": "0", "description": "The value of the control.", "fieldName": "value", "attribute": "value" }, { "name": "variant", "type": { "text": "StyleVariant" }, "default": "'primary'", "description": "The variant of the control.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" } }, { "name": "animation-duration", "type": { "text": "number" }, "default": "500", "description": "Animation duration in milliseconds.", "fieldName": "animationDuration", "attribute": "animation-duration" }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "The indeterminate state of the control.", "fieldName": "indeterminate", "attribute": "indeterminate" }, { "name": "hide-label", "type": { "text": "boolean" }, "default": "false", "description": "Shows/hides the label of the control.", "fieldName": "hideLabel", "attribute": "hide-label" }, { "name": "label-format", "type": { "text": "string" }, "description": "Format string for the default label of the control.\nPlaceholders:\n {0} - current value of the control.\n {1} - max value of the control.", "fieldName": "labelFormat", "attribute": "label-format" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "IgcProgressBaseComponent", "declaration": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/progress/circular-gradient.ts", "declarations": [ { "kind": "class", "description": "Used for defining gradient stops in the igc-circular-progress.\nFor each `igc-circular-gradient` defined as `gradient` slot of `igc-circular-progress` element would be created a SVG stop element.\nThe values passed as `color`, `offset` and `opacity` would be set as\n`stop-color`, `offset` and `stop-opacity` of the SVG element without further validations.", "name": "IgcCircularGradientComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-circular-gradient'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "offset", "type": { "text": "string" }, "privacy": "public", "default": "'0%'", "description": "Defines where the gradient stop is placed along the gradient vector", "attribute": "offset" }, { "kind": "field", "name": "color", "type": { "text": "string" }, "privacy": "public", "default": "'black'", "description": "Defines the color of the gradient stop", "attribute": "color" }, { "kind": "field", "name": "opacity", "type": { "text": "number" }, "privacy": "public", "default": "1", "description": "Defines the opacity of the gradient stop", "attribute": "opacity" } ], "attributes": [ { "name": "offset", "type": { "text": "string" }, "default": "'0%'", "description": "Defines where the gradient stop is placed along the gradient vector", "fieldName": "offset", "attribute": "offset" }, { "name": "color", "type": { "text": "string" }, "default": "'black'", "description": "Defines the color of the gradient stop", "fieldName": "color", "attribute": "color" }, { "name": "opacity", "type": { "text": "number" }, "default": "1", "description": "Defines the opacity of the gradient stop", "fieldName": "opacity", "attribute": "opacity" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-circular-gradient", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCircularGradientComponent", "module": "src/components/progress/circular-gradient.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/progress/circular-progress.ts", "declarations": [ { "kind": "class", "description": "A circular progress indicator used to express unspecified wait time or display\nthe length of a process.", "name": "IgcCircularProgressComponent", "cssParts": [ { "description": "The igc-circular-progress SVG element.", "name": "svg" }, { "description": "The igc-circular-progress linear-gradient start color.", "name": "gradient_start" }, { "description": "The igc-circular-progress linear-gradient end color.", "name": "gradient_end" }, { "description": "The igc-circular-progress ring track area.", "name": "track" }, { "description": "The igc-circular-progress indicator area.", "name": "fill" }, { "description": "The igc-circular-progress label.", "name": "label" }, { "description": "The igc-circular-progress label value.", "name": "value" }, { "description": "The igc-circular-progress indeterminate state.", "name": "indeterminate" }, { "description": "The igc-circular-progress primary state.", "name": "primary" }, { "description": "The igc-circular-progress error state.", "name": "danger" }, { "description": "The igc-circular-progress warning state.", "name": "warning" }, { "description": "The igc-circular-progress info state.", "name": "info" }, { "description": "The igc-circular-progress success state.", "name": "success" } ], "slots": [ { "description": "The text area container.", "name": "" }, { "description": "Customize the progress bar in order to use a color gradient instead of a solid color. Accepts `igc-circular-gradient` elements.", "name": "gradient" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-circular-progress'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_gradientId", "privacy": "private", "readonly": true, "default": "`circular-progress-${nextId++}`" }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderSvg", "privacy": "protected" }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_base", "type": { "text": "HTMLElement" }, "privacy": "protected", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_percentage", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_progress", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_hasFraction", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_styleInfo", "type": { "text": "StyleInfo" }, "privacy": "protected", "default": "{ '--_progress-whole': '0.00', '--_progress-integer': '0', '--_progress-fraction': '0', '--_transition-duration': '0ms', }", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number" }, "privacy": "public", "default": "100", "description": "Maximum value of the control.", "attribute": "max", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The value of the control.", "attribute": "value", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "StyleVariant" }, "privacy": "public", "default": "'primary'", "description": "The variant of the control.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "animationDuration", "type": { "text": "number" }, "privacy": "public", "default": "500", "description": "Animation duration in milliseconds.", "attribute": "animation-duration", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The indeterminate state of the control.", "attribute": "indeterminate", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "hideLabel", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Shows/hides the label of the control.", "attribute": "hide-label", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "labelFormat", "type": { "text": "string" }, "privacy": "public", "description": "Format string for the default label of the control.\nPlaceholders:\n {0} - current value of the control.\n {1} - max value of the control.", "attribute": "label-format", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_indeterminateChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_maxChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_valueChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_updateARIA", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_updateProgress", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "protected", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderLabelFormat", "privacy": "protected", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderDefaultSlot", "privacy": "protected", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } } ], "superclass": { "name": "IgcProgressBaseComponent", "module": "/src/components/progress/base.js" }, "tagName": "igc-circular-progress", "customElement": true, "attributes": [ { "name": "max", "type": { "text": "number" }, "default": "100", "description": "Maximum value of the control.", "fieldName": "max", "attribute": "max", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "value", "type": { "text": "number" }, "default": "0", "description": "The value of the control.", "fieldName": "value", "attribute": "value", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "variant", "type": { "text": "StyleVariant" }, "default": "'primary'", "description": "The variant of the control.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "animation-duration", "type": { "text": "number" }, "default": "500", "description": "Animation duration in milliseconds.", "fieldName": "animationDuration", "attribute": "animation-duration", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "The indeterminate state of the control.", "fieldName": "indeterminate", "attribute": "indeterminate", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "hide-label", "type": { "text": "boolean" }, "default": "false", "description": "Shows/hides the label of the control.", "fieldName": "hideLabel", "attribute": "hide-label", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "label-format", "type": { "text": "string" }, "description": "Format string for the default label of the control.\nPlaceholders:\n {0} - current value of the control.\n {1} - max value of the control.", "fieldName": "labelFormat", "attribute": "label-format", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcCircularProgressComponent", "module": "src/components/progress/circular-progress.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/combo-header.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcComboHeaderComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-combo-header'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcComboHeaderComponent", "module": "src/components/combo/combo-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/combo-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcComboItemComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-combo-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "index", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the item is selected.", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the item is active.", "attribute": "active", "reflects": true }, { "kind": "field", "name": "hideCheckbox", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the item is active.", "attribute": "hide-checkbox" }, { "kind": "method", "name": "renderCheckbox", "privacy": "private" } ], "attributes": [ { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the item is selected.", "fieldName": "selected", "attribute": "selected" }, { "name": "hide-checkbox", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the item is active.", "fieldName": "hideCheckbox", "attribute": "hide-checkbox" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the item is active.", "fieldName": "active" } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcComboItemComponent", "module": "src/components/combo/combo-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/combo-list.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcComboListComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-combo-list'" }, { "kind": "field", "name": "scroller", "type": { "text": "boolean" }, "privacy": "public", "default": "true" }, { "kind": "method", "name": "register", "privacy": "public", "static": true } ], "superclass": { "name": "LitVirtualizer", "package": "@lit-labs/virtualizer/LitVirtualizer.js" } } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcComboListComponent", "module": "src/components/combo/combo-list.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/combo/operations/filter.ts", "declarations": [ { "kind": "class", "description": "", "name": "FilterDataOperation", "members": [ { "kind": "method", "name": "normalize", "privacy": "protected", "parameters": [ { "name": "string", "type": { "text": "string" } }, { "name": "{ caseSensitive, matchDiacritics }", "type": { "text": "FilteringOptions" } } ] }, { "kind": "method", "name": "apply", "privacy": "public", "parameters": [ { "name": "data", "type": { "text": "ComboRecord[]" } }, { "name": "controller", "type": { "text": "DataController" } } ] } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "FilterDataOperation", "module": "src/components/combo/operations/filter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/operations/group.ts", "declarations": [ { "kind": "class", "description": "", "name": "GroupDataOperation", "members": [ { "kind": "method", "name": "apply", "privacy": "public", "return": { "type": { "text": "ComboRecord[]" } }, "parameters": [ { "name": "data", "type": { "text": "ComboRecord[]" } }, { "name": "controller", "type": { "text": "DataController" } } ] } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "GroupDataOperation", "module": "src/components/combo/operations/group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/controllers/data.ts", "declarations": [ { "kind": "class", "description": "", "name": "DataController", "members": [ { "kind": "field", "name": "grouping", "privacy": "protected", "default": "new GroupDataOperation()" }, { "kind": "field", "name": "filtering", "privacy": "protected", "default": "new FilterDataOperation()" }, { "kind": "field", "name": "_searchTerm", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_compareCollator", "privacy": "private", "default": "new Intl.Collator()" }, { "kind": "field", "name": "dataState", "type": { "text": "ComboRecord[]" }, "privacy": "public", "default": "[]" }, { "kind": "method", "name": "runPipeline", "privacy": "public" }, { "kind": "field", "name": "searchTerm", "privacy": "public" }, { "kind": "field", "name": "filteringOptions", "type": { "text": "FilteringOptions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "groupingOptions", "type": { "text": "GroupingOptions" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "compareCollator", "type": { "text": "Intl.Collator" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "index", "privacy": "private", "return": { "type": { "text": "ComboRecord[]" } }, "parameters": [ { "name": "data", "type": { "text": "T[]" } } ] }, { "kind": "method", "name": "hostConnected", "privacy": "public" }, { "kind": "method", "name": "apply", "privacy": "public", "return": { "type": { "text": "ComboRecord[]" } }, "parameters": [ { "name": "data", "type": { "text": "T[]" } } ] } ] } ], "exports": [ { "kind": "js", "name": "DataController", "declaration": { "name": "DataController", "module": "src/components/combo/controllers/data.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/controllers/navigation.ts", "declarations": [ { "kind": "class", "description": "", "name": "ComboNavigationController", "members": [ { "kind": "field", "name": "_active", "type": { "text": "number" }, "privacy": "private", "default": "-1" }, { "kind": "field", "name": "_config", "type": { "text": "ComboNavigationConfig" }, "privacy": "private", "default": "config" }, { "kind": "field", "name": "active", "type": { "text": "number" }, "privacy": "public" }, { "kind": "field", "name": "input", "type": { "text": "IgcInputComponent" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "searchInput", "type": { "text": "IgcInputComponent" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "list", "type": { "text": "IgcComboListComponent" }, "privacy": "public", "readonly": true }, { "kind": "field", "name": "_firstItem", "type": { "text": "number" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_lastItem", "type": { "text": "number" }, "privacy": "protected", "readonly": true }, { "kind": "method", "name": "_hide", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_show", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_toggleSelection", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_select", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "field", "name": "_onSpace", "privacy": "private" }, { "kind": "field", "name": "_onEnter", "privacy": "private" }, { "kind": "field", "name": "_onTab", "privacy": "private" }, { "kind": "field", "name": "_onEscape", "privacy": "private" }, { "kind": "field", "name": "_onMainInputArrowDown", "privacy": "private" }, { "kind": "field", "name": "_onSearchArrowDown", "privacy": "private" }, { "kind": "field", "name": "_onHome", "privacy": "private" }, { "kind": "field", "name": "_onEnd", "privacy": "private" }, { "kind": "field", "name": "_onArrowUp", "privacy": "private" }, { "kind": "field", "name": "_onArrowDown", "privacy": "private" }, { "kind": "method", "name": "_scrollToActive", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "behavior", "optional": true, "type": { "text": "ScrollBehavior" } } ] }, { "kind": "method", "name": "_getNearestItem", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "start", "type": { "text": "number" } }, { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_getNextItem", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "hostDisconnected", "privacy": "public", "return": { "type": { "text": "void" } } } ] } ], "exports": [ { "kind": "js", "name": "ComboNavigationController", "declaration": { "name": "ComboNavigationController", "module": "src/components/combo/controllers/navigation.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/controllers/selection.ts", "declarations": [ { "kind": "class", "description": "", "name": "SelectionController", "members": [ { "kind": "field", "name": "_selected", "type": { "text": "Set" }, "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "isEmpty", "privacy": "public", "description": "Whether the current selection is empty", "readonly": true }, { "kind": "field", "name": "asArray", "privacy": "public", "description": "Returns the current selection as an array", "readonly": true }, { "kind": "method", "name": "has", "privacy": "public", "parameters": [ { "name": "item", "optional": true, "type": { "text": "T" } } ], "description": "Whether the current selection has the given item" }, { "kind": "method", "name": "clear", "privacy": "public", "description": "Clears the current selection" }, { "kind": "method", "name": "getSelectedValuesByKey", "privacy": "public", "parameters": [ { "name": "key", "optional": true, "type": { "text": "Keys" } } ] }, { "kind": "method", "name": "getValue", "privacy": "public", "return": { "type": { "text": "ComboValue[]" } }, "parameters": [ { "name": "items", "type": { "text": "T[]" } }, { "name": "key", "type": { "text": "Keys" } } ] }, { "kind": "method", "name": "handleChange", "privacy": "private", "parameters": [ { "name": "detail", "type": { "text": "IgcComboChangeEventArgs" } } ] }, { "kind": "method", "name": "getItemsByValueKey", "privacy": "private", "parameters": [ { "name": "keys", "type": { "text": "Values[]" } } ] }, { "kind": "method", "name": "selectValueKeys", "privacy": "private", "parameters": [ { "name": "keys", "type": { "text": "Values[]" } } ] }, { "kind": "method", "name": "deselectValueKeys", "privacy": "private", "parameters": [ { "name": "keys", "type": { "text": "Values[]" } } ] }, { "kind": "method", "name": "selectObjects", "privacy": "private", "parameters": [ { "name": "items", "type": { "text": "T[]" } } ] }, { "kind": "method", "name": "deselectObjects", "privacy": "private", "parameters": [ { "name": "items", "type": { "text": "T[]" } } ] }, { "kind": "method", "name": "selectAll", "privacy": "private" }, { "kind": "method", "name": "deselectAll", "privacy": "private" }, { "kind": "method", "name": "select", "privacy": "public", "parameters": [ { "name": "items", "optional": true, "type": { "text": "Item | Item[]" } }, { "name": "emit", "default": "false" } ] }, { "kind": "method", "name": "deselect", "privacy": "public", "parameters": [ { "name": "items", "optional": true, "type": { "text": "Item | Item[]" } }, { "name": "emit", "default": "false" } ] }, { "kind": "method", "name": "changeSelection", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "selectByIndex", "privacy": "public", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "hostConnected", "privacy": "public" }, { "kind": "method", "name": "hostDisconnected", "privacy": "public" } ] } ], "exports": [ { "kind": "js", "name": "SelectionController", "declaration": { "name": "SelectionController", "module": "src/components/combo/controllers/selection.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/validators.ts", "declarations": [ { "kind": "variable", "name": "comboValidators", "type": { "text": "Validator[]" }, "default": "[ { key: 'valueMissing', message: ValidationResourceStringsEN.required_validation_error!, isValid: ({ required, value }) => required ? Array.isArray(value) && value.length > 0 : true, }, ]" } ], "exports": [ { "kind": "js", "name": "comboValidators", "declaration": { "name": "comboValidators", "module": "src/components/combo/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/combo/combo.ts", "declarations": [ { "kind": "class", "description": "The Combo component is similar to the Select component in that it provides a list of options from which the user can make a selection.\nIn contrast to the Select component, the Combo component displays all options in a virtualized list of items,\nmeaning the combo box can simultaneously show thousands of options, where one or more options can be selected.\nAdditionally, users can create custom item templates, allowing for robust data visualization.\nThe Combo component features case-sensitive filtering, grouping, complex data binding, dynamic addition of values and more.", "name": "IgcComboComponent", "cssParts": [ { "description": "The encapsulated text label of the combo.", "name": "label" }, { "description": "The main input field of the combo.", "name": "input" }, { "description": "The native input of the main input field of the combo.", "name": "native-input" }, { "description": "The prefix wrapper of the combo.", "name": "prefix" }, { "description": "The suffix wrapper of the combo.", "name": "suffix" }, { "description": "The toggle icon wrapper of the combo.", "name": "toggle-icon" }, { "description": "The clear icon wrapper of the combo.", "name": "clear-icon" }, { "description": "The case icon wrapper of the combo.", "name": "case-icon" }, { "description": "The helper text wrapper of the combo.", "name": "helper-text" }, { "description": "The search input field of the combo.", "name": "search-input" }, { "description": "The list of options wrapper of the combo.", "name": "list-wrapper" }, { "description": "The list of options box of the combo.", "name": "list" }, { "description": "Represents each item in the list of options of the combo.", "name": "item" }, { "description": "Represents each header in the list of options of the combo.", "name": "group-header" }, { "description": "Appended to the item parts list when the item is active of the combo.", "name": "active" }, { "description": "Appended to the item parts list when the item is selected of the combo.", "name": "selected" }, { "description": "Represents each checkbox of each list item of the combo.", "name": "checkbox" }, { "description": "Represents the checkbox indicator of each list item of the combo.", "name": "checkbox-indicator" }, { "description": "Appended to checkbox parts list when checkbox is checked in the combo.", "name": "checked" }, { "description": "The container holding the header content of the combo.", "name": "header" }, { "description": "The container holding the footer content of the combo.", "name": "footer" }, { "description": "The container holding the empty content of the combo.", "name": "empty" } ], "slots": [ { "description": "Renders content before the input of the combo.", "name": "prefix" }, { "description": "Renders content after the input of the combo.", "name": "suffix" }, { "description": "Renders a container before the list of options of the combo.", "name": "header" }, { "description": "Renders a container after the list of options of the combo.", "name": "footer" }, { "description": "Renders content when the combo dropdown list has no items/data.", "name": "empty" }, { "description": "Renders content below the input of the combo.", "name": "helper-text" }, { "description": "Renders content inside the suffix container of the combo.", "name": "toggle-icon" }, { "description": "Renders content inside the suffix container of the combo.", "name": "clear-icon" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-combo'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_inputRef", "privacy": "private", "description": "The primary input of the combo component." }, { "kind": "field", "name": "_searchRef", "privacy": "private", "description": "The search input of the combo component." }, { "kind": "field", "name": "_listRef", "privacy": "private", "description": "The combo virtualized dropdown list." }, { "kind": "field", "name": "_rootClickController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_data", "type": { "text": "T[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_valueKey", "type": { "text": "Keys | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_displayKey", "type": { "text": "Keys | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_groupKey", "type": { "text": "Keys | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_disableFiltering", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_singleSelect", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_groupSorting", "type": { "text": "GroupingDirection" }, "privacy": "private", "default": "'asc'", "expandedType": { "text": "'asc' | 'desc' | 'none'" } }, { "kind": "field", "name": "_filteringOptions", "type": { "text": "FilteringOptions" }, "privacy": "private", "default": "{ filterKey: this.displayKey, caseSensitive: false, matchDiacritics: false, }" }, { "kind": "field", "name": "_activeDescendant", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "_displayValue", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_state", "privacy": "protected", "default": "new DataController(this)" }, { "kind": "field", "name": "_selection", "privacy": "protected", "default": "new SelectionController(this, this._state)" }, { "kind": "field", "name": "_navigation", "privacy": "protected", "default": "new ComboNavigationController(this, this._state, { input: this._inputRef, search: this._searchRef, list: this._listRef, })" }, { "kind": "field", "name": "inputSuffix", "type": { "text": "HTMLElement[]" }, "privacy": "protected" }, { "kind": "field", "name": "inputPrefix", "type": { "text": "HTMLElement[]" }, "privacy": "protected" }, { "kind": "field", "name": "data", "privacy": "public", "description": "The data source used to generate the list of options." }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The outlined attribute of the control.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "singleSelect", "privacy": "public", "description": "Enables single selection mode and moves item filtering to the main input.", "default": "false", "attribute": "single-select", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "privacy": "public", "description": "The autofocus attribute of the control.", "attribute": "autofocus" }, { "kind": "field", "name": "autofocusList", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Focuses the list of options when the menu opens.", "attribute": "autofocus-list" }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "attribute": "locale" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label attribute of the control.", "attribute": "label" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder" }, { "kind": "field", "name": "placeholderSearch", "privacy": "public", "description": "The placeholder attribute of the search input.", "attribute": "placeholder-search" }, { "kind": "field", "name": "_placeholderSearch", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the open state of the component.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.", "type": { "text": "IComboResourceStrings" } }, { "kind": "field", "name": "valueKey", "privacy": "public", "description": "The key in the data source used when selecting items.", "attribute": "value-key" }, { "kind": "field", "name": "displayKey", "privacy": "public", "description": "The key in the data source used to display items in the list.", "attribute": "display-key" }, { "kind": "field", "name": "groupKey", "privacy": "public", "description": "The key in the data source used to group items in the list.", "attribute": "group-key" }, { "kind": "field", "name": "groupSorting", "privacy": "public", "description": "Sorts the items in each group by ascending or descending order.", "default": "asc", "type": { "text": "\"asc\" | \"desc\" | \"none\"" }, "attribute": "group-sorting" }, { "kind": "field", "name": "filteringOptions", "privacy": "public", "description": "An object that configures the filtering of the combo.", "type": { "text": "FilteringOptions" }, "parameters": [ { "description": "The key in the data source used when filtering the list of options.", "name": "filterKey" }, { "description": "Determines whether the filtering operation should be case sensitive.", "name": "caseSensitive" }, { "description": "-If true, the filter distinguishes between accented letters and their base letters.", "name": "matchDiacritics" } ], "attribute": "filtering-options" }, { "kind": "field", "name": "caseSensitiveIcon", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Enables the case sensitive search icon in the filtering input.", "attribute": "case-sensitive-icon" }, { "kind": "field", "name": "disableFiltering", "privacy": "public", "description": "Disables the filtering of the list of options.", "default": "false", "attribute": "disable-filtering", "type": { "text": "boolean" } }, { "kind": "field", "name": "disableClear", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the clear button.", "attribute": "disable-clear" }, { "kind": "field", "name": "itemTemplate", "type": { "text": "ComboItemTemplate" }, "privacy": "public", "description": "The template used for the content of each combo item." }, { "kind": "field", "name": "groupHeaderTemplate", "type": { "text": "ComboItemTemplate" }, "privacy": "public", "description": "The template used for the content of each combo group header." }, { "kind": "field", "name": "value", "privacy": "public", "description": "Returns the current selection as a list of comma separated values,\nrepresented by the value key, when provided.", "attribute": "value", "type": { "text": "ComboValue[]" } }, { "kind": "method", "name": "_updateSelection", "privacy": "protected" }, { "kind": "method", "name": "toggleDirectiveChange", "privacy": "protected" }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "resetSearchTerm", "privacy": "protected" }, { "kind": "method", "name": "updateValue", "privacy": "protected", "parameters": [ { "name": "initial", "default": "false" } ] }, { "kind": "method", "name": "focus", "privacy": "public", "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the component." }, { "kind": "method", "name": "blur", "privacy": "public", "description": "Removes focus from the component." }, { "kind": "field", "name": "selection", "type": { "text": "T[]" }, "privacy": "public", "description": "Returns the current selection as an array of objects as provided in the `data` source.", "readonly": true }, { "kind": "method", "name": "select", "privacy": "public", "parameters": [ { "name": "items", "optional": true, "type": { "text": "Item | Items" }, "description": "One or more items to be selected. Multiple items should be passed as an array.\nWhen valueKey is specified, the corresponding value should be used in place of the item reference." } ], "description": "Selects option(s) in the list by either reference or valueKey.\nIf not argument is provided all items will be selected." }, { "kind": "method", "name": "deselect", "privacy": "public", "parameters": [ { "name": "items", "optional": true, "type": { "text": "Item | Items" }, "description": "One or more items to be deselected. Multiple items should be passed as an array.\nWhen valueKey is specified, the corresponding value should be used in place of the item reference." } ], "description": "Deselects option(s) in the list by either reference or valueKey.\nIf not argument is provided all items will be deselected." }, { "kind": "method", "name": "handleMainInput", "privacy": "protected", "parameters": [ { "name": "{ detail }", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleFocusIn", "privacy": "protected" }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "handleSearchInput", "privacy": "protected", "parameters": [ { "name": "{ detail }", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "handleOpening", "privacy": "protected" }, { "kind": "method", "name": "handleClosing", "privacy": "protected", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_show", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "true" } ] }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the list of options." }, { "kind": "method", "name": "_hide", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "true" } ] }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the list of options." }, { "kind": "method", "name": "_toggle", "privacy": "protected", "parameters": [ { "name": "emit", "default": "true" } ] }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the list of options." }, { "kind": "method", "name": "_getActiveDescendantId", "privacy": "private", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "field", "name": "itemRenderer", "type": { "text": "ComboRenderFunction" }, "privacy": "protected" }, { "kind": "method", "name": "itemClickHandler", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "toggleSelect", "privacy": "protected", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "selectByIndex", "privacy": "protected", "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "clearSingleSelection", "privacy": "protected" }, { "kind": "method", "name": "handleClearIconClick", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "toggleCaseSensitivity", "privacy": "protected" }, { "kind": "method", "name": "getMainAriaLabel", "privacy": "protected" }, { "kind": "method", "name": "_stopPropagation", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "renderToggleIcon", "privacy": "private" }, { "kind": "method", "name": "renderClearIcon", "privacy": "private" }, { "kind": "method", "name": "renderMainInput", "privacy": "private" }, { "kind": "method", "name": "renderSearchInput", "privacy": "private" }, { "kind": "method", "name": "renderEmptyTemplate", "privacy": "private" }, { "kind": "method", "name": "renderList", "privacy": "private" }, { "kind": "method", "name": "renderHelperText", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the control's selection has changed.", "name": "igcChange" }, { "description": "Emitted just before the list of options is opened.", "name": "igcOpening" }, { "description": "Emitted after the list of options is opened.", "name": "igcOpened" }, { "description": "Emitter just before the list of options is closed.", "name": "igcClosing" }, { "description": "Emitted after the list of options is closed.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "The outlined attribute of the control.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "single-select", "description": "Enables single selection mode and moves item filtering to the main input.", "default": "false", "fieldName": "singleSelect", "attribute": "single-select", "type": { "text": "boolean" } }, { "name": "autofocus", "type": { "text": "boolean" }, "description": "The autofocus attribute of the control.", "fieldName": "autofocus", "attribute": "autofocus" }, { "name": "autofocus-list", "type": { "text": "boolean" }, "default": "false", "description": "Focuses the list of options when the menu opens.", "fieldName": "autofocusList", "attribute": "autofocus-list" }, { "name": "locale", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "fieldName": "locale", "attribute": "locale" }, { "name": "label", "type": { "text": "string" }, "description": "The label attribute of the control.", "fieldName": "label", "attribute": "label" }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder" }, { "name": "placeholder-search", "description": "The placeholder attribute of the search input.", "fieldName": "placeholderSearch", "attribute": "placeholder-search" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the component.", "fieldName": "open", "attribute": "open" }, { "name": "value-key", "description": "The key in the data source used when selecting items.", "fieldName": "valueKey", "attribute": "value-key" }, { "name": "display-key", "description": "The key in the data source used to display items in the list.", "fieldName": "displayKey", "attribute": "display-key" }, { "name": "group-key", "description": "The key in the data source used to group items in the list.", "fieldName": "groupKey", "attribute": "group-key" }, { "name": "group-sorting", "description": "Sorts the items in each group by ascending or descending order.", "default": "asc", "type": { "text": "\"asc\" | \"desc\" | \"none\"" }, "fieldName": "groupSorting", "attribute": "group-sorting" }, { "name": "filtering-options", "description": "An object that configures the filtering of the combo.", "type": { "text": "FilteringOptions" }, "parameters": [ { "description": "The key in the data source used when filtering the list of options.", "name": "filterKey" }, { "description": "Determines whether the filtering operation should be case sensitive.", "name": "caseSensitive" }, { "description": "-If true, the filter distinguishes between accented letters and their base letters.", "name": "matchDiacritics" } ], "fieldName": "filteringOptions", "attribute": "filtering-options" }, { "name": "case-sensitive-icon", "type": { "text": "boolean" }, "default": "false", "description": "Enables the case sensitive search icon in the filtering input.", "fieldName": "caseSensitiveIcon", "attribute": "case-sensitive-icon" }, { "name": "disable-filtering", "description": "Disables the filtering of the list of options.", "default": "false", "fieldName": "disableFiltering", "attribute": "disable-filtering", "type": { "text": "boolean" } }, { "name": "disable-clear", "type": { "text": "boolean" }, "default": "false", "description": "Hides the clear button.", "fieldName": "disableClear", "attribute": "disable-clear" }, { "name": "value", "description": "Returns the current selection as a list of comma separated values,\nrepresented by the value key, when provided.", "fieldName": "value", "attribute": "value", "type": { "text": "ComboValue[]" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-combo", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcComboComponent", "module": "src/components/combo/combo.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-picker/validators.ts", "declarations": [ { "kind": "variable", "name": "datePickerValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, minDateValidator, maxDateValidator, { key: 'badInput', message: ({ value }) => formatString( ValidationResourceStringsEN.disabled_date_validation_error!, value ), isValid: ({ value, disabledDates }) => value && disabledDates ? !isDateInRanges(value, disabledDates) : true, }, ]" } ], "exports": [ { "kind": "js", "name": "datePickerValidators", "declaration": { "name": "datePickerValidators", "module": "src/components/date-picker/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/date-picker/date-picker.ts", "declarations": [ { "kind": "class", "description": "igc-date-picker is a feature rich component used for entering a date through manual text input or\nchoosing date values from a calendar dialog that pops up.", "name": "IgcDatePickerComponent", "cssParts": [ { "description": "The label wrapper that renders content above the target input.", "name": "label" }, { "description": "The main wrapper that holds all main input elements.", "name": "container" }, { "description": "The native input element.", "name": "input" }, { "description": "The prefix wrapper.", "name": "prefix" }, { "description": "The suffix wrapper.", "name": "suffix" }, { "description": "The calendar icon wrapper for closed state.", "name": "calendar-icon" }, { "description": "The calendar icon wrapper for opened state.", "name": "calendar-icon-open" }, { "description": "The clear icon wrapper.", "name": "clear-icon" }, { "description": "The actions wrapper.", "name": "actions" }, { "description": "The helper-text wrapper that renders content below the target input.", "name": "helper-text" }, { "description": "The calendar header element.", "name": "header" }, { "description": "The calendar header title element.", "name": "header-title" }, { "description": "The calendar header date element.", "name": "header-date" }, { "description": "The calendar content element which contains the views and navigation elements.", "name": "calendar-content" }, { "description": "The calendar navigation container element.", "name": "navigation" }, { "description": "The calendar months navigation button element.", "name": "months-navigation" }, { "description": "The calendar years navigation button element.", "name": "years-navigation" }, { "description": "The calendar years range element.", "name": "years-range" }, { "description": "The calendar navigation buttons container.", "name": "navigation-buttons" }, { "description": "The calendar previous/next navigation button.", "name": "navigation-button" }, { "description": "The calendar days view container element.", "name": "days-view-container" }, { "description": "The calendar days view element.", "name": "days-view" }, { "description": "The calendar months view element.", "name": "months-view" }, { "description": "The calendar years view element.", "name": "years-view" }, { "description": "The calendar days row element.", "name": "days-row" }, { "description": "The calendar week header label element.", "name": "calendar-label" }, { "description": "The calendar week number element.", "name": "week-number" }, { "description": "The calendar week number inner element.", "name": "week-number-inner" }, { "description": "The calendar date element.", "name": "date" }, { "description": "The calendar date inner element.", "name": "date-inner" }, { "description": "The calendar first selected date element in range selection.", "name": "first" }, { "description": "The calendar last selected date element in range selection.", "name": "last" }, { "description": "The calendar inactive date element.", "name": "inactive" }, { "description": "The calendar hidden date element.", "name": "hidden" }, { "description": "The calendar weekend date element.", "name": "weekend" }, { "description": "The calendar range selected element.", "name": "range" }, { "description": "The calendar special date element.", "name": "special" }, { "description": "The calendar disabled date element.", "name": "disabled" }, { "description": "The calendar single selected date element.", "name": "single" }, { "description": "The calendar range selection preview date element.", "name": "preview" }, { "description": "The calendar month element.", "name": "month" }, { "description": "The calendar month inner element.", "name": "month-inner" }, { "description": "The calendar year element.", "name": "year" }, { "description": "The calendar year inner element.", "name": "year-inner" }, { "description": "The calendar selected state for element(s). Applies to date, month and year elements.", "name": "selected" }, { "description": "The calendar current state for element(s). Applies to date, month and year elements.", "name": "current" } ], "slots": [ { "description": "Renders content before the input.", "name": "prefix" }, { "description": "Renders content after the input.", "name": "suffix" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the value is in the disabledDates ranges.", "name": "bad-input" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when the max validation fails.", "name": "range-overflow" }, { "description": "Renders content when the min validation fails.", "name": "range-underflow" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" }, { "description": "Renders content in the calendar title.", "name": "title" }, { "description": "Renders content instead of the current date/range in the calendar header.", "name": "header-date" }, { "description": "Renders a clear icon template.", "name": "clear-icon" }, { "description": "Renders the icon/content for the calendar picker.", "name": "calendar-icon" }, { "description": "Renders the icon/content for the picker in open state.", "name": "calendar-icon-open" }, { "description": "Renders content in the action part of the picker in open state.", "name": "actions" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-date-picker'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "private", "readonly": true, "default": "`date-picker-${nextId++}`" }, { "kind": "field", "name": "_themes", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_i18nController", "privacy": "protected", "readonly": true, "description": "For now we use the core validation strings internally only, to avoid mixing with old resources by users.\nTo Do: Update resourceStrings type when the IgcCalendarResourceStrings is changed to ICalendarResourceStrings" }, { "kind": "field", "name": "_oldValue", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_activeDate", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_min", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_max", "type": { "text": "Date | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_disabledDates", "type": { "text": "DateRangeDescriptor[] | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_dateConstraints", "type": { "text": "DateRangeDescriptor[] | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_inputFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_displayFormat", "type": { "text": "string | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_rootClickController", "type": { "text": "RootClickController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "IgcDateTimeInputComponent" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_calendar", "type": { "text": "IgcCalendarComponent" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isDropDown", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isMaterial", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the state of the datepicker dropdown.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label of the datepicker.", "attribute": "label" }, { "kind": "field", "name": "mode", "type": { "text": "PickerMode" }, "privacy": "public", "default": "'dropdown'", "description": "Determines whether the calendar is opened in a dropdown or a modal dialog", "attribute": "mode", "expandedType": { "text": "'dropdown' | 'dialog'" } }, { "kind": "field", "name": "nonEditable", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to allow typing in the input.", "attribute": "non-editable", "reflects": true }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value of the picker", "attribute": "value", "type": { "text": "Date | null" } }, { "kind": "field", "name": "activeDate", "privacy": "public", "description": "Gets/Sets the date which is shown in the calendar picker and is highlighted.\nBy default it is the current date.", "type": { "text": "Date" }, "attribute": "active-date" }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum value required for the date picker to remain valid.", "attribute": "min", "type": { "text": "Date | null" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value required for the date picker to remain valid.", "attribute": "max", "type": { "text": "Date | null" } }, { "kind": "field", "name": "headerOrientation", "type": { "text": "CalendarHeaderOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the calendar header.", "attribute": "header-orientation", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "orientation", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the multiple months displayed in the calendar's days view.", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "hideHeader", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the calendar hides its header.", "attribute": "hide-header", "reflects": true }, { "kind": "field", "name": "hideOutsideDays", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Controls the visibility of the dates that do not belong to the current month.", "attribute": "hide-outside-days", "reflects": true }, { "kind": "field", "name": "disabledDates", "privacy": "public", "description": "Gets/sets disabled dates." }, { "kind": "field", "name": "specialDates", "type": { "text": "DateRangeDescriptor[]" }, "privacy": "public", "description": "Gets/sets special dates." }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder" }, { "kind": "field", "name": "visibleMonths", "type": { "text": "number" }, "privacy": "public", "default": "1", "description": "The number of months displayed in the calendar.", "attribute": "visible-months" }, { "kind": "field", "name": "showWeekNumbers", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to show the number of the week in the calendar.", "attribute": "show-week-numbers", "reflects": true }, { "kind": "field", "name": "displayFormat", "privacy": "public", "description": "Format to display the value in when not editing.\nDefaults to the locale format if not set.", "attribute": "display-format", "type": { "text": "string" } }, { "kind": "field", "name": "inputFormat", "privacy": "public", "description": "The date format to apply on the input.\nDefaults to the current locale Intl.DateTimeFormat", "attribute": "input-format", "type": { "text": "string" } }, { "kind": "field", "name": "prompt", "type": { "text": "string" }, "privacy": "public", "default": "'_'", "description": "The prompt symbol to use for unfilled parts of the mask.", "attribute": "prompt" }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for formatting the display value.", "attribute": "locale" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.", "type": { "text": "IgcCalendarResourceStrings" } }, { "kind": "field", "name": "weekStart", "type": { "text": "WeekDays" }, "privacy": "public", "default": "'sunday'", "description": "Sets the start day of the week for the calendar.", "attribute": "week-start", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" } }, { "kind": "method", "name": "_openChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setDateConstraints", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_shouldCloseCalendarDropdown", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_onEscapeKey", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleFocusOut", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ relatedTarget }", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "_handlerCalendarIconSlotPointerDown", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleInputClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "handleAnchorClick", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_handleInputChangeEvent", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleCalendarChangeEvent", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleInputEvent", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_handleClosing", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleDialogClosing", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_handleDialogClosed", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "clear", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Clears the input part of the component of any user input" }, { "kind": "method", "name": "stepUp", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "datePart", "optional": true, "type": { "text": "DatePart" } }, { "name": "delta", "optional": true, "type": { "text": "number" } } ], "description": "Increments the passed in date part" }, { "kind": "method", "name": "stepDown", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "datePart", "optional": true, "type": { "text": "DatePart" } }, { "name": "delta", "optional": true, "type": { "text": "number" } } ], "description": "Decrements the passed in date part" }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects the text in the input of the component" }, { "kind": "method", "name": "setSelectionRange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "direction", "optional": true, "type": { "text": "SelectionRangeDirection" } } ], "description": "Sets the text selection range in the input of the component" }, { "kind": "method", "name": "setRangeText", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "replacement", "type": { "text": "string" } }, { "name": "start", "type": { "text": "number" } }, { "name": "end", "type": { "text": "number" } }, { "name": "mode", "optional": true, "type": { "text": "RangeTextSelectMode" } } ] }, { "kind": "method", "name": "_renderClearIcon", "privacy": "private" }, { "kind": "method", "name": "_renderCalendarIcon", "privacy": "private" }, { "kind": "method", "name": "_renderCalendarSlots", "privacy": "private" }, { "kind": "method", "name": "_renderCalendar", "privacy": "private", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderActions", "privacy": "protected" }, { "kind": "method", "name": "_renderPicker", "privacy": "protected", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderLabel", "privacy": "private", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_renderHelperText", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "parameters": [ { "name": "id", "type": { "text": "string" } } ] }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "type": { "text": "<\n K extends keyof IgcBaseComboBoxEventMap,\n D extends UnpackCustomEvent,\n >(\n event: K,\n eventInitDict?: CustomEventInit\n ) => boolean" }, "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnSelect", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "attribute": "keep-open-on-select", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnOutsideClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "attribute": "keep-open-on-outside-click", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosing", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosed", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpening", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpened", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_hide", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_show", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "events": [ { "description": "Emitted just before the calendar dropdown is shown.", "name": "igcOpening" }, { "description": "Emitted after the calendar dropdown is shown.", "name": "igcOpened" }, { "description": "Emitted just before the calendar dropdown is hidden.", "name": "igcClosing" }, { "description": "Emitted after the calendar dropdown is hidden.", "name": "igcClosed" }, { "description": "Emitted when the user modifies and commits the elements's value.", "name": "igcChange" }, { "description": "Emitted when when the user types in the element.", "name": "igcInput" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the state of the datepicker dropdown.", "fieldName": "open", "attribute": "open", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "label", "type": { "text": "string" }, "description": "The label of the datepicker.", "fieldName": "label", "attribute": "label" }, { "name": "mode", "type": { "text": "PickerMode" }, "default": "'dropdown'", "description": "Determines whether the calendar is opened in a dropdown or a modal dialog", "fieldName": "mode", "attribute": "mode", "expandedType": { "text": "'dropdown' | 'dialog'" } }, { "name": "non-editable", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow typing in the input.", "fieldName": "nonEditable", "attribute": "non-editable" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly", "attribute": "readonly" }, { "name": "value", "description": "The value of the picker", "fieldName": "value", "attribute": "value", "type": { "text": "Date | null" } }, { "name": "min", "description": "The minimum value required for the date picker to remain valid.", "fieldName": "min", "attribute": "min", "type": { "text": "Date | null" } }, { "name": "max", "description": "The maximum value required for the date picker to remain valid.", "fieldName": "max", "attribute": "max", "type": { "text": "Date | null" } }, { "name": "header-orientation", "type": { "text": "CalendarHeaderOrientation" }, "default": "'horizontal'", "description": "The orientation of the calendar header.", "fieldName": "headerOrientation", "attribute": "header-orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "orientation", "type": { "text": "ContentOrientation" }, "default": "'horizontal'", "description": "The orientation of the multiple months displayed in the calendar's days view.", "fieldName": "orientation", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "hide-header", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the calendar hides its header.", "fieldName": "hideHeader", "attribute": "hide-header" }, { "name": "hide-outside-days", "type": { "text": "boolean" }, "default": "false", "description": "Controls the visibility of the dates that do not belong to the current month.", "fieldName": "hideOutsideDays", "attribute": "hide-outside-days" }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder" }, { "name": "visible-months", "type": { "text": "number" }, "default": "1", "description": "The number of months displayed in the calendar.", "fieldName": "visibleMonths", "attribute": "visible-months" }, { "name": "show-week-numbers", "type": { "text": "boolean" }, "default": "false", "description": "Whether to show the number of the week in the calendar.", "fieldName": "showWeekNumbers", "attribute": "show-week-numbers" }, { "name": "display-format", "description": "Format to display the value in when not editing.\nDefaults to the locale format if not set.", "fieldName": "displayFormat", "attribute": "display-format", "type": { "text": "string" } }, { "name": "input-format", "description": "The date format to apply on the input.\nDefaults to the current locale Intl.DateTimeFormat", "fieldName": "inputFormat", "attribute": "input-format", "type": { "text": "string" } }, { "name": "prompt", "type": { "text": "string" }, "default": "'_'", "description": "The prompt symbol to use for unfilled parts of the mask.", "fieldName": "prompt", "attribute": "prompt" }, { "name": "locale", "description": "Gets/Sets the locale used for formatting the display value.", "fieldName": "locale", "attribute": "locale" }, { "name": "active-date", "description": "Gets/Sets the date which is shown in the calendar picker and is highlighted.\nBy default it is the current date.", "type": { "text": "Date" }, "fieldName": "activeDate" }, { "name": "week-start", "type": { "text": "WeekDays" }, "default": "'sunday'", "description": "Sets the start day of the week for the calendar.", "fieldName": "weekStart", "expandedType": { "text": "'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "keep-open-on-select", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "fieldName": "keepOpenOnSelect", "attribute": "keep-open-on-select", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "keep-open-on-outside-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "fieldName": "keepOpenOnOutsideClick", "attribute": "keep-open-on-outside-click", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "mixins": [ { "name": "FormAssociatedRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcBaseComboBoxLikeComponent", "module": "/src/components/common/mixins/combo-box.js" }, "tagName": "igc-date-picker", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDatePickerComponent", "module": "src/components/date-picker/date-picker.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/controllers/root-scroll.ts", "declarations": [ { "kind": "function", "name": "addRootScrollHandler", "parameters": [ { "name": "host", "type": { "text": "RootScrollControllerHost" } }, { "name": "config", "optional": true, "type": { "text": "RootScrollControllerConfig" } } ] } ], "exports": [ { "kind": "js", "name": "addRootScrollHandler", "declaration": { "name": "addRootScrollHandler", "module": "src/components/common/controllers/root-scroll.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/mixins/option.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcBaseOptionLikeComponent", "members": [ { "kind": "field", "name": "_internals", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_active", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "_selected", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected" }, { "kind": "field", "name": "_content", "type": { "text": "Array" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_contentSlotText", "type": { "text": "string" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "active", "privacy": "public", "description": "Whether the item is active.", "attribute": "active", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "Whether the item is disabled.", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "selected", "privacy": "public", "description": "Whether the item is selected.", "attribute": "selected", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the item.\nIf not specified, the element's text content is used.", "attribute": "value", "type": { "text": "string" } } ], "attributes": [ { "name": "active", "description": "Whether the item is active.", "fieldName": "active", "attribute": "active", "type": { "text": "boolean" } }, { "name": "disabled", "description": "Whether the item is disabled.", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" } }, { "name": "selected", "description": "Whether the item is selected.", "fieldName": "selected", "attribute": "selected", "type": { "text": "boolean" } }, { "name": "value", "description": "The current value of the item.\nIf not specified, the element's text content is used.", "fieldName": "value", "attribute": "value", "type": { "text": "string" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "IgcBaseOptionLikeComponent", "declaration": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown-item.ts", "declarations": [ { "kind": "class", "description": "Represents an item in a dropdown list.", "name": "IgcDropdownItemComponent", "cssParts": [ { "description": "The prefix wrapper of the igc-dropdown-item.", "name": "prefix" }, { "description": "The main content wrapper of the igc-dropdown-item.", "name": "content" }, { "description": "The suffix wrapper of the igc-dropdown-item.", "name": "suffix" } ], "slots": [ { "description": "Renders content before the item's main content.", "name": "prefix" }, { "description": "Renders the item's main content.", "name": "" }, { "description": "Renders content after the item's main content.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-dropdown-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_active", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_selected", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_content", "type": { "text": "Array" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_contentSlotText", "type": { "text": "string" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "active", "privacy": "public", "description": "Whether the item is active.", "attribute": "active", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "Whether the item is disabled.", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "selected", "privacy": "public", "description": "Whether the item is selected.", "attribute": "selected", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the item.\nIf not specified, the element's text content is used.", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } } ], "superclass": { "name": "IgcBaseOptionLikeComponent", "module": "/src/components/common/mixins/option.js" }, "tagName": "igc-dropdown-item", "customElement": true, "attributes": [ { "name": "active", "description": "Whether the item is active.", "fieldName": "active", "attribute": "active", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "name": "disabled", "description": "Whether the item is disabled.", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "name": "selected", "description": "Whether the item is selected.", "fieldName": "selected", "attribute": "selected", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "name": "value", "description": "The current value of the item.\nIf not specified, the element's text content is used.", "fieldName": "value", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDropdownItemComponent", "module": "src/components/dropdown/dropdown-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown-group.ts", "declarations": [ { "kind": "class", "description": "A container for a group of `igc-dropdown-item` components.", "name": "IgcDropdownGroupComponent", "cssParts": [ { "description": "The native label element.", "name": "label" } ], "slots": [ { "description": "Contains the group's label.", "name": "label" }, { "description": "Intended to contain the items belonging to this group.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-dropdown-group'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "items", "type": { "text": "Array" }, "privacy": "public", "description": "All child `igc-dropdown-item`s." } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-dropdown-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDropdownGroupComponent", "module": "src/components/dropdown/dropdown-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown-header.ts", "declarations": [ { "kind": "class", "description": "Represents a header item in a igc-dropdown list.", "name": "IgcDropdownHeaderComponent", "slots": [ { "description": "Renders the header.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-dropdown-header'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-dropdown-header", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDropdownHeaderComponent", "module": "src/components/dropdown/dropdown-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/dropdown/dropdown.ts", "declarations": [ { "kind": "class", "description": "Represents a DropDown component.", "name": "IgcDropdownComponent", "cssParts": [ { "description": "The dropdown list wrapper container.", "name": "base" }, { "description": "The dropdown list element.", "name": "list" } ], "slots": [ { "description": "Renders the dropdown's target element.", "name": "target" }, { "description": "Renders the dropdown list items.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-dropdown'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "_keyBindings", "type": { "text": "KeyBindingController" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_rootScrollController", "privacy": "private" }, { "kind": "field", "name": "_rootClickController", "type": { "text": "RootClickController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "_selectedItem", "type": { "text": "IgcDropdownItemComponent | null" }, "privacy": "protected", "default": "null" }, { "kind": "field", "name": "_activeItem", "type": { "text": "IgcDropdownItemComponent" }, "privacy": "protected" }, { "kind": "field", "name": "_activeItems", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_targetListeners", "type": { "text": "KeyBindingObserverCleanup" }, "privacy": "private" }, { "kind": "field", "name": "_target", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "trigger", "type": { "text": "HTMLSlotElement" }, "privacy": "protected" }, { "kind": "field", "name": "placement", "type": { "text": "PopoverPlacement" }, "privacy": "public", "default": "'bottom-start'", "description": "The preferred placement of the component around the target element.", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "kind": "field", "name": "scrollStrategy", "type": { "text": "PopoverScrollStrategy" }, "privacy": "public", "default": "'scroll'", "description": "Determines the behavior of the component during scrolling of the parent container.", "attribute": "scroll-strategy", "expandedType": { "text": "'scroll' | 'block' | 'close'" } }, { "kind": "field", "name": "flip", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component should be flipped to the opposite side of the target once it's about to overflow the visible area.\nWhen true, once enough space is detected on its preferred side, it will flip back.", "attribute": "flip" }, { "kind": "field", "name": "distance", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The distance from the target element.", "attribute": "distance" }, { "kind": "field", "name": "sameWidth", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the dropdown's width should be the same as the target's one.", "attribute": "same-width" }, { "kind": "field", "name": "items", "privacy": "public", "description": "Returns the items of the dropdown.", "readonly": true }, { "kind": "field", "name": "groups", "privacy": "public", "description": "Returns the group items of the dropdown.", "readonly": true }, { "kind": "field", "name": "selectedItem", "privacy": "public", "description": "Returns the selected item from the dropdown or null.", "readonly": true }, { "kind": "method", "name": "scrollStrategyChanged", "privacy": "protected" }, { "kind": "method", "name": "openStateChange", "privacy": "protected" }, { "kind": "method", "name": "handleListBoxClick", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "handleChange", "privacy": "private", "parameters": [ { "name": "item", "type": { "text": "IgcDropdownItemComponent" } } ] }, { "kind": "method", "name": "handleSlotChange", "privacy": "private" }, { "kind": "method", "name": "onArrowUp", "privacy": "private" }, { "kind": "method", "name": "onArrowDown", "privacy": "private" }, { "kind": "method", "name": "onHomeKey", "privacy": "protected" }, { "kind": "method", "name": "onEndKey", "privacy": "protected" }, { "kind": "method", "name": "onTabKey", "privacy": "protected" }, { "kind": "method", "name": "onEscapeKey", "privacy": "protected" }, { "kind": "method", "name": "onEnterKey", "privacy": "protected" }, { "kind": "method", "name": "handleClosing", "privacy": "protected" }, { "kind": "method", "name": "activateItem", "privacy": "private", "parameters": [ { "name": "item", "type": { "text": "IgcDropdownItemComponent" } } ] }, { "kind": "method", "name": "_navigateToActiveItem", "privacy": "private", "parameters": [ { "name": "item", "optional": true, "type": { "text": "IgcDropdownItemComponent" } } ] }, { "kind": "method", "name": "_selectItem", "privacy": "private", "parameters": [ { "name": "item", "type": { "text": "IgcDropdownItemComponent" } }, { "name": "emit", "default": "true" } ] }, { "kind": "method", "name": "_updateAnchorAccessibility", "privacy": "private", "parameters": [ { "name": "anchor", "optional": true, "type": { "text": "HTMLElement | null" } } ] }, { "kind": "method", "name": "getItem", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "string" } } ] }, { "kind": "method", "name": "_setTarget", "privacy": "private", "parameters": [ { "name": "anchor", "type": { "text": "HTMLElement | string" } } ] }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the component.", "parameters": [ { "name": "target", "optional": true, "type": { "text": "HTMLElement | string" } } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component.", "parameters": [ { "name": "target", "optional": true, "type": { "text": "HTMLElement | string" } } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "IgcDropdownItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ], "description": "Navigates to the item with the specified value. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "IgcDropdownItemComponent | null" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "IgcDropdownItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string | number" } } ], "description": "Navigates to the specified item. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "IgcDropdownItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ], "description": "Selects the item with the specified value. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "IgcDropdownItemComponent | null" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Selects the item at the specified index. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "IgcDropdownItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string | number" } } ], "description": "Selects the specified item. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "clearSelection", "privacy": "public", "description": "Clears the current selection of the dropdown." }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "type": { "text": "<\n K extends keyof IgcBaseComboBoxEventMap,\n D extends UnpackCustomEvent,\n >(\n event: K,\n eventInitDict?: CustomEventInit\n ) => boolean" }, "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnSelect", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "attribute": "keep-open-on-select", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnOutsideClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "attribute": "keep-open-on-outside-click", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the open state of the component.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosing", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosed", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpening", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpened", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "handleAnchorClick", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_hide", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_show", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "events": [ { "description": "Emitted when the selected item changes.", "name": "igcChange" }, { "description": "Emitted just before the dropdown is open.", "name": "igcOpening" }, { "description": "Emitted after the dropdown is open.", "name": "igcOpened" }, { "description": "Emitter just before the dropdown is closed.", "name": "igcClosing" }, { "description": "Emitted after closing the dropdown.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "placement", "type": { "text": "PopoverPlacement" }, "default": "'bottom-start'", "description": "The preferred placement of the component around the target element.", "fieldName": "placement", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "name": "scroll-strategy", "type": { "text": "PopoverScrollStrategy" }, "default": "'scroll'", "description": "Determines the behavior of the component during scrolling of the parent container.", "fieldName": "scrollStrategy", "attribute": "scroll-strategy", "expandedType": { "text": "'scroll' | 'block' | 'close'" } }, { "name": "flip", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component should be flipped to the opposite side of the target once it's about to overflow the visible area.\nWhen true, once enough space is detected on its preferred side, it will flip back.", "fieldName": "flip", "attribute": "flip" }, { "name": "distance", "type": { "text": "number" }, "default": "0", "description": "The distance from the target element.", "fieldName": "distance", "attribute": "distance" }, { "name": "same-width", "type": { "text": "boolean" }, "default": "false", "description": "Whether the dropdown's width should be the same as the target's one.", "fieldName": "sameWidth", "attribute": "same-width" }, { "name": "keep-open-on-select", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "fieldName": "keepOpenOnSelect", "attribute": "keep-open-on-select", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "keep-open-on-outside-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "fieldName": "keepOpenOnOutsideClick", "attribute": "keep-open-on-outside-click", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the component.", "fieldName": "open", "attribute": "open", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcBaseComboBoxLikeComponent", "module": "/src/components/common/mixins/combo-box.js" }, "tagName": "igc-dropdown", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcDropdownComponent", "module": "src/components/dropdown/dropdown.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select-item.ts", "declarations": [ { "kind": "class", "description": "Represents an item in a select list.", "name": "IgcSelectItemComponent", "cssParts": [ { "description": "The prefix wrapper of the igc-select-item.", "name": "prefix" }, { "description": "The main content wrapper of the igc-select-item.", "name": "content" }, { "description": "The suffix wrapper of the igc-select-item.", "name": "suffix" } ], "slots": [ { "description": "Renders the all content bar the prefix and suffix.", "name": "" }, { "description": "Renders content before the main content area.", "name": "prefix" }, { "description": "Renders content after the main content area.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-select-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "active", "privacy": "public", "description": "Whether the item is disabled.", "attribute": "active", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_internals", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_active", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_selected", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected", "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_content", "type": { "text": "Array" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "_contentSlotText", "type": { "text": "string" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "Whether the item is disabled.", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "selected", "privacy": "public", "description": "Whether the item is selected.", "attribute": "selected", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the item.\nIf not specified, the element's text content is used.", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } } ], "attributes": [ { "name": "active", "description": "Whether the item is disabled.", "fieldName": "active", "attribute": "active", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "name": "disabled", "description": "Whether the item is disabled.", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "name": "selected", "description": "Whether the item is selected.", "fieldName": "selected", "attribute": "selected", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } }, { "name": "value", "description": "The current value of the item.\nIf not specified, the element's text content is used.", "fieldName": "value", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcBaseOptionLikeComponent", "module": "src/components/common/mixins/option.ts" } } ], "superclass": { "name": "IgcBaseOptionLikeComponent", "module": "/src/components/common/mixins/option.js" }, "tagName": "igc-select-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSelectItemComponent", "module": "src/components/select/select-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcSelectGroupComponent", "cssParts": [ { "description": "The native label element.", "name": "label" } ], "slots": [ { "description": "Contains the group's label.", "name": "label" }, { "description": "Intended to contain the items belonging to this group.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-select-group'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "controlledItems", "type": { "text": "Array" }, "privacy": "private" }, { "kind": "field", "name": "items", "type": { "text": "Array" }, "privacy": "public", "description": "All child `igc-select-item`s." }, { "kind": "field", "name": "activeItems", "type": { "text": "Array" }, "privacy": "protected" }, { "kind": "method", "name": "_observerCallback", "privacy": "private", "parameters": [ { "name": "{\n changes: { attributes },\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the group item and all its children are disabled.", "attribute": "disabled", "reflects": true }, { "kind": "method", "name": "disabledChange", "privacy": "protected" } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the group item and all its children are disabled.", "fieldName": "disabled", "attribute": "disabled" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-select-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSelectGroupComponent", "module": "src/components/select/select-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select-header.ts", "declarations": [ { "kind": "class", "description": "Represents a header item in an igc-select component.", "name": "IgcSelectHeaderComponent", "slots": [ { "description": "Renders the header.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-select-header'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-select-header", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSelectHeaderComponent", "module": "src/components/select/select-header.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/validators.ts", "declarations": [ { "kind": "variable", "name": "selectValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, ]" } ], "exports": [ { "kind": "js", "name": "selectValidators", "declaration": { "name": "selectValidators", "module": "src/components/select/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/select/select.ts", "declarations": [ { "kind": "class", "description": "Represents a control that provides a menu of options.", "name": "IgcSelectComponent", "cssParts": [ { "description": "The list wrapping container for the items of the igc-select.", "name": "list" }, { "description": "The encapsulated igc-input of the igc-select.", "name": "input" }, { "description": "The encapsulated text label of the igc-select.", "name": "label" }, { "description": "The prefix wrapper of the input of the igc-select.", "name": "prefix" }, { "description": "The suffix wrapper of the input of the igc-select.", "name": "suffix" }, { "description": "The toggle icon wrapper of the igc-select.", "name": "toggle-icon" }, { "description": "The helper text wrapper of the igc-select.", "name": "helper-text" } ], "slots": [ { "description": "Renders the list of select items.", "name": "" }, { "description": "Renders content before the input.", "name": "prefix" }, { "description": "Renders content after input.", "name": "suffix" }, { "description": "Renders a container before the list of options.", "name": "header" }, { "description": "Renders a container after the list of options.", "name": "footer" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content inside the suffix container.", "name": "toggle-icon" }, { "description": "Renders content for the toggle icon when the component is in open state.", "name": "toggle-icon-expanded" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-select'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_searchTerm", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "_lastKeyTime", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_rootScrollController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_rootClickController", "type": { "text": "RootClickController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_selectedItem", "type": { "text": "IgcSelectItemComponent | null" }, "privacy": "protected", "default": "null" }, { "kind": "field", "name": "_activeItem", "type": { "text": "IgcSelectItemComponent" }, "privacy": "protected" }, { "kind": "field", "name": "_input", "type": { "text": "IgcInputComponent" }, "privacy": "protected" }, { "kind": "field", "name": "_activeItems", "type": { "text": "IgcSelectItemComponent[]" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value attribute of the control.", "attribute": "value", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The outlined attribute of the control.", "attribute": "outlined", "reflects": true }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "privacy": "public", "description": "The autofocus attribute of the control.", "attribute": "autofocus" }, { "kind": "field", "name": "distance", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The distance of the select dropdown from its input.", "attribute": "distance" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label attribute of the control.", "attribute": "label" }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder" }, { "kind": "field", "name": "placement", "type": { "text": "PopoverPlacement" }, "privacy": "public", "default": "'bottom-start'", "description": "The preferred placement of the select dropdown around its input.", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "kind": "field", "name": "scrollStrategy", "type": { "text": "PopoverScrollStrategy" }, "privacy": "public", "default": "'scroll'", "description": "Determines the behavior of the component during scrolling of the parent container.", "attribute": "scroll-strategy", "expandedType": { "text": "'scroll' | 'block' | 'close'" } }, { "kind": "field", "name": "items", "type": { "text": "IgcSelectItemComponent[]" }, "privacy": "public", "description": "Returns the items of the igc-select component.", "readonly": true }, { "kind": "field", "name": "groups", "type": { "text": "IgcSelectGroupComponent[]" }, "privacy": "public", "description": "Returns the groups of the igc-select component.", "readonly": true }, { "kind": "field", "name": "selectedItem", "type": { "text": "IgcSelectItemComponent | null" }, "privacy": "public", "description": "Returns the selected item from the dropdown or null.", "readonly": true }, { "kind": "method", "name": "_scrollStrategyChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_openChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleSearch", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_handleEnter", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleSpace", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleArrowDown", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleArrowUp", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleAltArrowDown", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleAltArrowUp", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleEscape", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleTab", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_handleHome", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleEnd", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleFocusIn", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleFocusOut", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ relatedTarget }", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "_handleClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleChange", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "IgcSelectItemComponent" } } ] }, { "kind": "method", "name": "_handleClosing", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleAnchorClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_activateItem", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcSelectItemComponent" } } ] }, { "kind": "method", "name": "_setSelectedItem", "privacy": "private", "return": { "type": { "text": "IgcSelectItemComponent" } }, "parameters": [ { "name": "item", "type": { "text": "IgcSelectItemComponent" } } ] }, { "kind": "method", "name": "_selectItem", "privacy": "private", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "item", "optional": true, "type": { "text": "IgcSelectItemComponent" } }, { "name": "emit", "default": "true" } ] }, { "kind": "method", "name": "_navigateToActiveItem", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "optional": true, "type": { "text": "IgcSelectItemComponent" } } ] }, { "kind": "method", "name": "_updateValue", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "_clearSelectedItem", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_focusItemOnOpen", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_getItem", "privacy": "private", "return": { "type": { "text": "IgcSelectItemComponent | undefined" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ] }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the component." }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the component." }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks the validity of the control and moves the focus to it if it is not valid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ], "description": "Navigates to the item with the specified value. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string | number" } } ], "description": "Navigates to the specified item. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ], "description": "Selects the item with the specified value. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Selects the item at the specified index. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "IgcSelectItemComponent | null" } }, "parameters": [ { "name": "value", "type": { "text": "string | number" } } ], "description": "Selects the specified item. If it exists, returns the found item, otherwise - null." }, { "kind": "method", "name": "clearSelection", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Resets the current value and selection of the component." }, { "kind": "method", "name": "_renderInputSlots", "privacy": "protected" }, { "kind": "method", "name": "_renderToggleIcon", "privacy": "protected" }, { "kind": "method", "name": "_renderHelperText", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderInputAnchor", "privacy": "protected" }, { "kind": "method", "name": "_renderDropdown", "privacy": "protected" }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "type": { "text": "<\n K extends keyof IgcBaseComboBoxEventMap,\n D extends UnpackCustomEvent,\n >(\n event: K,\n eventInitDict?: CustomEventInit\n ) => boolean" }, "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnSelect", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "attribute": "keep-open-on-select", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "keepOpenOnOutsideClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "attribute": "keep-open-on-outside-click", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the open state of the component.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosing", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitClosed", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpening", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "emitOpened", "privacy": "protected", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_hide", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "_show", "privacy": "protected", "parameters": [ { "name": "emitEvent", "default": "false" } ], "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Shows the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Hides the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component.", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "events": [ { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "description": "Emitted just before the list of options is opened.", "name": "igcOpening" }, { "description": "Emitted after the list of options is opened.", "name": "igcOpened" }, { "description": "Emitter just before the list of options is closed.", "name": "igcClosing" }, { "description": "Emitted after the list of options is closed.", "name": "igcClosed" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "value", "description": "The value attribute of the control.", "fieldName": "value", "attribute": "value", "type": { "text": "string | undefined" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "The outlined attribute of the control.", "fieldName": "outlined", "attribute": "outlined" }, { "name": "autofocus", "type": { "text": "boolean" }, "description": "The autofocus attribute of the control.", "fieldName": "autofocus", "attribute": "autofocus" }, { "name": "distance", "type": { "text": "number" }, "default": "0", "description": "The distance of the select dropdown from its input.", "fieldName": "distance", "attribute": "distance" }, { "name": "label", "type": { "text": "string" }, "description": "The label attribute of the control.", "fieldName": "label", "attribute": "label" }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder" }, { "name": "placement", "type": { "text": "PopoverPlacement" }, "default": "'bottom-start'", "description": "The preferred placement of the select dropdown around its input.", "fieldName": "placement", "attribute": "placement", "expandedType": { "text": "'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'" } }, { "name": "scroll-strategy", "type": { "text": "PopoverScrollStrategy" }, "default": "'scroll'", "description": "Determines the behavior of the component during scrolling of the parent container.", "fieldName": "scrollStrategy", "attribute": "scroll-strategy", "expandedType": { "text": "'scroll' | 'block' | 'close'" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "keep-open-on-select", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on selection.", "fieldName": "keepOpenOnSelect", "attribute": "keep-open-on-select", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "keep-open-on-outside-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component dropdown should be kept open on clicking outside of it.", "fieldName": "keepOpenOnOutsideClick", "attribute": "keep-open-on-outside-click", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Sets the open state of the component.", "fieldName": "open", "attribute": "open", "inheritedFrom": { "name": "IgcBaseComboBoxLikeComponent", "module": "src/components/common/mixins/combo-box.ts" } } ], "mixins": [ { "name": "FormAssociatedRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcBaseComboBoxLikeComponent", "module": "/src/components/common/mixins/combo-box.js" }, "tagName": "igc-select", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSelectComponent", "module": "src/components/select/select.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/progress/linear-progress.ts", "declarations": [ { "kind": "class", "description": "A linear progress indicator used to express unspecified wait time or display\nthe length of a process.", "name": "IgcLinearProgressComponent", "cssParts": [ { "description": "The igc-linear-progress track area.", "name": "track" }, { "description": "The igc-linear-progress indicator area.", "name": "fill" }, { "description": "The igc-linear-progress striped indicator.", "name": "striped" }, { "description": "The igc-linear-progress label.", "name": "label" }, { "description": "The igc-linear-progress label value.", "name": "value" }, { "description": "The igc-linear-progress indeterminate state.", "name": "indeterminate" }, { "description": "The igc-linear-progress indicator primary state.", "name": "primary" }, { "description": "The igc-linear-progress indicator error state.", "name": "danger" }, { "description": "The igc-linear-progress indicator warning state.", "name": "warning" }, { "description": "The igc-linear-progress indicator info state.", "name": "info" }, { "description": "The igc-linear-progress indicator success state.", "name": "success" } ], "slots": [ { "description": "The text area container.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-linear-progress'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "striped", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets the striped look of the control.", "attribute": "striped", "reflects": true }, { "kind": "field", "name": "labelAlign", "type": { "text": "LinearProgressLabelAlign" }, "privacy": "public", "default": "'top-start'", "description": "The position for the default label of the control.", "attribute": "label-align", "reflects": true, "expandedType": { "text": "'top-start' | 'top' | 'top-end' | 'bottom-start' | 'bottom' | 'bottom-end'" } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_base", "type": { "text": "HTMLElement" }, "privacy": "protected", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_percentage", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_progress", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_hasFraction", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "_styleInfo", "type": { "text": "StyleInfo" }, "privacy": "protected", "default": "{ '--_progress-whole': '0.00', '--_progress-integer': '0', '--_progress-fraction': '0', '--_transition-duration': '0ms', }", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "max", "type": { "text": "number" }, "privacy": "public", "default": "100", "description": "Maximum value of the control.", "attribute": "max", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "value", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The value of the control.", "attribute": "value", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "variant", "type": { "text": "StyleVariant" }, "privacy": "public", "default": "'primary'", "description": "The variant of the control.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "animationDuration", "type": { "text": "number" }, "privacy": "public", "default": "500", "description": "Animation duration in milliseconds.", "attribute": "animation-duration", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The indeterminate state of the control.", "attribute": "indeterminate", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "hideLabel", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Shows/hides the label of the control.", "attribute": "hide-label", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "field", "name": "labelFormat", "type": { "text": "string" }, "privacy": "public", "description": "Format string for the default label of the control.\nPlaceholders:\n {0} - current value of the control.\n {1} - max value of the control.", "attribute": "label-format", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_indeterminateChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_maxChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_valueChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_updateARIA", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_updateProgress", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "protected", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderLabelFormat", "privacy": "protected", "return": { "type": { "text": "string" } }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "kind": "method", "name": "_renderDefaultSlot", "privacy": "protected", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } } ], "attributes": [ { "name": "striped", "type": { "text": "boolean" }, "default": "false", "description": "Sets the striped look of the control.", "fieldName": "striped", "attribute": "striped" }, { "name": "label-align", "type": { "text": "LinearProgressLabelAlign" }, "default": "'top-start'", "description": "The position for the default label of the control.", "fieldName": "labelAlign", "attribute": "label-align", "expandedType": { "text": "'top-start' | 'top' | 'top-end' | 'bottom-start' | 'bottom' | 'bottom-end'" } }, { "name": "max", "type": { "text": "number" }, "default": "100", "description": "Maximum value of the control.", "fieldName": "max", "attribute": "max", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "value", "type": { "text": "number" }, "default": "0", "description": "The value of the control.", "fieldName": "value", "attribute": "value", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "variant", "type": { "text": "StyleVariant" }, "default": "'primary'", "description": "The variant of the control.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'primary' | 'info' | 'success' | 'warning' | 'danger'" }, "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "animation-duration", "type": { "text": "number" }, "default": "500", "description": "Animation duration in milliseconds.", "fieldName": "animationDuration", "attribute": "animation-duration", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "indeterminate", "type": { "text": "boolean" }, "default": "false", "description": "The indeterminate state of the control.", "fieldName": "indeterminate", "attribute": "indeterminate", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "hide-label", "type": { "text": "boolean" }, "default": "false", "description": "Shows/hides the label of the control.", "fieldName": "hideLabel", "attribute": "hide-label", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } }, { "name": "label-format", "type": { "text": "string" }, "description": "Format string for the default label of the control.\nPlaceholders:\n {0} - current value of the control.\n {1} - max value of the control.", "fieldName": "labelFormat", "attribute": "label-format", "inheritedFrom": { "name": "IgcProgressBaseComponent", "module": "src/components/progress/base.ts" } } ], "superclass": { "name": "IgcProgressBaseComponent", "module": "/src/components/progress/base.js" }, "tagName": "igc-linear-progress", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcLinearProgressComponent", "module": "src/components/progress/linear-progress.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask-input/validators.ts", "declarations": [ { "kind": "variable", "name": "maskValidators", "type": { "text": "Validator[]" }, "default": "[ requiredValidator, { key: 'badInput', message: ValidationResourceStringsEN.mask_validation_error!, isValid: (host) => host.isValidMaskPattern(), }, ]" } ], "exports": [ { "kind": "js", "name": "maskValidators", "declaration": { "name": "maskValidators", "module": "src/components/mask-input/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/mask-input/mask-input.ts", "declarations": [ { "kind": "class", "description": "A masked input is an input field where a developer can control user input and format the visible value,\nbased on configurable rules", "name": "IgcMaskInputComponent", "cssParts": [ { "description": "The main wrapper that holds all main input elements", "name": "container" }, { "description": "The native input element", "name": "input" }, { "description": "The native label element", "name": "label" }, { "description": "The prefix wrapper", "name": "prefix" }, { "description": "The suffix wrapper", "name": "suffix" }, { "description": "The helper text wrapper", "name": "helper-text" } ], "slots": [ { "description": "Renders content before the input", "name": "prefix" }, { "description": "Renders content after the input", "name": "suffix" }, { "description": "Renders content below the input", "name": "helper-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when a required mask pattern validation fails.", "name": "bad-input" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-mask-input'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_themes", "type": { "text": "ThemingController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_slots", "type": { "text": "SlotController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isRawMode", "type": { "text": "boolean" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "valueMode", "type": { "text": "MaskInputValueMode" }, "privacy": "public", "default": "'raw'", "description": "Dictates the behavior when retrieving the value of the control:\n\n- `raw`: Returns clean input (e.g. \"5551234567\")\n- `withFormatting`: Returns with mask formatting (e.g. \"(555) 123-4567\")\n\nEmpty values always return an empty string, regardless of the value mode.", "attribute": "value-mode", "expandedType": { "text": "'raw' | 'withFormatting'" } }, { "kind": "field", "name": "value", "type": { "text": "string | Date | null" }, "privacy": "public", "description": "The value of the input.\n\nRegardless of the currently set `value-mode`, an empty value will return an empty string.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" }, "attribute": "value" }, { "kind": "field", "name": "mask", "privacy": "public", "description": "The masked pattern of the component.", "default": "'CCCCCCCCCC'", "attribute": "mask", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "prompt", "privacy": "public", "description": "The prompt symbol to use for unfilled parts of the mask pattern.", "default": "'_'", "attribute": "prompt", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleDragEnter", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleDragLeave", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleFocus", "privacy": "protected", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_updateInput", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "text", "type": { "text": "string" } }, { "name": "{ start, end }", "type": { "text": "MaskSelection" } } ], "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_updateSetRangeTextValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_updateMaskedValue", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "isValidMaskPattern", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Returns whether the current masked input is valid according to the mask pattern." }, { "kind": "method", "name": "_renderInput", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_parser", "privacy": "protected", "readonly": true, "default": "new MaskParser()", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_maskSelection", "type": { "text": "MaskSelection" }, "privacy": "protected", "default": "{ start: 0, end: 0 }", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_compositionStart", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_focused", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_maskedValue", "type": { "text": "string" }, "privacy": "protected", "default": "''", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_inputSelection", "type": { "text": "MaskSelection" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_isEmptyMask", "type": { "text": "boolean" }, "privacy": "protected", "description": "Indicates whether the current mask value is empty.", "readonly": true, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readOnly", "reflects": true, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleInput", "privacy": "protected", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "{\n inputType,\n isComposing,\n }", "type": { "text": "InputEvent" } } ], "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_setMaskSelection", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleCompositionStart", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleCompositionEnd", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{ data }", "type": { "text": "CompositionEvent" } } ], "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "setSelectionRange", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "direction", "default": "'none'", "type": { "text": "SelectionRangeDirection" } } ], "description": "Sets the text selection range of the control", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "method", "name": "setRangeText", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "replacement", "type": { "text": "string" } }, { "name": "start", "optional": true, "type": { "text": "number" } }, { "name": "end", "optional": true, "type": { "text": "number" } }, { "name": "selectMode", "optional": true, "type": { "text": "RangeTextSelectMode" } } ], "description": "Replaces the selected text in the control and re-applies the mask", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "protected", "readonly": true, "default": "`input-${nextId++}`", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "outlined", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the control will have outlined appearance.", "attribute": "outlined", "reflects": true, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "description": "The placeholder attribute of the control.", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label for the control.", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_resolvePartNames", "privacy": "protected", "parameters": [ { "name": "base", "type": { "text": "string" } } ], "description": "Resolves the part names for the container based on the current state.\nUsed to apply conditional styling via CSS parts.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Selects all the text inside the input.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderFileParts", "privacy": "protected", "return": { "type": { "text": "TemplateResult | typeof nothing" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderPrefix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderSuffix", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderLabel", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderMaterial", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "kind": "method", "name": "_renderStandard", "privacy": "private", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "events": [ { "description": "Emitted when the control receives user input", "name": "igcInput" }, { "description": "Emitted when an alteration of the control's value is committed by the user", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "attributes": [ { "name": "value-mode", "type": { "text": "MaskInputValueMode" }, "default": "'raw'", "description": "Dictates the behavior when retrieving the value of the control:\n\n- `raw`: Returns clean input (e.g. \"5551234567\")\n- `withFormatting`: Returns with mask formatting (e.g. \"(555) 123-4567\")\n\nEmpty values always return an empty string, regardless of the value mode.", "fieldName": "valueMode", "attribute": "value-mode", "expandedType": { "text": "'raw' | 'withFormatting'" } }, { "name": "value", "description": "The value of the input.\n\nRegardless of the currently set `value-mode`, an empty value will return an empty string.", "fieldName": "value", "attribute": "value", "type": { "text": "string" } }, { "name": "mask", "description": "The masked pattern of the component.", "default": "'CCCCCCCCCC'", "fieldName": "mask", "attribute": "mask", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "prompt", "description": "The prompt symbol to use for unfilled parts of the mask pattern.", "default": "'_'", "fieldName": "prompt", "attribute": "prompt", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "fieldName": "readOnly", "inheritedFrom": { "name": "IgcMaskInputBaseComponent", "module": "src/components/mask-input/mask-input-base.ts" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "outlined", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control will have outlined appearance.", "fieldName": "outlined", "attribute": "outlined", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "placeholder", "type": { "text": "string" }, "description": "The placeholder attribute of the control.", "fieldName": "placeholder", "attribute": "placeholder", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } }, { "name": "label", "type": { "text": "string" }, "description": "The label for the control.", "fieldName": "label", "attribute": "label", "inheritedFrom": { "name": "IgcInputBaseComponent", "module": "src/components/input/input-base.ts" } } ], "superclass": { "name": "IgcMaskInputBaseComponent", "module": "/src/components/mask-input/mask-input-base.js" }, "tagName": "igc-mask-input", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcMaskInputComponent", "module": "src/components/mask-input/mask-input.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/nav-drawer/nav-drawer-header-item.ts", "declarations": [ { "kind": "class", "description": "A wrapper for navigation drawer's header.", "name": "IgcNavDrawerHeaderItemComponent", "slots": [ { "description": "Renders the header content", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-nav-drawer-header-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-nav-drawer-header-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcNavDrawerHeaderItemComponent", "module": "src/components/nav-drawer/nav-drawer-header-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/nav-drawer/nav-drawer-item.ts", "declarations": [ { "kind": "class", "description": "Represents a navigation drawer item.", "name": "IgcNavDrawerItemComponent", "cssParts": [ { "description": "The base wrapper of the drawer item.", "name": "base" }, { "description": "The icon container.", "name": "icon" }, { "description": "The content container.", "name": "content" } ], "slots": [ { "description": "The content slot for the drawer item.", "name": "content" }, { "description": "The slot for the icon of the drawer item.", "name": "icon" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-nav-drawer-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hasContent", "type": { "text": "boolean" }, "privacy": "private", "default": "true" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the drawer is disabled.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the drawer is active.", "attribute": "active", "reflects": true }, { "kind": "method", "name": "_handleSlotChange", "privacy": "protected", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the drawer is disabled.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the drawer is active.", "fieldName": "active", "attribute": "active" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-nav-drawer-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcNavDrawerItemComponent", "module": "src/components/nav-drawer/nav-drawer-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/nav-drawer/nav-drawer.ts", "declarations": [ { "kind": "class", "description": "Represents a side navigation container that provides\nquick access between views.", "name": "IgcNavDrawerComponent", "cssParts": [ { "description": "The base wrapper of the igc-navigation-drawer.", "name": "base" }, { "description": "The main container of the igc-navigation-drawer.", "name": "main" }, { "description": "The mini container of the igc-navigation-drawer.", "name": "mini" } ], "slots": [ { "description": "The default slot for the igc-navigation-drawer.", "name": "" }, { "description": "The slot for the mini variant of the igc-navigation-drawer.", "name": "mini" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-nav-drawer'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "position", "type": { "text": "NavDrawerPosition" }, "privacy": "public", "default": "'start'", "description": "The position of the drawer.", "attribute": "position", "reflects": true, "expandedType": { "text": "'start' | 'end' | 'top' | 'bottom' | 'relative'" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the drawer is opened.", "attribute": "open", "reflects": true }, { "kind": "method", "name": "_waitTransitions", "privacy": "private" }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Opens the drawer." }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Closes the drawer." }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the drawer." } ], "attributes": [ { "name": "position", "type": { "text": "NavDrawerPosition" }, "default": "'start'", "description": "The position of the drawer.", "fieldName": "position", "attribute": "position", "expandedType": { "text": "'start' | 'end' | 'top' | 'bottom' | 'relative'" } }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the drawer is opened.", "fieldName": "open", "attribute": "open" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-nav-drawer", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcNavDrawerComponent", "module": "src/components/nav-drawer/nav-drawer.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/navbar/navbar.ts", "declarations": [ { "kind": "class", "description": "A navigation bar component is used to facilitate navigation through\na series of hierarchical screens within an app.", "name": "IgcNavbarComponent", "cssParts": [ { "description": "The base wrapper of the navigation bar.", "name": "base" }, { "description": "The left aligned icon container.", "name": "start" }, { "description": "The navigation bar title container.", "name": "middle" }, { "description": "The right aligned action icons container.", "name": "end" } ], "slots": [ { "description": "Renders a title inside the default slot.", "name": "" }, { "description": "Renders left aligned icons.", "name": "start" }, { "description": "Renders right aligned action icons.", "name": "end" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-navbar'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-navbar", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcNavbarComponent", "module": "src/components/navbar/navbar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/utils.ts", "declarations": [ { "kind": "function", "name": "getGroup", "parameters": [ { "name": "member", "type": { "text": "IgcRadioComponent" } } ] } ], "exports": [ { "kind": "js", "name": "getGroup", "declaration": { "name": "getGroup", "module": "src/components/radio/utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/validators.ts", "declarations": [ { "kind": "variable", "name": "radioValidators", "type": { "text": "Validator[]" }, "default": "[ { key: 'valueMissing', message: ValidationResourceStringsEN.required_validation_error!, isValid: (host) => { const { radios, checked } = getGroup(host); return radios.some((radio) => radio.required) ? checked.length > 0 : true; }, }, ]" } ], "exports": [ { "kind": "js", "name": "radioValidators", "declaration": { "name": "radioValidators", "module": "src/components/radio/validators.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio/radio.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcRadioComponent", "cssParts": [ { "description": "The radio control base wrapper.", "name": "base" }, { "description": "The radio input control.", "name": "control" }, { "description": "The radio control label.", "name": "label" } ], "slots": [ { "description": "The radio label.", "name": "" }, { "description": "Renders content below the input.", "name": "helper-text" }, { "description": "Renders content when the required validation fails.", "name": "value-missing" }, { "description": "Renders content when setCustomValidity(message) is set.", "name": "custom-error" }, { "description": "Renders content when the component is in invalid state (validity.valid = false).", "name": "invalid" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-radio'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_inputId", "privacy": "private", "readonly": true, "default": "`radio-${nextId++}`" }, { "kind": "field", "name": "_labelId", "privacy": "private", "readonly": true, "default": "`radio-label-${this._inputId}`" }, { "kind": "field", "name": "_focusRingManager", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected" }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_hideLabel", "type": { "text": "boolean" }, "privacy": "protected", "default": "true" }, { "kind": "field", "name": "_tabIndex", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_radios", "privacy": "private", "description": "Returns all radio elements from the group, that is having the same name property.", "readonly": true }, { "kind": "field", "name": "_siblings", "privacy": "private", "description": "All sibling radio elements of the one invoking the getter.", "readonly": true }, { "kind": "field", "name": "_active", "privacy": "private", "description": "All non-disabled radio elements from the group.", "readonly": true }, { "kind": "field", "name": "_checkedRadios", "privacy": "private", "description": "All checked radio elements from the group.", "readonly": true }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value attribute of the control.", "attribute": "value", "type": { "text": "string" } }, { "kind": "field", "name": "checked", "privacy": "public", "description": "The checked state of the control.", "attribute": "checked", "type": { "text": "boolean" } }, { "kind": "field", "name": "labelPosition", "type": { "text": "ToggleLabelPosition" }, "privacy": "public", "default": "'after'", "description": "The label position of the radio control.", "attribute": "label-position", "reflects": true, "expandedType": { "text": "'after' | 'before'" } }, { "kind": "method", "name": "_handleSlotChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a click on the radio control." }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the radio control." }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the radio control." }, { "kind": "method", "name": "_checkValidity", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_reportValidity", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_updateCheckedState", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_resetTabIndexes", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Called after a form reset callback to restore default keyboard navigation." }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_navigate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "idx", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_renderValidatorContainer", "privacy": "protected", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "kind": "field", "name": "defaultChecked", "privacy": "public", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedCheckboxMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "value", "description": "The value attribute of the control.", "fieldName": "value", "attribute": "value", "type": { "text": "string" } }, { "name": "checked", "description": "The checked state of the control.", "fieldName": "checked", "attribute": "checked", "type": { "text": "boolean" } }, { "name": "label-position", "type": { "text": "ToggleLabelPosition" }, "default": "'after'", "description": "The label position of the radio control.", "fieldName": "labelPosition", "attribute": "label-position", "expandedType": { "text": "'after' | 'before'" } }, { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "FormAssociatedCheckboxRequiredMixin", "module": "src/components/common/mixins/forms/associated-required.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedCheckboxRequiredMixin", "module": "/src/components/common/mixins/forms/associated-required.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-radio", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcRadioComponent", "module": "src/components/radio/radio.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/radio-group/radio-group.ts", "declarations": [ { "kind": "class", "description": "The igc-radio-group component unifies one or more igc-radio buttons.", "name": "IgcRadioGroupComponent", "slots": [ { "description": "Default slot", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-radio-group'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_radios", "type": { "text": "IgcRadioComponent[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_defaultValue", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "_name", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "private" }, { "kind": "field", "name": "alignment", "type": { "text": "ContentOrientation" }, "privacy": "public", "default": "'vertical'", "description": "Alignment of the radio controls inside this group.", "attribute": "alignment", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "string" } }, { "kind": "field", "name": "name", "privacy": "public", "description": "Gets/Sets the name for all child igc-radio components.", "attribute": "name", "type": { "text": "string" }, "reflects": true }, { "kind": "field", "name": "value", "privacy": "public", "description": "Gets/Sets the checked igc-radio element that matches `value`", "attribute": "value", "type": { "text": "string" } }, { "kind": "method", "name": "_observerCallback", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setRadiosDefaultChecked", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setRadiosName", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setSelectedRadio", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "alignment", "type": { "text": "ContentOrientation" }, "default": "'vertical'", "description": "Alignment of the radio controls inside this group.", "fieldName": "alignment", "attribute": "alignment", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "name", "description": "Gets/Sets the name for all child igc-radio components.", "fieldName": "name", "attribute": "name", "type": { "text": "string" } }, { "name": "value", "description": "Gets/Sets the checked igc-radio element that matches `value`", "fieldName": "value", "attribute": "value", "type": { "text": "string" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-radio-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcRadioGroupComponent", "module": "src/components/radio-group/radio-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/rating/rating-symbol.ts", "declarations": [ { "kind": "class", "description": "\nUsed when a custom icon/symbol/element needs to be passed to the igc-rating component.", "name": "IgcRatingSymbolComponent", "cssParts": [ { "description": "The symbol wrapping container.", "name": "symbol" }, { "description": "The full symbol wrapping container.", "name": "full" }, { "description": "The empty symbol wrapping container.", "name": "empty" } ], "slots": [ { "description": "Default slot for projected full symbols/icons.", "name": "" }, { "description": "Default slot for projected empty symbols/icons.", "name": "empty" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-rating-symbol'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-rating-symbol", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcRatingSymbolComponent", "module": "src/components/rating/rating-symbol.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/rating/rating.ts", "declarations": [ { "kind": "class", "description": "Rating provides insight regarding others' opinions and experiences,\nand can allow the user to submit a rating of their own", "name": "IgcRatingComponent", "cssProperties": [ { "description": "The size of the symbols.", "name": "--symbol-size" }, { "description": "The color of the filled symbol.", "name": "--symbol-full-color" }, { "description": "The color of the empty symbol.", "name": "--symbol-empty-color" }, { "description": "The filter(s) used for the filled symbol.", "name": "--symbol-full-filter" }, { "description": "The filter(s) used for the empty symbol.", "name": "--symbol-empty-filter" } ], "cssParts": [ { "description": "The main wrapper which holds all of the rating elements.", "name": "base" }, { "description": "The label part.", "name": "label" }, { "description": "The value label part.", "name": "value-label" }, { "description": "A wrapper for all rating symbols.", "name": "symbols" }, { "description": "The part of the encapsulated default symbol.", "name": "symbol" }, { "description": "The part of the encapsulated full symbols.", "name": "full" }, { "description": "The part of the encapsulated empty symbols.", "name": "empty" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-rating'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_max", "type": { "text": "number" }, "privacy": "private", "default": "5" }, { "kind": "field", "name": "_step", "type": { "text": "number" }, "privacy": "private", "default": "1" }, { "kind": "field", "name": "_single", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "ratingSymbols", "type": { "text": "IgcRatingSymbolComponent[]" }, "privacy": "protected" }, { "kind": "field", "name": "container", "type": { "text": "HTMLElement" }, "privacy": "protected" }, { "kind": "field", "name": "valueLabel", "type": { "text": "Node[]" }, "privacy": "protected" }, { "kind": "field", "name": "hoverValue", "type": { "text": "number" }, "privacy": "protected", "default": "-1" }, { "kind": "field", "name": "hoverState", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "isInteractive", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "hasProjectedSymbols", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "valueText", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value for the rating.\n\nIf there are projected symbols, the maximum value will be resolved\nbased on the number of symbols.", "default": "5", "attribute": "max", "type": { "text": "number" } }, { "kind": "field", "name": "step", "privacy": "public", "description": "The minimum value change allowed.\n\nValid values are in the interval between 0 and 1 inclusive.", "default": "1", "attribute": "step", "type": { "text": "number" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "description": "The label of the control.", "attribute": "label" }, { "kind": "field", "name": "valueFormat", "type": { "text": "string" }, "privacy": "public", "description": "A format string which sets aria-valuetext. Instances of '{0}' will be replaced\nwith the current value of the control and instances of '{1}' with the maximum value for the control.\n\nImportant for screen-readers and useful for localization.", "attribute": "value-format" }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the component", "default": "0", "attribute": "value", "type": { "text": "number" } }, { "kind": "field", "name": "hoverPreview", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Sets hover preview behavior for the component", "attribute": "hover-preview", "reflects": true }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Makes the control a readonly field.", "attribute": "readonly", "reflects": true }, { "kind": "field", "name": "single", "privacy": "public", "description": "Toggles single selection visual mode.", "default": "false", "attribute": "single", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "allowReset", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to reset the rating when the user selects the same value.", "attribute": "allow-reset", "reflects": true }, { "kind": "method", "name": "handleClick", "privacy": "protected", "parameters": [ { "name": "{ clientX }", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "handlePointerMove", "privacy": "protected", "parameters": [ { "name": "{ clientX }", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "emitValueUpdate", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "handleSlotChange", "privacy": "protected" }, { "kind": "method", "name": "handleHoverEnabled", "privacy": "protected" }, { "kind": "method", "name": "handleHoverDisabled", "privacy": "protected" }, { "kind": "method", "name": "calcNewValue", "privacy": "protected", "parameters": [ { "name": "x", "type": { "text": "number" } } ] }, { "kind": "method", "name": "round", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "clipSymbol", "privacy": "protected", "parameters": [ { "name": "index", "type": { "text": "number" } }, { "name": "isLTR", "default": "true" } ] }, { "kind": "method", "name": "stepUp", "privacy": "public", "parameters": [ { "name": "n", "default": "1" } ], "description": "Increments the value of the control by `n` steps multiplied by the\nstep factor." }, { "kind": "method", "name": "stepDown", "privacy": "public", "parameters": [ { "name": "n", "default": "1" } ], "description": "Decrements the value of the control by `n` steps multiplied by\nthe step factor." }, { "kind": "method", "name": "renderSymbols", "privacy": "protected" }, { "kind": "method", "name": "clipProjected", "privacy": "protected" }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the value of the control changes.", "name": "igcChange" }, { "description": "Emitted when hover is enabled and the user mouses over a symbol of the rating.", "name": "igcHover" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "max", "description": "The maximum value for the rating.\n\nIf there are projected symbols, the maximum value will be resolved\nbased on the number of symbols.", "default": "5", "fieldName": "max", "attribute": "max", "type": { "text": "number" } }, { "name": "step", "description": "The minimum value change allowed.\n\nValid values are in the interval between 0 and 1 inclusive.", "default": "1", "fieldName": "step", "attribute": "step", "type": { "text": "number" } }, { "name": "label", "type": { "text": "string" }, "description": "The label of the control.", "fieldName": "label", "attribute": "label" }, { "name": "value-format", "type": { "text": "string" }, "description": "A format string which sets aria-valuetext. Instances of '{0}' will be replaced\nwith the current value of the control and instances of '{1}' with the maximum value for the control.\n\nImportant for screen-readers and useful for localization.", "fieldName": "valueFormat", "attribute": "value-format" }, { "name": "value", "description": "The current value of the component", "default": "0", "fieldName": "value", "attribute": "value", "type": { "text": "number" } }, { "name": "hover-preview", "type": { "text": "boolean" }, "default": "false", "description": "Sets hover preview behavior for the component", "fieldName": "hoverPreview", "attribute": "hover-preview" }, { "name": "readonly", "type": { "text": "boolean" }, "default": "false", "description": "Makes the control a readonly field.", "fieldName": "readOnly", "attribute": "readonly" }, { "name": "single", "description": "Toggles single selection visual mode.", "default": "false", "fieldName": "single", "attribute": "single", "type": { "text": "boolean" } }, { "name": "allow-reset", "type": { "text": "boolean" }, "default": "false", "description": "Whether to reset the rating when the user selects the same value.", "fieldName": "allowReset", "attribute": "allow-reset" }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } } ], "mixins": [ { "name": "FormAssociatedMixin", "module": "/src/components/common/mixins/forms/associated.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-rating", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcRatingComponent", "module": "src/components/rating/rating.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/ripple/ripple.ts", "declarations": [ { "kind": "class", "description": "A ripple can be applied to an element to represent\ninteractive surface.", "name": "IgcRippleComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-ripple'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handler", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_getDimensions", "privacy": "private", "parameters": [ { "name": "x", "type": { "text": "number" } }, { "name": "y", "type": { "text": "number" } } ] } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-ripple", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcRippleComponent", "module": "src/components/ripple/ripple.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider/slider-base.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcSliderBaseComponent", "members": [ { "kind": "field", "name": "thumb", "type": { "text": "HTMLElement" }, "privacy": "protected" }, { "kind": "field", "name": "base", "type": { "text": "HTMLDivElement" }, "privacy": "protected" }, { "kind": "field", "name": "labelElements", "type": { "text": "HTMLElement[]" }, "privacy": "private" }, { "kind": "field", "name": "_min", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_max", "type": { "text": "number" }, "privacy": "private", "default": "100" }, { "kind": "field", "name": "_lowerBound", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_upperBound", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_step", "type": { "text": "number" }, "privacy": "private", "default": "1" }, { "kind": "field", "name": "startValue", "type": { "text": "number | undefined" }, "privacy": "private" }, { "kind": "field", "name": "pointerCaptured", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "thumbHoverTimer", "type": { "text": "any" }, "privacy": "private" }, { "kind": "field", "name": "activeThumb", "type": { "text": "HTMLElement | undefined" }, "privacy": "protected" }, { "kind": "field", "name": "thumbLabelsVisible", "type": { "text": "boolean" }, "privacy": "protected", "default": "false" }, { "kind": "field", "name": "labels", "type": { "text": "string[]" }, "privacy": "protected", "default": "[]" }, { "kind": "field", "name": "hasLabels", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "distance", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum value of the slider scale. Defaults to 0.\n\nIf `min` is greater than `max` the call is a no-op.\n\nIf `labels` are provided (projected), then `min` is always set to 0.\n\nIf `lowerBound` ends up being less than than the current `min` value,\nit is automatically assigned the new `min` value.", "attribute": "min", "type": { "text": "number" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value of the slider scale. Defaults to 100.\n\nIf `max` is less than `min` the call is a no-op.\n\nIf `labels` are provided (projected), then `max` is always set to\nthe number of labels.\n\nIf `upperBound` ends up being greater than than the current `max` value,\nit is automatically assigned the new `max` value.", "attribute": "max", "type": { "text": "number" } }, { "kind": "field", "name": "lowerBound", "privacy": "public", "description": "The lower bound of the slider value. If not set, the `min` value is applied.", "attribute": "lower-bound", "type": { "text": "number" } }, { "kind": "field", "name": "upperBound", "privacy": "public", "description": "The upper bound of the slider value. If not set, the `max` value is applied.", "attribute": "upper-bound", "type": { "text": "number" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Disables the UI interactions of the slider.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "discreteTrack", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Marks the slider track as discrete so it displays the steps.\nIf the `step` is 0, the slider will remain continuos even if `discreteTrack` is `true`.", "attribute": "discrete-track" }, { "kind": "field", "name": "hideTooltip", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the thumb tooltip.", "attribute": "hide-tooltip" }, { "kind": "field", "name": "step", "privacy": "public", "description": "Specifies the granularity that the value must adhere to.\n\nIf set to 0 no stepping is implied and any value in the range is allowed.\nIf `labels` are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.", "attribute": "step", "type": { "text": "number" } }, { "kind": "field", "name": "primaryTicks", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.", "attribute": "primary-ticks" }, { "kind": "field", "name": "secondaryTicks", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.", "attribute": "secondary-ticks" }, { "kind": "field", "name": "tickOrientation", "type": { "text": "SliderTickOrientation" }, "privacy": "public", "default": "'end'", "description": "Changes the orientation of the ticks.", "attribute": "tick-orientation", "expandedType": { "text": "'end' | 'mirror' | 'start'" } }, { "kind": "field", "name": "hidePrimaryLabels", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the primary tick labels.", "attribute": "hide-primary-labels" }, { "kind": "field", "name": "hideSecondaryLabels", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the secondary tick labels.", "attribute": "hide-secondary-labels" }, { "kind": "field", "name": "locale", "type": { "text": "string" }, "privacy": "public", "default": "'en'", "description": "The locale used to format the thumb and tick label values in the slider.", "attribute": "locale" }, { "kind": "field", "name": "valueFormat", "type": { "text": "string | undefined" }, "privacy": "public", "description": "String format used for the thumb and tick label values in the slider.", "attribute": "value-format" }, { "kind": "field", "name": "valueFormatOptions", "type": { "text": "Intl.NumberFormatOptions | undefined" }, "privacy": "public", "description": "Number format options used for the thumb and tick label values in the slider." }, { "kind": "field", "name": "tickLabelRotation", "type": { "text": "SliderTickLabelRotation" }, "privacy": "public", "default": "0", "description": "The degrees for the rotation of the tick labels. Defaults to 0.", "attribute": "tick-label-rotation", "reflects": true, "expandedType": { "text": "'0' | '90' | " } }, { "kind": "method", "name": "constraintsChange", "privacy": "protected" }, { "kind": "method", "name": "handleArrowKeys", "privacy": "private", "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "handlePageKeys", "privacy": "private", "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "handleKeyboardIncrement", "privacy": "private", "parameters": [ { "name": "increment", "type": { "text": "number" } } ] }, { "kind": "method", "name": "handleKeyUp", "privacy": "private" }, { "kind": "method", "name": "handleSlotChange", "privacy": "protected" }, { "kind": "field", "name": "activeValue", "privacy": "protected", "readonly": true }, { "kind": "method", "name": "normalizeValue", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getTrackStyle", "privacy": "protected", "return": { "type": { "text": "StyleInfo" } } }, { "kind": "method", "name": "updateValue", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "_increment", "type": { "text": "number" } } ] }, { "kind": "method", "name": "renderThumbs", "privacy": "protected", "return": { "type": { "text": "TemplateResult<1>" } } }, { "kind": "method", "name": "emitInputEvent", "privacy": "protected" }, { "kind": "method", "name": "emitChangeEvent", "privacy": "protected" }, { "kind": "method", "name": "validateValue", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "formatValue", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "normalizeByStep", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ] }, { "kind": "method", "name": "closestHandle", "privacy": "protected", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "_event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "totalTickCount", "privacy": "private" }, { "kind": "method", "name": "tickValue", "privacy": "private", "parameters": [ { "name": "idx", "type": { "text": "number" } } ] }, { "kind": "method", "name": "isPrimary", "privacy": "private", "parameters": [ { "name": "idx", "type": { "text": "number" } } ] }, { "kind": "method", "name": "showThumbLabels", "privacy": "protected" }, { "kind": "method", "name": "hideThumbLabels", "privacy": "protected" }, { "kind": "method", "name": "calculateTrackUpdate", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "mouseX", "type": { "text": "number" } } ] }, { "kind": "method", "name": "updateSlider", "privacy": "private", "parameters": [ { "name": "mouseX", "type": { "text": "number" } } ] }, { "kind": "method", "name": "pointerDown", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "pointerMove", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "lostPointerCapture", "privacy": "private" }, { "kind": "method", "name": "handleThumbFocus", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "handleThumbBlur", "privacy": "protected" }, { "kind": "method", "name": "_renderTicks", "privacy": "protected" }, { "kind": "method", "name": "renderTicks", "privacy": "protected" }, { "kind": "method", "name": "renderThumb", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } }, { "name": "ariaLabel", "optional": true, "type": { "text": "string" } }, { "name": "thumbId", "optional": true, "type": { "text": "string" } } ] }, { "kind": "method", "name": "renderSteps", "privacy": "private" } ], "attributes": [ { "name": "min", "description": "The minimum value of the slider scale. Defaults to 0.\n\nIf `min` is greater than `max` the call is a no-op.\n\nIf `labels` are provided (projected), then `min` is always set to 0.\n\nIf `lowerBound` ends up being less than than the current `min` value,\nit is automatically assigned the new `min` value.", "fieldName": "min", "attribute": "min", "type": { "text": "number" } }, { "name": "max", "description": "The maximum value of the slider scale. Defaults to 100.\n\nIf `max` is less than `min` the call is a no-op.\n\nIf `labels` are provided (projected), then `max` is always set to\nthe number of labels.\n\nIf `upperBound` ends up being greater than than the current `max` value,\nit is automatically assigned the new `max` value.", "fieldName": "max", "attribute": "max", "type": { "text": "number" } }, { "name": "lower-bound", "description": "The lower bound of the slider value. If not set, the `min` value is applied.", "fieldName": "lowerBound", "attribute": "lower-bound", "type": { "text": "number" } }, { "name": "upper-bound", "description": "The upper bound of the slider value. If not set, the `max` value is applied.", "fieldName": "upperBound", "attribute": "upper-bound", "type": { "text": "number" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the UI interactions of the slider.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "discrete-track", "type": { "text": "boolean" }, "default": "false", "description": "Marks the slider track as discrete so it displays the steps.\nIf the `step` is 0, the slider will remain continuos even if `discreteTrack` is `true`.", "fieldName": "discreteTrack", "attribute": "discrete-track" }, { "name": "hide-tooltip", "type": { "text": "boolean" }, "default": "false", "description": "Hides the thumb tooltip.", "fieldName": "hideTooltip", "attribute": "hide-tooltip" }, { "name": "step", "description": "Specifies the granularity that the value must adhere to.\n\nIf set to 0 no stepping is implied and any value in the range is allowed.\nIf `labels` are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.", "fieldName": "step", "attribute": "step", "type": { "text": "number" } }, { "name": "primary-ticks", "type": { "text": "number" }, "default": "0", "description": "The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.", "fieldName": "primaryTicks", "attribute": "primary-ticks" }, { "name": "secondary-ticks", "type": { "text": "number" }, "default": "0", "description": "The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.", "fieldName": "secondaryTicks", "attribute": "secondary-ticks" }, { "name": "tick-orientation", "type": { "text": "SliderTickOrientation" }, "default": "'end'", "description": "Changes the orientation of the ticks.", "fieldName": "tickOrientation", "attribute": "tick-orientation", "expandedType": { "text": "'end' | 'mirror' | 'start'" } }, { "name": "hide-primary-labels", "type": { "text": "boolean" }, "default": "false", "description": "Hides the primary tick labels.", "fieldName": "hidePrimaryLabels", "attribute": "hide-primary-labels" }, { "name": "hide-secondary-labels", "type": { "text": "boolean" }, "default": "false", "description": "Hides the secondary tick labels.", "fieldName": "hideSecondaryLabels", "attribute": "hide-secondary-labels" }, { "name": "locale", "type": { "text": "string" }, "default": "'en'", "description": "The locale used to format the thumb and tick label values in the slider.", "fieldName": "locale", "attribute": "locale" }, { "name": "value-format", "type": { "text": "string | undefined" }, "description": "String format used for the thumb and tick label values in the slider.", "fieldName": "valueFormat", "attribute": "value-format" }, { "name": "tick-label-rotation", "type": { "text": "SliderTickLabelRotation" }, "default": "0", "description": "The degrees for the rotation of the tick labels. Defaults to 0.", "fieldName": "tickLabelRotation", "attribute": "tick-label-rotation", "expandedType": { "text": "'0' | '90' | " } } ], "superclass": { "name": "LitElement", "package": "lit" }, "customElement": true } ], "exports": [ { "kind": "js", "name": "IgcSliderBaseComponent", "declaration": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider/slider-label.ts", "declarations": [ { "kind": "class", "description": "Allows formatting the values of the slider as string values.\nThe text content of the slider labels is used for thumb and tick labels.", "name": "IgcSliderLabelComponent", "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-slider-label'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-slider-label", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSliderLabelComponent", "module": "src/components/slider/slider-label.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider/range-slider.ts", "declarations": [ { "kind": "class", "description": "A range slider component used to select two numeric values within a range.", "name": "IgcRangeSliderComponent", "cssParts": [ { "description": "The base wrapper of the slider.", "name": "base" }, { "description": "The ticks container.", "name": "ticks" }, { "description": "The tick group container.", "name": "tick-group" }, { "description": "The tick element.", "name": "tick" }, { "description": "The tick label element.", "name": "tick-label" }, { "description": "The inner element of the tick label.", "name": "tick-label-inner" }, { "description": "The thumbs container.", "name": "thumbs" }, { "description": "The thumb element.", "name": "thumb" }, { "description": "The thumb tooltip label container.", "name": "thumb-label" }, { "description": "The thumb tooltip label inner element.", "name": "thumb-label-inner" }, { "description": "The track container.", "name": "track" }, { "description": "The track steps element.", "name": "steps" }, { "description": "The inactive element of the track.", "name": "inactive" }, { "description": "The filled part of the track.", "name": "fill" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-range-slider'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "thumbFrom", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "thumbTo", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "_lower", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_upper", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "lower", "privacy": "public", "description": "The current value of the lower thumb.", "attribute": "lower", "type": { "text": "number" } }, { "kind": "field", "name": "upper", "privacy": "public", "description": "The current value of the upper thumb.", "attribute": "upper", "type": { "text": "number" } }, { "kind": "field", "name": "thumbLabelLower", "type": { "text": "string" }, "privacy": "public", "description": "The aria label for the lower thumb.", "attribute": "thumb-label-lower" }, { "kind": "field", "name": "thumbLabelUpper", "type": { "text": "string" }, "privacy": "public", "description": "The aria label for the upper thumb.", "attribute": "thumb-label-upper" }, { "kind": "field", "name": "activeValue", "privacy": "protected", "readonly": true, "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "normalizeValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "getTrackStyle", "privacy": "protected", "return": { "type": { "text": "StyleInfo" } }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "closestTo", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "goal", "type": { "text": "number" } }, { "name": "positions", "type": { "text": "number[]" } } ] }, { "kind": "method", "name": "closestHandle", "privacy": "protected", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "updateValue", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "increment", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "emitInputEvent", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "emitChangeEvent", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "toggleActiveThumb", "privacy": "private" }, { "kind": "method", "name": "handleFocus", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ] }, { "kind": "method", "name": "renderThumb", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } }, { "name": "ariaLabel", "optional": true, "type": { "text": "string" } }, { "name": "thumbId", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "renderThumbs", "privacy": "protected", "return": { "type": { "text": "TemplateResult<1>" } }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "field", "name": "thumb", "type": { "text": "HTMLElement" }, "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "base", "type": { "text": "HTMLDivElement" }, "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "labelElements", "type": { "text": "HTMLElement[]" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_min", "type": { "text": "number" }, "privacy": "private", "default": "0", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_max", "type": { "text": "number" }, "privacy": "private", "default": "100", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_lowerBound", "type": { "text": "number | undefined" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_upperBound", "type": { "text": "number | undefined" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_step", "type": { "text": "number" }, "privacy": "private", "default": "1", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "startValue", "type": { "text": "number | undefined" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "pointerCaptured", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "thumbHoverTimer", "type": { "text": "any" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "activeThumb", "type": { "text": "HTMLElement | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "thumbLabelsVisible", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "labels", "type": { "text": "string[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hasLabels", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "distance", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum value of the slider scale. Defaults to 0.\n\nIf `min` is greater than `max` the call is a no-op.\n\nIf `labels` are provided (projected), then `min` is always set to 0.\n\nIf `lowerBound` ends up being less than than the current `min` value,\nit is automatically assigned the new `min` value.", "attribute": "min", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value of the slider scale. Defaults to 100.\n\nIf `max` is less than `min` the call is a no-op.\n\nIf `labels` are provided (projected), then `max` is always set to\nthe number of labels.\n\nIf `upperBound` ends up being greater than than the current `max` value,\nit is automatically assigned the new `max` value.", "attribute": "max", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "lowerBound", "privacy": "public", "description": "The lower bound of the slider value. If not set, the `min` value is applied.", "attribute": "lower-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "upperBound", "privacy": "public", "description": "The upper bound of the slider value. If not set, the `max` value is applied.", "attribute": "upper-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Disables the UI interactions of the slider.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "discreteTrack", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Marks the slider track as discrete so it displays the steps.\nIf the `step` is 0, the slider will remain continuos even if `discreteTrack` is `true`.", "attribute": "discrete-track", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hideTooltip", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the thumb tooltip.", "attribute": "hide-tooltip", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "step", "privacy": "public", "description": "Specifies the granularity that the value must adhere to.\n\nIf set to 0 no stepping is implied and any value in the range is allowed.\nIf `labels` are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.", "attribute": "step", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "primaryTicks", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.", "attribute": "primary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "secondaryTicks", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.", "attribute": "secondary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "tickOrientation", "type": { "text": "SliderTickOrientation" }, "privacy": "public", "default": "'end'", "description": "Changes the orientation of the ticks.", "attribute": "tick-orientation", "expandedType": { "text": "'end' | 'mirror' | 'start'" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hidePrimaryLabels", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the primary tick labels.", "attribute": "hide-primary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hideSecondaryLabels", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the secondary tick labels.", "attribute": "hide-secondary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "locale", "type": { "text": "string" }, "privacy": "public", "default": "'en'", "description": "The locale used to format the thumb and tick label values in the slider.", "attribute": "locale", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "valueFormat", "type": { "text": "string | undefined" }, "privacy": "public", "description": "String format used for the thumb and tick label values in the slider.", "attribute": "value-format", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "valueFormatOptions", "type": { "text": "Intl.NumberFormatOptions | undefined" }, "privacy": "public", "description": "Number format options used for the thumb and tick label values in the slider.", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "tickLabelRotation", "type": { "text": "SliderTickLabelRotation" }, "privacy": "public", "default": "0", "description": "The degrees for the rotation of the tick labels. Defaults to 0.", "attribute": "tick-label-rotation", "reflects": true, "expandedType": { "text": "'0' | '90' | " }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "constraintsChange", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleArrowKeys", "privacy": "private", "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handlePageKeys", "privacy": "private", "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleKeyboardIncrement", "privacy": "private", "parameters": [ { "name": "increment", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleKeyUp", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleSlotChange", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "validateValue", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "formatValue", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "normalizeByStep", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "totalTickCount", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "tickValue", "privacy": "private", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "isPrimary", "privacy": "private", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "showThumbLabels", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "hideThumbLabels", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "calculateTrackUpdate", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "mouseX", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "updateSlider", "privacy": "private", "parameters": [ { "name": "mouseX", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "pointerDown", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "pointerMove", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "lostPointerCapture", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleThumbFocus", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleThumbBlur", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "_renderTicks", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "renderTicks", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "renderSteps", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } } ], "events": [ { "description": "Emitted when a value is changed via thumb drag or keyboard interaction.", "name": "igcInput" }, { "description": "Emitted when a value change is committed on a thumb drag end or keyboard interaction.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "lower", "description": "The current value of the lower thumb.", "fieldName": "lower", "attribute": "lower", "type": { "text": "number" } }, { "name": "upper", "description": "The current value of the upper thumb.", "fieldName": "upper", "attribute": "upper", "type": { "text": "number" } }, { "name": "thumb-label-lower", "type": { "text": "string" }, "description": "The aria label for the lower thumb.", "fieldName": "thumbLabelLower", "attribute": "thumb-label-lower" }, { "name": "thumb-label-upper", "type": { "text": "string" }, "description": "The aria label for the upper thumb.", "fieldName": "thumbLabelUpper", "attribute": "thumb-label-upper" }, { "name": "min", "description": "The minimum value of the slider scale. Defaults to 0.\n\nIf `min` is greater than `max` the call is a no-op.\n\nIf `labels` are provided (projected), then `min` is always set to 0.\n\nIf `lowerBound` ends up being less than than the current `min` value,\nit is automatically assigned the new `min` value.", "fieldName": "min", "attribute": "min", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "max", "description": "The maximum value of the slider scale. Defaults to 100.\n\nIf `max` is less than `min` the call is a no-op.\n\nIf `labels` are provided (projected), then `max` is always set to\nthe number of labels.\n\nIf `upperBound` ends up being greater than than the current `max` value,\nit is automatically assigned the new `max` value.", "fieldName": "max", "attribute": "max", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "lower-bound", "description": "The lower bound of the slider value. If not set, the `min` value is applied.", "fieldName": "lowerBound", "attribute": "lower-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "upper-bound", "description": "The upper bound of the slider value. If not set, the `max` value is applied.", "fieldName": "upperBound", "attribute": "upper-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the UI interactions of the slider.", "fieldName": "disabled", "attribute": "disabled", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "discrete-track", "type": { "text": "boolean" }, "default": "false", "description": "Marks the slider track as discrete so it displays the steps.\nIf the `step` is 0, the slider will remain continuos even if `discreteTrack` is `true`.", "fieldName": "discreteTrack", "attribute": "discrete-track", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "hide-tooltip", "type": { "text": "boolean" }, "default": "false", "description": "Hides the thumb tooltip.", "fieldName": "hideTooltip", "attribute": "hide-tooltip", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "step", "description": "Specifies the granularity that the value must adhere to.\n\nIf set to 0 no stepping is implied and any value in the range is allowed.\nIf `labels` are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.", "fieldName": "step", "attribute": "step", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "primary-ticks", "type": { "text": "number" }, "default": "0", "description": "The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.", "fieldName": "primaryTicks", "attribute": "primary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "secondary-ticks", "type": { "text": "number" }, "default": "0", "description": "The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.", "fieldName": "secondaryTicks", "attribute": "secondary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "tick-orientation", "type": { "text": "SliderTickOrientation" }, "default": "'end'", "description": "Changes the orientation of the ticks.", "fieldName": "tickOrientation", "attribute": "tick-orientation", "expandedType": { "text": "'end' | 'mirror' | 'start'" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "hide-primary-labels", "type": { "text": "boolean" }, "default": "false", "description": "Hides the primary tick labels.", "fieldName": "hidePrimaryLabels", "attribute": "hide-primary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "hide-secondary-labels", "type": { "text": "boolean" }, "default": "false", "description": "Hides the secondary tick labels.", "fieldName": "hideSecondaryLabels", "attribute": "hide-secondary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "locale", "type": { "text": "string" }, "default": "'en'", "description": "The locale used to format the thumb and tick label values in the slider.", "fieldName": "locale", "attribute": "locale", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "value-format", "type": { "text": "string | undefined" }, "description": "String format used for the thumb and tick label values in the slider.", "fieldName": "valueFormat", "attribute": "value-format", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "tick-label-rotation", "type": { "text": "SliderTickLabelRotation" }, "default": "0", "description": "The degrees for the rotation of the tick labels. Defaults to 0.", "fieldName": "tickLabelRotation", "attribute": "tick-label-rotation", "expandedType": { "text": "'0' | '90' | " }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcSliderBaseComponent", "module": "/src/components/slider/slider-base.js" }, "tagName": "igc-range-slider", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcRangeSliderComponent", "module": "src/components/slider/range-slider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/snackbar/snackbar.ts", "declarations": [ { "kind": "class", "description": "A snackbar component is used to provide feedback about an operation\nby showing a brief message at the bottom of the screen.", "name": "IgcSnackbarComponent", "cssParts": [ { "description": "The base wrapper of the snackbar component.", "name": "base" }, { "description": "The snackbar message.", "name": "message" }, { "description": "The default snackbar action button.", "name": "action" }, { "description": "The area holding the actions.", "name": "action-container" } ], "slots": [ { "description": "Default slot to render the snackbar content.", "name": "" }, { "description": "Renders the action part of the snackbar. Usually an interactive element (button)", "name": "action" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-snackbar'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_contentRef", "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_player", "type": { "text": "AnimationController" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "actionText", "type": { "text": "string" }, "privacy": "public", "description": "The snackbar action button.", "attribute": "action-text" }, { "kind": "method", "name": "_handleClick", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "field", "name": "_autoHideTimeout", "type": { "text": "ReturnType | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the component is in shown state.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "displayTime", "type": { "text": "number" }, "privacy": "public", "default": "4000", "description": "Determines the duration in ms in which the component will be visible.", "attribute": "display-time", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "keepOpen", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the component should close after the `displayTime` is over.", "attribute": "keep-open", "reflects": true, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "field", "name": "position", "type": { "text": "AbsolutePosition" }, "privacy": "public", "default": "'bottom'", "description": "Sets the position of the component in the viewport.", "attribute": "position", "reflects": true, "expandedType": { "text": "'bottom' | 'middle' | 'top'" }, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "_setOpenState", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "open", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "_setAutoHideTimer", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Opens the component.", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "hide", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Closes the component.", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "Promise" } }, "description": "Toggles the open state of the component.", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } } ], "events": [ { "description": "Emitted when the snackbar action button is clicked.", "name": "igcAction" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "action-text", "type": { "text": "string" }, "description": "The snackbar action button.", "fieldName": "actionText", "attribute": "action-text" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Whether the component is in shown state.", "fieldName": "open", "attribute": "open", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "name": "display-time", "type": { "text": "number" }, "default": "4000", "description": "Determines the duration in ms in which the component will be visible.", "fieldName": "displayTime", "attribute": "display-time", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "name": "keep-open", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the component should close after the `displayTime` is over.", "fieldName": "keepOpen", "attribute": "keep-open", "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } }, { "name": "position", "type": { "text": "AbsolutePosition" }, "default": "'bottom'", "description": "Sets the position of the component in the viewport.", "fieldName": "position", "attribute": "position", "expandedType": { "text": "'bottom' | 'middle' | 'top'" }, "inheritedFrom": { "name": "IgcBaseAlertLikeComponent", "module": "src/components/common/mixins/alert.ts" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcBaseAlertLikeComponent", "module": "/src/components/common/mixins/alert.js" }, "tagName": "igc-snackbar", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSnackbarComponent", "module": "src/components/snackbar/snackbar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/slider/slider.ts", "declarations": [ { "kind": "class", "description": "A slider component used to select numeric value within a range.", "name": "IgcSliderComponent", "cssParts": [ { "description": "The base wrapper of the slider.", "name": "base" }, { "description": "The ticks container.", "name": "ticks" }, { "description": "The tick group container.", "name": "tick-group" }, { "description": "The tick element.", "name": "tick" }, { "description": "The tick label element.", "name": "tick-label" }, { "description": "The inner element of the tick label.", "name": "tick-label-inner" }, { "description": "The thumbs container.", "name": "thumbs" }, { "description": "The thumb element.", "name": "thumb" }, { "description": "The thumb tooltip label container.", "name": "thumb-label" }, { "description": "The thumb tooltip label inner element.", "name": "thumb-label-inner" }, { "description": "The track container.", "name": "track" }, { "description": "The track steps element.", "name": "steps" }, { "description": "The inactive element of the track.", "name": "inactive" }, { "description": "The filled part of the track.", "name": "fill" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-slider'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The current value of the component.", "attribute": "value", "type": { "text": "number" } }, { "kind": "field", "name": "activeValue", "privacy": "protected", "readonly": true, "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "normalizeValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "getTrackStyle", "privacy": "protected", "return": { "type": { "text": "StyleInfo" } }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "updateValue", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "increment", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "emitInputEvent", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "emitChangeEvent", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "stepUp", "privacy": "public", "parameters": [ { "name": "stepIncrement", "default": "1", "description": "Optional step increment. If no parameter is passed, it defaults to 1." } ], "description": "Increments the value of the slider by `stepIncrement * step`, where `stepIncrement` defaults to 1." }, { "kind": "method", "name": "stepDown", "privacy": "public", "parameters": [ { "name": "stepDecrement", "default": "1", "description": "Optional step decrement. If no parameter is passed, it defaults to 1." } ], "description": "Decrements the value of the slider by `stepDecrement * step`, where `stepDecrement` defaults to 1." }, { "kind": "method", "name": "renderThumbs", "privacy": "protected", "return": { "type": { "text": "TemplateResult<1>" } }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "defaultValue", "privacy": "public", "type": { "text": "unknown" }, "inheritedFrom": { "name": "FormAssociatedMixin", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The disabled state of the component.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "field", "name": "thumb", "type": { "text": "HTMLElement" }, "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "base", "type": { "text": "HTMLDivElement" }, "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "labelElements", "type": { "text": "HTMLElement[]" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_min", "type": { "text": "number" }, "privacy": "private", "default": "0", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_max", "type": { "text": "number" }, "privacy": "private", "default": "100", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_lowerBound", "type": { "text": "number | undefined" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_upperBound", "type": { "text": "number | undefined" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "_step", "type": { "text": "number" }, "privacy": "private", "default": "1", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "startValue", "type": { "text": "number | undefined" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "pointerCaptured", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "thumbHoverTimer", "type": { "text": "any" }, "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "activeThumb", "type": { "text": "HTMLElement | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "thumbLabelsVisible", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "labels", "type": { "text": "string[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hasLabels", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "distance", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum value of the slider scale. Defaults to 0.\n\nIf `min` is greater than `max` the call is a no-op.\n\nIf `labels` are provided (projected), then `min` is always set to 0.\n\nIf `lowerBound` ends up being less than than the current `min` value,\nit is automatically assigned the new `min` value.", "attribute": "min", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum value of the slider scale. Defaults to 100.\n\nIf `max` is less than `min` the call is a no-op.\n\nIf `labels` are provided (projected), then `max` is always set to\nthe number of labels.\n\nIf `upperBound` ends up being greater than than the current `max` value,\nit is automatically assigned the new `max` value.", "attribute": "max", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "lowerBound", "privacy": "public", "description": "The lower bound of the slider value. If not set, the `min` value is applied.", "attribute": "lower-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "upperBound", "privacy": "public", "description": "The upper bound of the slider value. If not set, the `max` value is applied.", "attribute": "upper-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "discreteTrack", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Marks the slider track as discrete so it displays the steps.\nIf the `step` is 0, the slider will remain continuos even if `discreteTrack` is `true`.", "attribute": "discrete-track", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hideTooltip", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the thumb tooltip.", "attribute": "hide-tooltip", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "step", "privacy": "public", "description": "Specifies the granularity that the value must adhere to.\n\nIf set to 0 no stepping is implied and any value in the range is allowed.\nIf `labels` are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.", "attribute": "step", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "primaryTicks", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.", "attribute": "primary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "secondaryTicks", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.", "attribute": "secondary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "tickOrientation", "type": { "text": "SliderTickOrientation" }, "privacy": "public", "default": "'end'", "description": "Changes the orientation of the ticks.", "attribute": "tick-orientation", "expandedType": { "text": "'end' | 'mirror' | 'start'" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hidePrimaryLabels", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the primary tick labels.", "attribute": "hide-primary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "hideSecondaryLabels", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the secondary tick labels.", "attribute": "hide-secondary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "locale", "type": { "text": "string" }, "privacy": "public", "default": "'en'", "description": "The locale used to format the thumb and tick label values in the slider.", "attribute": "locale", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "valueFormat", "type": { "text": "string | undefined" }, "privacy": "public", "description": "String format used for the thumb and tick label values in the slider.", "attribute": "value-format", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "valueFormatOptions", "type": { "text": "Intl.NumberFormatOptions | undefined" }, "privacy": "public", "description": "Number format options used for the thumb and tick label values in the slider.", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "field", "name": "tickLabelRotation", "type": { "text": "SliderTickLabelRotation" }, "privacy": "public", "default": "0", "description": "The degrees for the rotation of the tick labels. Defaults to 0.", "attribute": "tick-label-rotation", "reflects": true, "expandedType": { "text": "'0' | '90' | " }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "constraintsChange", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleArrowKeys", "privacy": "private", "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handlePageKeys", "privacy": "private", "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleKeyboardIncrement", "privacy": "private", "parameters": [ { "name": "increment", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleKeyUp", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleSlotChange", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "validateValue", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "formatValue", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "normalizeByStep", "privacy": "private", "parameters": [ { "name": "value", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "closestHandle", "privacy": "protected", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "_event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "totalTickCount", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "tickValue", "privacy": "private", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "isPrimary", "privacy": "private", "parameters": [ { "name": "idx", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "showThumbLabels", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "hideThumbLabels", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "calculateTrackUpdate", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "mouseX", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "updateSlider", "privacy": "private", "parameters": [ { "name": "mouseX", "type": { "text": "number" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "pointerDown", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "pointerMove", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "lostPointerCapture", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleThumbFocus", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "FocusEvent" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "handleThumbBlur", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "_renderTicks", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "renderTicks", "privacy": "protected", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "renderThumb", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "number" } }, { "name": "ariaLabel", "optional": true, "type": { "text": "string" } }, { "name": "thumbId", "optional": true, "type": { "text": "string" } } ], "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "kind": "method", "name": "renderSteps", "privacy": "private", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } } ], "events": [ { "description": "Emitted when a value is changed via thumb drag or keyboard interaction.", "name": "igcInput" }, { "description": "Emitted when a value change is committed on a thumb drag end or keyboard interaction.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "value", "description": "The current value of the component.", "fieldName": "value", "attribute": "value", "type": { "text": "number" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "The disabled state of the component.", "fieldName": "disabled", "attribute": "disabled", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "BaseFormAssociated", "module": "src/components/common/mixins/forms/associated.ts" } }, { "name": "min", "description": "The minimum value of the slider scale. Defaults to 0.\n\nIf `min` is greater than `max` the call is a no-op.\n\nIf `labels` are provided (projected), then `min` is always set to 0.\n\nIf `lowerBound` ends up being less than than the current `min` value,\nit is automatically assigned the new `min` value.", "fieldName": "min", "attribute": "min", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "max", "description": "The maximum value of the slider scale. Defaults to 100.\n\nIf `max` is less than `min` the call is a no-op.\n\nIf `labels` are provided (projected), then `max` is always set to\nthe number of labels.\n\nIf `upperBound` ends up being greater than than the current `max` value,\nit is automatically assigned the new `max` value.", "fieldName": "max", "attribute": "max", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "lower-bound", "description": "The lower bound of the slider value. If not set, the `min` value is applied.", "fieldName": "lowerBound", "attribute": "lower-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "upper-bound", "description": "The upper bound of the slider value. If not set, the `max` value is applied.", "fieldName": "upperBound", "attribute": "upper-bound", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "discrete-track", "type": { "text": "boolean" }, "default": "false", "description": "Marks the slider track as discrete so it displays the steps.\nIf the `step` is 0, the slider will remain continuos even if `discreteTrack` is `true`.", "fieldName": "discreteTrack", "attribute": "discrete-track", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "hide-tooltip", "type": { "text": "boolean" }, "default": "false", "description": "Hides the thumb tooltip.", "fieldName": "hideTooltip", "attribute": "hide-tooltip", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "step", "description": "Specifies the granularity that the value must adhere to.\n\nIf set to 0 no stepping is implied and any value in the range is allowed.\nIf `labels` are provided (projected) then the step is always assumed to be 1 since it is a discrete slider.", "fieldName": "step", "attribute": "step", "type": { "text": "number" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "primary-ticks", "type": { "text": "number" }, "default": "0", "description": "The number of primary ticks. It defaults to 0 which means no primary ticks are displayed.", "fieldName": "primaryTicks", "attribute": "primary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "secondary-ticks", "type": { "text": "number" }, "default": "0", "description": "The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed.", "fieldName": "secondaryTicks", "attribute": "secondary-ticks", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "tick-orientation", "type": { "text": "SliderTickOrientation" }, "default": "'end'", "description": "Changes the orientation of the ticks.", "fieldName": "tickOrientation", "attribute": "tick-orientation", "expandedType": { "text": "'end' | 'mirror' | 'start'" }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "hide-primary-labels", "type": { "text": "boolean" }, "default": "false", "description": "Hides the primary tick labels.", "fieldName": "hidePrimaryLabels", "attribute": "hide-primary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "hide-secondary-labels", "type": { "text": "boolean" }, "default": "false", "description": "Hides the secondary tick labels.", "fieldName": "hideSecondaryLabels", "attribute": "hide-secondary-labels", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "locale", "type": { "text": "string" }, "default": "'en'", "description": "The locale used to format the thumb and tick label values in the slider.", "fieldName": "locale", "attribute": "locale", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "value-format", "type": { "text": "string | undefined" }, "description": "String format used for the thumb and tick label values in the slider.", "fieldName": "valueFormat", "attribute": "value-format", "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } }, { "name": "tick-label-rotation", "type": { "text": "SliderTickLabelRotation" }, "default": "0", "description": "The degrees for the rotation of the tick labels. Defaults to 0.", "fieldName": "tickLabelRotation", "attribute": "tick-label-rotation", "expandedType": { "text": "'0' | '90' | " }, "inheritedFrom": { "name": "IgcSliderBaseComponent", "module": "src/components/slider/slider-base.ts" } } ], "mixins": [ { "name": "FormAssociatedMixin", "module": "/src/components/common/mixins/forms/associated.js" }, { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "IgcSliderBaseComponent", "module": "/src/components/slider/slider-base.js" }, "tagName": "igc-slider", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSliderComponent", "module": "src/components/slider/slider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tabs/tab.ts", "declarations": [ { "kind": "class", "description": "A tab element slotted into an `igc-tabs` container.", "name": "IgcTabComponent", "cssParts": [ { "description": "The header of a single tab.", "name": "tab-header" }, { "description": "Tab header's label prefix.", "name": "prefix" }, { "description": "Tab header's label slot container.", "name": "content" }, { "description": "Tab header's label suffix.", "name": "suffix" }, { "description": "Holds the body content of a single tab, only the body of the selected tab is visible.", "name": "tab-body" } ], "slots": [ { "description": "Renders the tab's content.", "name": "" }, { "description": "Renders the tab header's label.", "name": "label" }, { "description": "Renders the tab header's prefix.", "name": "prefix" }, { "description": "Renders the tab header's suffix.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tab'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The tab item label.", "attribute": "label" }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the tab is selected.", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Determines whether the tab is disabled.", "attribute": "disabled", "reflects": true } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The tab item label.", "fieldName": "label", "attribute": "label" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the tab is selected.", "fieldName": "selected", "attribute": "selected" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the tab is disabled.", "fieldName": "disabled", "attribute": "disabled" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tab", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTabComponent", "module": "src/components/tabs/tab.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tabs/tab-dom.ts", "declarations": [ { "kind": "function", "name": "createTabHelpers", "parameters": [ { "name": "host", "type": { "text": "IgcTabsComponent" } }, { "name": "container", "type": { "text": "Ref" } }, { "name": "indicator", "type": { "text": "Ref" } } ] }, { "kind": "function", "name": "getTabHeader", "return": { "type": { "text": "HTMLElement" } }, "parameters": [ { "name": "tab", "type": { "text": "IgcTabComponent" } } ] } ], "exports": [ { "kind": "js", "name": "createTabHelpers", "declaration": { "name": "createTabHelpers", "module": "src/components/tabs/tab-dom.ts" } }, { "kind": "js", "name": "getTabHeader", "declaration": { "name": "getTabHeader", "module": "src/components/tabs/tab-dom.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tabs/tabs.ts", "declarations": [ { "kind": "class", "description": "Tabs organize and allow navigation between groups of content that are related and at the same level of hierarchy.\n\nThe `` component allows the user to navigate between multiple `` elements.\nIt supports keyboard navigation and provides API methods to control the selected tab.", "name": "IgcTabsComponent", "cssParts": [ { "description": "The start scroll button displayed when the tabs overflow.", "name": "start-scroll-button" }, { "description": "The end scroll button displayed when the tabs overflow.", "name": "end-scroll-button" }, { "description": "The indicator that shows which tab is selected.", "name": "selected-indicator" } ], "slots": [ { "description": "Renders the `IgcTabComponents` inside default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tabs'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_resizeController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_headerRef", "privacy": "private", "readonly": true, "description": "The tabs container reference holding the tab headers." }, { "kind": "field", "name": "_indicatorRef", "privacy": "private", "readonly": true, "description": "The selected tab indicator reference." }, { "kind": "field", "name": "_domHelpers", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_tabs", "type": { "text": "IgcTabComponent[]" }, "privacy": "private" }, { "kind": "field", "name": "_enabledTabs", "type": { "text": "IgcTabComponent[]" }, "privacy": "protected", "readonly": true }, { "kind": "field", "name": "_activeTab", "type": { "text": "IgcTabComponent | undefined" }, "privacy": "private" }, { "kind": "field", "name": "alignment", "type": { "text": "TabsAlignment" }, "privacy": "public", "default": "'start'", "description": "Sets the alignment for the tab headers", "attribute": "alignment", "reflects": true, "expandedType": { "text": "'start' | 'end' | 'center' | 'justify'" } }, { "kind": "field", "name": "activation", "type": { "text": "TabsActivation" }, "privacy": "public", "default": "'auto'", "description": "Determines the tab activation. When set to auto,\nthe tab is instantly selected while navigating with the Left/Right Arrows, Home or End keys\nand the corresponding panel is displayed.\nWhen set to manual, the tab is only focused. The selection happens after pressing Space or Enter.", "attribute": "activation", "expandedType": { "text": "'auto' | 'manual'" } }, { "kind": "field", "name": "tabs", "type": { "text": "IgcTabComponent[]" }, "privacy": "public", "description": "Returns the direct `igc-tab` elements that are children of this element.", "readonly": true }, { "kind": "field", "name": "selected", "type": { "text": "string" }, "privacy": "public", "description": "Returns the currently selected tab label or IDREF if no label property is set.", "readonly": true }, { "kind": "method", "name": "_alignmentChanged", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_resizeCallback", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_mutationCallback", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "parameters", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "method", "name": "_selectedAttributeChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{\n changes,\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "method", "name": "_handleTabsAdded", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{\n changes,\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "method", "name": "_handleTabsRemoved", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "{\n changes,\n }", "type": { "text": "MutationControllerParams" } } ] }, { "kind": "method", "name": "_getClosestActiveTabIndex", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "method", "name": "_setSelectedTab", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "tab", "optional": true, "type": { "text": "IgcTabComponent" } }, { "name": "shouldEmit", "default": "true" } ] }, { "kind": "method", "name": "_keyboardActivateTab", "privacy": "private", "parameters": [ { "name": "tab", "type": { "text": "IgcTabComponent" } } ] }, { "kind": "method", "name": "_skipKeyboard", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "node", "type": { "text": "Element" } }, { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_isEventFromTabHeader", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_handleArrowKeys", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_handleHomeKey", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleEndKey", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleActivationKeys", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleScroll", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "id", "type": { "text": "string" } } ], "description": "Selects the specified tab and displays the corresponding panel." }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "ref", "type": { "text": "IgcTabComponent" } } ] }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "ref", "type": { "text": "IgcTabComponent | string" } } ] }, { "kind": "method", "name": "_renderScrollButton", "privacy": "protected", "parameters": [ { "name": "direction", "type": { "text": "'start' | 'end'" } } ] }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the selected tab changes.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "alignment", "type": { "text": "TabsAlignment" }, "default": "'start'", "description": "Sets the alignment for the tab headers", "fieldName": "alignment", "attribute": "alignment", "expandedType": { "text": "'start' | 'end' | 'center' | 'justify'" } }, { "name": "activation", "type": { "text": "TabsActivation" }, "default": "'auto'", "description": "Determines the tab activation. When set to auto,\nthe tab is instantly selected while navigating with the Left/Right Arrows, Home or End keys\nand the corresponding panel is displayed.\nWhen set to manual, the tab is only focused. The selection happens after pressing Space or Enter.", "fieldName": "activation", "attribute": "activation", "expandedType": { "text": "'auto' | 'manual'" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tabs", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTabsComponent", "module": "src/components/tabs/tabs.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/checkbox/switch.ts", "declarations": [ { "kind": "class", "description": "Similar to a checkbox, a switch controls the state of a single setting on or off.", "name": "IgcSwitchComponent", "cssParts": [ { "description": "The base wrapper of the switch.", "name": "base" }, { "description": "The switch input element.", "name": "control" }, { "description": "The position indicator of the switch.", "name": "thumb" }, { "description": "The switch label.", "name": "label" } ], "slots": [ { "description": "The switch label.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-switch'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_inputId", "privacy": "private", "readonly": true, "default": "`switch-${nextId++}`" }, { "kind": "field", "name": "_labelId", "privacy": "private", "readonly": true, "default": "`switch-label-${this._inputId}`" }, { "kind": "field", "name": "_required", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "required", "privacy": "public", "description": "When set, makes the component a required field for validation.", "default": "false", "attribute": "required", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "defaultChecked", "privacy": "public", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "privacy": "public", "static": true, "readonly": true, "default": "true", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "__internals", "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_formValue", "type": { "text": "FormValue" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_isFormSubmit", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_isInternalValidation", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_touched", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_isExternalInvalid", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_hasUserInteraction", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_shouldApplyStyles", "type": { "text": "boolean" }, "privacy": "private", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_invalid", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_pristine", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "__validators", "type": { "text": "Validator[]" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "description": "The name attribute of the control.", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "The disabled state of the component.", "default": "false", "attribute": "disabled", "type": { "text": "boolean" }, "reflects": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "invalid", "privacy": "public", "description": "Sets the control into invalid state (visual state only).", "default": "false", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "form", "type": { "text": "HTMLFormElement | null" }, "privacy": "public", "description": "Returns the HTMLFormElement associated with this element.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "validity", "type": { "text": "ValidityState" }, "privacy": "public", "description": "Returns a ValidityState object which represents the different validity states\nthe element can be in, with respect to constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "validationMessage", "type": { "text": "string" }, "privacy": "public", "description": "A string containing the validation message of this element.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "willValidate", "type": { "text": "boolean" }, "privacy": "public", "description": "A boolean value which returns true if the element is a submittable element\nthat is a candidate for constraint validation.", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleInvalid", "privacy": "private", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setInvalidStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "__runValidators", "privacy": "private", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_validate", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "userMessage", "optional": true, "type": { "text": "string" } } ], "description": "Executes the component validators and updates the internal validity state.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleBlur", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setTouchedState", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "current", "type": { "text": "string | null" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_restoreDefaultValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_setFormValue", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "FormValueType" } }, { "name": "state", "optional": true, "type": { "text": "FormValueType" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formAssociatedCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_form", "type": { "text": "HTMLFormElement" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formDisabledCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "state", "type": { "text": "boolean" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formResetCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "formStateRestoreCallback", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "_state", "type": { "text": "FormValueType" } }, { "name": "_mode", "type": { "text": "FormRestoreMode" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "reportValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and shows the browser message if it invalid.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "checkValidity", "privacy": "public", "return": { "type": { "text": "boolean" } }, "description": "Checks for validity of the control and emits the invalid event if it invalid.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "setCustomValidity", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "message", "type": { "text": "string" } } ], "description": "Sets a custom validation message for the control.\nAs long as `message` is not empty, the control is considered invalid.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_slots", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_focusRingManager", "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_value", "type": { "text": "string" }, "privacy": "protected", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_input", "type": { "text": "HTMLInputElement" }, "privacy": "protected", "readonly": true, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "_hideLabel", "type": { "text": "boolean" }, "privacy": "protected", "default": "true", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "value", "privacy": "public", "description": "The value attribute of the control.", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "checked", "privacy": "public", "description": "The checked state of the control.", "attribute": "checked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "field", "name": "labelPosition", "type": { "text": "ToggleLabelPosition" }, "privacy": "public", "default": "'after'", "description": "The label position of the control.", "attribute": "label-position", "reflects": true, "expandedType": { "text": "'after' | 'before'" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "click", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Simulates a click on the control.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "focus", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "FocusOptions" } } ], "description": "Sets focus on the control.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "blur", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Removes focus from the control.", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleSlotChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "kind": "method", "name": "_handleClick", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "PointerEvent" } } ], "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ], "events": [ { "description": "Emitted when the control's checked state changes.", "name": "igcChange" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ], "superclass": { "name": "IgcCheckboxBaseComponent", "module": "/src/components/checkbox/checkbox-base.js" }, "tagName": "igc-switch", "customElement": true, "attributes": [ { "name": "required", "description": "When set, makes the component a required field for validation.", "default": "false", "fieldName": "required", "attribute": "required", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "name", "type": { "text": "string" }, "description": "The name attribute of the control.", "fieldName": "name", "attribute": "name", "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "disabled", "description": "The disabled state of the component.", "default": "false", "fieldName": "disabled", "attribute": "disabled", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "invalid", "description": "Sets the control into invalid state (visual state only).", "default": "false", "fieldName": "invalid", "attribute": "invalid", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "value", "description": "The value attribute of the control.", "fieldName": "value", "attribute": "value", "type": { "text": "string" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "checked", "description": "The checked state of the control.", "fieldName": "checked", "attribute": "checked", "type": { "text": "boolean" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } }, { "name": "label-position", "type": { "text": "ToggleLabelPosition" }, "default": "'after'", "description": "The label position of the control.", "fieldName": "labelPosition", "attribute": "label-position", "expandedType": { "text": "'after' | 'before'" }, "inheritedFrom": { "name": "IgcCheckboxBaseComponent", "module": "src/components/checkbox/checkbox-base.ts" } } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSwitchComponent", "module": "src/components/checkbox/switch.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tree/tree.selection.ts", "declarations": [ { "kind": "class", "description": "", "name": "IgcTreeSelectionService", "members": [ { "kind": "field", "name": "tree", "type": { "text": "IgcTreeComponent" }, "privacy": "private", "default": "tree" }, { "kind": "field", "name": "itemSelection", "type": { "text": "Set" }, "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "indeterminateItems", "type": { "text": "Set" }, "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "itemsToBeSelected", "type": { "text": "Set" }, "privacy": "private" }, { "kind": "field", "name": "itemsToBeIndeterminate", "type": { "text": "Set" }, "privacy": "private" }, { "kind": "method", "name": "selectMultipleItems", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "Select range from last selected item to the current specified item." }, { "kind": "method", "name": "selectItem", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "Select the specified item and emit event." }, { "kind": "method", "name": "deselectItem", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "Deselect the specified item and emit event." }, { "kind": "method", "name": "clearItemsSelection", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Clears item selection" }, { "kind": "method", "name": "isItemSelected", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ] }, { "kind": "method", "name": "isItemIndeterminate", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ] }, { "kind": "method", "name": "ensureStateOnItemDelete", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "Called on item`s disconnectedCallback" }, { "kind": "method", "name": "retriggerItemState", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "Retrigger the selection state of the item." }, { "kind": "method", "name": "emitItemSelectionEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "newSelection", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "added", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "removed", "type": { "text": "IgcTreeItemComponent[]" } } ] }, { "kind": "method", "name": "selectItemsWithNoEvent", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "Select specified items. No event is emitted." }, { "kind": "method", "name": "deselectItemsWithNoEvent", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "optional": true, "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "onDelete", "default": "false" } ], "description": "Deselect specified items. No event is emitted." }, { "kind": "method", "name": "emitCascadeItemSelectionEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "currSelection", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "added", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "removed", "type": { "text": "IgcTreeItemComponent[]" } } ] }, { "kind": "method", "name": "cascadeSelectItemsWithNoEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "oldSelection", "type": { "text": "IgcTreeItemComponent[]" } } ] }, { "kind": "method", "name": "cascadeDeselectItemsWithNoEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "optional": true, "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "onDelete", "default": "false" } ] }, { "kind": "method", "name": "calculateItemsNewSelectionState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "oldSelection", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "added", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "removed", "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "populates the itemsToBeSelected and itemsToBeIndeterminate sets\nwith the items which will be eventually in selected/indeterminate state" }, { "kind": "method", "name": "cascadeSelectionState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "type": { "text": "IgcTreeItemComponent[] | undefined" } }, { "name": "selected", "type": { "text": "boolean" } } ], "description": "Ensures proper selection state for all predescessors and descendants during a selection event" }, { "kind": "method", "name": "handleParentSelectionState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "recursively handle the selection state of the direct and indirect parents" }, { "kind": "method", "name": "handleItemSelectionState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ], "description": "Handle the selection state of a given item based the selection states of its direct children" }, { "kind": "method", "name": "updateItemsState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "oldSelection", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "oldIndeterminate", "default": "[]", "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "Emits the `selectedChange` event for each item affected by the selection" }, { "kind": "method", "name": "getSelectedItems", "privacy": "private", "return": { "type": { "text": "IgcTreeItemComponent[]" } }, "description": "Returns array of the selected items." }, { "kind": "method", "name": "getIndeterminateItems", "privacy": "private", "return": { "type": { "text": "IgcTreeItemComponent[]" } }, "description": "Returns array of the items in indeterminate state." }, { "kind": "method", "name": "areEqualCollections", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "first", "type": { "text": "IgcTreeItemComponent[]" } }, { "name": "second", "type": { "text": "IgcTreeItemComponent[]" } } ] }, { "kind": "method", "name": "selectDeselectItem", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } }, { "name": "select", "type": { "text": "boolean" } }, { "name": "indeterminate", "default": "false" } ] } ] } ], "exports": [ { "kind": "js", "name": "IgcTreeSelectionService", "declaration": { "name": "IgcTreeSelectionService", "module": "src/components/tree/tree.selection.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tree/tree.navigation.ts", "declarations": [ { "kind": "variable", "name": "NAVIGATION_KEYS", "default": "new Set([ 'down', 'up', 'left', 'right', 'arrowdown', 'arrowup', 'arrowleft', 'arrowright', 'home', 'end', 'space', 'spacebar', ' ', ])" }, { "kind": "class", "description": "", "name": "IgcTreeNavigationService", "members": [ { "kind": "field", "name": "tree", "type": { "text": "IgcTreeComponent" }, "privacy": "private", "default": "tree" }, { "kind": "field", "name": "selectionService", "type": { "text": "IgcTreeSelectionService" }, "privacy": "private", "default": "selectionService" }, { "kind": "field", "name": "_focusedItem", "type": { "text": "IgcTreeItemComponent | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_lastFocusedItem", "type": { "text": "IgcTreeItemComponent | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_activeItem", "type": { "text": "IgcTreeItemComponent | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "_visibleChildren", "type": { "text": "IgcTreeItemComponent[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_invisibleChildren", "type": { "text": "Set" }, "privacy": "private", "default": "new Set()" }, { "kind": "field", "name": "_disabledChildren", "type": { "text": "Set" }, "privacy": "private", "default": "new Set()" }, { "kind": "method", "name": "updateVisChild", "privacy": "public", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "focusedItem", "type": { "text": "IgcTreeItemComponent | null" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "focusItem", "privacy": "public", "parameters": [ { "name": "value", "type": { "text": "IgcTreeItemComponent | null" } }, { "name": "shouldFocus", "default": "true" } ] }, { "kind": "field", "name": "activeItem", "type": { "text": "IgcTreeItemComponent | null" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "setActiveItem", "privacy": "public", "parameters": [ { "name": "value", "type": { "text": "IgcTreeItemComponent | null" } }, { "name": "shouldEmit", "default": "true" } ] }, { "kind": "field", "name": "visibleChildren", "type": { "text": "IgcTreeItemComponent[]" }, "privacy": "public", "readonly": true }, { "kind": "method", "name": "update_disabled_cache", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ] }, { "kind": "method", "name": "delete_item", "privacy": "public", "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ] }, { "kind": "method", "name": "update_visible_cache", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } }, { "name": "expanded", "type": { "text": "boolean" } }, { "name": "shouldUpdateNestedChildren", "default": "true" }, { "name": "shouldUpdate", "default": "true" } ] }, { "kind": "method", "name": "setFocusedAndActiveItem", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" }, "description": "target item" }, { "name": "isActive", "default": "true", "description": "if true, sets the item as active" }, { "name": "shouldFocus", "default": "true" } ], "description": "Sets the item as focused (and active)" }, { "kind": "method", "name": "handleKeydown", "privacy": "public", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ], "description": "Handler for keydown events. Used in tree.component.ts" }, { "kind": "method", "name": "handleNavigation", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "handleArrowLeft", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleArrowRight", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleUpDownArrow", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "isUp", "type": { "text": "boolean" } }, { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "handleAsterisk", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleSpace", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "shiftKey", "default": "false" } ] }, { "kind": "method", "name": "getVisibleItem", "privacy": "private", "return": { "type": { "text": "IgcTreeItemComponent" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } }, { "name": "dir", "default": "1", "type": { "text": "1 | -1" } } ], "description": "Gets the next visible item in the given direction - 1 -> next, -1 -> previous" } ] } ], "exports": [ { "kind": "js", "name": "NAVIGATION_KEYS", "declaration": { "name": "NAVIGATION_KEYS", "module": "src/components/tree/tree.navigation.ts" } }, { "kind": "js", "name": "IgcTreeNavigationService", "declaration": { "name": "IgcTreeNavigationService", "module": "src/components/tree/tree.navigation.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tree/tree-item.ts", "declarations": [ { "kind": "class", "description": "The tree-item component represents a child item of the tree component or another tree item.", "name": "IgcTreeItemComponent", "cssParts": [ { "description": "The wrapper for the tree item.", "name": "wrapper" }, { "description": "Indicates selected state. Applies to `wrapper`.", "name": "selected" }, { "description": "Indicates focused state. Applies to `wrapper`.", "name": "focused" }, { "description": "Indicates an active state. Applies to `wrapper`.", "name": "active" }, { "description": "The expand indicator of the tree item.", "name": "indicator" }, { "description": "The tree item content.", "name": "label" }, { "description": "The tree item displayed text.", "name": "text" }, { "description": "The checkbox of the tree item when selection is enabled.", "name": "select" } ], "slots": [ { "description": "Renders nested tree-item component.", "name": "" }, { "description": "Renders the tree item container.", "name": "label" }, { "description": "Renders the expand indicator container.", "name": "indicator" }, { "description": "Renders the tree item loading indicator container.", "name": "loading" }, { "description": "Renders the container (by default the space) before the tree item.", "name": "indentation" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tree-item'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "tabbableEl", "type": { "text": "HTMLElement[] | undefined" }, "privacy": "private" }, { "kind": "field", "name": "focusedProgrammatically", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "groupRef", "type": { "text": "Ref" }, "privacy": "private" }, { "kind": "field", "name": "animationPlayer", "privacy": "private" }, { "kind": "field", "name": "tree", "type": { "text": "IgcTreeComponent | undefined" }, "privacy": "public", "description": "A reference to the tree the item is a part of." }, { "kind": "field", "name": "parent", "type": { "text": "IgcTreeItemComponent | null" }, "privacy": "public", "default": "null", "description": "The parent item of the current tree item (if any)" }, { "kind": "field", "name": "contentList", "type": { "text": "Array" }, "privacy": "private" }, { "kind": "field", "name": "isFocused", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "level", "type": { "text": "number" }, "privacy": "public", "default": "0", "description": "The depth of the item, relative to the root." }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The tree item label.", "attribute": "label" }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The tree item expansion state.", "attribute": "expanded", "reflects": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Marks the item as the tree's active item.", "attribute": "active", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "The tree item selection state.", "attribute": "selected", "reflects": true }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "To be used for load-on-demand scenarios in order to specify whether the item is loading data.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "value", "type": { "text": "any" }, "privacy": "public", "default": "undefined", "description": "The value entry that the tree item is visualizing. Required for searching through items.", "attribute": "value" }, { "kind": "method", "name": "toggleAnimation", "privacy": "private", "parameters": [ { "name": "dir", "type": { "text": "'open' | 'close'" } } ] }, { "kind": "method", "name": "bothChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "expandedChange", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "oldValue", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "activeChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "disabledChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "selectedChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "selectionService", "type": { "text": "IgcTreeSelectionService | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "navService", "type": { "text": "IgcTreeNavigationService | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "parts", "privacy": "private", "readonly": true }, { "kind": "field", "name": "directChildren", "type": { "text": "Array" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "allChildren", "type": { "text": "Array" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "path", "type": { "text": "IgcTreeItemComponent[]" }, "privacy": "public", "description": "The full path to the tree item, starting from the top-most ancestor.", "readonly": true }, { "kind": "method", "name": "itemClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "expandIndicatorClick", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "selectorClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "onFocus", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "onBlur", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "onFocusIn", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "ev", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "onFocusOut", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "ev", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "labelChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "handleChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "getChildren", "privacy": "public", "return": { "type": { "text": "IgcTreeItemComponent[]" } }, "parameters": [ { "name": "options", "default": "{ flatten: false }", "type": { "text": "{ flatten: boolean }" } } ], "description": "Returns a collection of child items.\nIf the parameter value is true returns all tree item's direct children,\notherwise - only the direct children." }, { "kind": "method", "name": "expandWithEvent", "privacy": "private" }, { "kind": "method", "name": "collapseWithEvent", "privacy": "private" }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Toggles tree item expansion state." }, { "kind": "method", "name": "expand", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Expands the tree item." }, { "kind": "method", "name": "collapse", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Collapses the tree item." } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The tree item label.", "fieldName": "label", "attribute": "label" }, { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "The tree item expansion state.", "fieldName": "expanded", "attribute": "expanded" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Marks the item as the tree's active item.", "fieldName": "active", "attribute": "active" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "The tree item selection state.", "fieldName": "selected", "attribute": "selected" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "To be used for load-on-demand scenarios in order to specify whether the item is loading data.", "fieldName": "loading", "attribute": "loading" }, { "name": "value", "type": { "text": "any" }, "default": "undefined", "description": "The value entry that the tree item is visualizing. Required for searching through items.", "fieldName": "value", "attribute": "value" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tree-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTreeItemComponent", "module": "src/components/tree/tree-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/tree/tree.common.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/tree/tree.ts", "declarations": [ { "kind": "class", "description": "The tree allows users to represent hierarchical data in a tree-view structure,\nmaintaining parent-child relationships, as well as to define static tree-view structure without a corresponding data model.", "name": "IgcTreeComponent", "slots": [ { "description": "Renders the tree items inside default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-tree'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true }, { "kind": "field", "name": "_i18nController", "privacy": "private", "readonly": true }, { "kind": "field", "name": "singleBranchExpand", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether a single or multiple of a parent's child items can be expanded.", "attribute": "single-branch-expand", "reflects": true }, { "kind": "field", "name": "toggleNodeOnClick", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether clicking over nodes will change their expanded state or not.", "attribute": "toggle-node-on-click", "reflects": true }, { "kind": "field", "name": "selection", "type": { "text": "TreeSelection" }, "privacy": "public", "default": "'none'", "description": "The selection state of the tree.", "attribute": "selection", "reflects": true, "expandedType": { "text": "'none' | 'multiple' | 'cascade'" } }, { "kind": "field", "name": "locale", "privacy": "public", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "attribute": "locale" }, { "kind": "field", "name": "resourceStrings", "privacy": "public", "description": "The resource strings for localization.\nCurrently only aria-labels of the default expand/collapse icons are localized for the tree item.", "type": { "text": "ITreeResourceStrings" } }, { "kind": "method", "name": "onDirChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "selectionModeChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "singleBranchExpandChange", "privacy": "protected", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "items", "type": { "text": "Array" }, "privacy": "public", "description": "Returns all of the tree's items.", "readonly": true }, { "kind": "method", "name": "handleKeydown", "privacy": "private", "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "expandToItem", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "IgcTreeItemComponent" } } ] }, { "kind": "method", "name": "select", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "optional": true, "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "Select all items if the items collection is empty. Otherwise, select the items in the items collection." }, { "kind": "method", "name": "deselect", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "optional": true, "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "Deselect all items if the items collection is empty. Otherwise, deselect the items in the items collection." }, { "kind": "method", "name": "expand", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "optional": true, "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "Expands all of the passed items.\nIf no items are passed, expands ALL items." }, { "kind": "method", "name": "collapse", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "items", "optional": true, "type": { "text": "IgcTreeItemComponent[]" } } ], "description": "Collapses all of the passed items.\nIf no items are passed, collapses ALL items." }, { "kind": "field", "name": "selectionService", "default": "new IgcTreeSelectionService(this)" }, { "kind": "field", "name": "navService", "default": "new IgcTreeNavigationService(this, this.selectionService)" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when item selection is changing, before the selection completes.", "name": "igcSelection" }, { "description": "Emitted when tree item is collapsed.", "name": "igcItemCollapsed" }, { "description": "Emitted when tree item is about to collapse.", "name": "igcItemCollapsing" }, { "description": "Emitted when tree item is expanded.", "name": "igcItemExpanded" }, { "description": "Emitted when tree item is about to expand.", "name": "igcItemExpanding" }, { "description": "Emitted when the tree's `active` item changes.", "name": "igcActiveItem" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "single-branch-expand", "type": { "text": "boolean" }, "default": "false", "description": "Whether a single or multiple of a parent's child items can be expanded.", "fieldName": "singleBranchExpand", "attribute": "single-branch-expand" }, { "name": "toggle-node-on-click", "type": { "text": "boolean" }, "default": "false", "description": "Whether clicking over nodes will change their expanded state or not.", "fieldName": "toggleNodeOnClick", "attribute": "toggle-node-on-click" }, { "name": "selection", "type": { "text": "TreeSelection" }, "default": "'none'", "description": "The selection state of the tree.", "fieldName": "selection", "attribute": "selection", "expandedType": { "text": "'none' | 'multiple' | 'cascade'" } }, { "name": "locale", "description": "Gets/Sets the locale used for getting language, affecting resource strings.", "fieldName": "locale", "attribute": "locale" } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-tree", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcTreeComponent", "module": "src/components/tree/tree.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/visually-hidden/visually-hidden.ts", "declarations": [ { "kind": "class", "description": "A utility component that visually hides its content while keeping it\naccessible to screen readers and other assistive technologies.\n\nThe content is only visible when it receives focus, making it ideal for\nskip navigation links and other focus-based accessibility patterns.", "name": "IgcVisuallyHiddenComponent", "slots": [ { "description": "Default slot for the visually hidden content.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-visually-hidden'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-visually-hidden", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcVisuallyHiddenComponent", "module": "src/components/visually-hidden/visually-hidden.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/splitter/types.ts", "declarations": [], "exports": [ { "kind": "js", "name": "PanePosition", "declaration": { "name": "PanePosition", "module": "src/components/splitter/types.ts" } }, { "kind": "js", "name": "SplitterPaneState", "declaration": { "name": "SplitterPaneState", "module": "src/components/splitter/types.ts" } }, { "kind": "js", "name": "PaneResizeSnapshot", "declaration": { "name": "PaneResizeSnapshot", "module": "src/components/splitter/types.ts" } }, { "kind": "js", "name": "SplitterResizeState", "declaration": { "name": "SplitterResizeState", "module": "src/components/splitter/types.ts" } }, { "kind": "js", "name": "IgcSplitterResizeEventArgs", "declaration": { "name": "IgcSplitterResizeEventArgs", "module": "src/components/splitter/types.ts" } }, { "kind": "js", "name": "IgcSplitterResizeEventDetail", "declaration": { "name": "IgcSplitterResizeEventDetail", "module": "src/components/splitter/types.ts" } }, { "kind": "js", "name": "IgcSplitterComponentEventMap", "declaration": { "name": "IgcSplitterComponentEventMap", "module": "src/components/splitter/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/splitter/splitter.ts", "declarations": [ { "kind": "class", "description": "The `igc-splitter` component provides a resizable split-pane layout that divides the view\ninto two panels — *start* and *end* — separated by a draggable bar.\n\nPanels can be resized by dragging the bar, using keyboard shortcuts, or collapsed/expanded\nusing the built-in collapse buttons or the programmatic `toggle()` API.\nNested splitters are supported for more complex layouts.", "name": "IgcSplitterComponent", "cssParts": [ { "description": "The resizable bar element between the two panels.", "name": "splitter-bar" }, { "description": "The drag handle icon/element on the splitter bar.", "name": "drag-handle" }, { "description": "The container for the start panel content.", "name": "start-pane" }, { "description": "The container for the end panel content.", "name": "end-pane" }, { "description": "The button to collapse the start panel.", "name": "start-collapse-btn" }, { "description": "The button to collapse the end panel.", "name": "end-collapse-btn" }, { "description": "The button to expand the start panel when collapsed.", "name": "start-expand-btn" }, { "description": "The button to expand the end panel when collapsed.", "name": "end-expand-btn" } ], "slots": [ { "description": "Content projected into the start (left/top) panel.", "name": "start" }, { "description": "Content projected into the end (right/bottom) panel.", "name": "end" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-splitter'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_separatorRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_startPaneState", "type": { "text": "SplitterPaneState" }, "privacy": "private", "default": "{ size: 'auto', styles: {} }" }, { "kind": "field", "name": "_endPaneState", "type": { "text": "SplitterPaneState" }, "privacy": "private", "default": "{ size: 'auto', styles: {} }" }, { "kind": "field", "name": "_collapsedPane", "type": { "text": "PanePosition | null" }, "privacy": "private", "default": "null", "expandedType": { "text": "'start' | 'end' | null" } }, { "kind": "field", "name": "_resizeState", "type": { "text": "SplitterResizeState" }, "privacy": "private", "default": "{ ...DEFAULT_RESIZE_STATE }" }, { "kind": "field", "name": "_base", "type": { "text": "HTMLElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_startPane", "type": { "text": "HTMLElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_endPane", "type": { "text": "HTMLElement" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_separator", "type": { "text": "HTMLElement | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_resizeDisallowed", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isHorizontal", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_separatorCursor", "type": { "text": "string" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "orientation", "type": { "text": "SplitterOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the splitter, which determines the direction of resizing and collapsing.", "attribute": "orientation", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "disableCollapse", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, prevents the user from collapsing either pane.\nThis also hides the expand/collapse buttons on the splitter bar.", "attribute": "disable-collapse", "reflects": true }, { "kind": "field", "name": "disableResize", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, prevents the user from resizing the panes by dragging the splitter bar or using keyboard shortcuts.\nThis also hides the drag handle on the splitter bar.", "attribute": "disable-resize", "reflects": true }, { "kind": "field", "name": "hideCollapseButtons", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, hides the expand/collapse buttons on the splitter bar.\n\nNote that the buttons will also be hidden if `disable-collapse` is true or\nif a pane is currently collapsed.", "attribute": "hide-collapse-buttons", "reflects": true }, { "kind": "field", "name": "hideDragHandle", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When true, hides the drag handle on the splitter bar.\n\nNote that the drag handle will also be hidden if `disable-resize` is true.", "attribute": "hide-drag-handle", "reflects": true }, { "kind": "field", "name": "startMinSize", "privacy": "public", "description": "The minimum size of the start pane.", "attribute": "start-min-size", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "endMinSize", "privacy": "public", "description": "The minimum size of the end pane.", "attribute": "end-min-size", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "startMaxSize", "privacy": "public", "description": "The maximum size of the start pane.", "attribute": "start-max-size", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "endMaxSize", "privacy": "public", "description": "The maximum size of the end pane.", "attribute": "end-max-size", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "startSize", "privacy": "public", "description": "The size of the start pane.", "attribute": "start-size", "type": { "text": "string | undefined" } }, { "kind": "field", "name": "endSize", "privacy": "public", "description": "The size of the end pane.", "attribute": "end-size", "type": { "text": "string | undefined" } }, { "kind": "method", "name": "_handleBarPointerDown", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_getDragDelta", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleBarPointerMove", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_handleEndDrag", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_endDrag", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "toggle", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "position", "type": { "text": "PanePosition" } } ], "description": "Toggles the collapsed state of the specified pane." }, { "kind": "method", "name": "_savePaneSizes", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_restoreSizesOnExpandCollapse", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_paneRectAsPercent", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "paneIndex", "type": { "text": "0 | 1" } } ], "description": "Measures the actual rendered size of a pane and returns it as a percentage of total size." }, { "kind": "method", "name": "_sizeToPercent", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "sizeValue", "type": { "text": "string" } } ], "description": "Converts a CSS size string (px or %) to a percentage of total size." }, { "kind": "method", "name": "_getStartPaneSizePercent", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "method", "name": "_getMinMaxAsPercent", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "type", "type": { "text": "'min' | 'max'" } } ] }, { "kind": "method", "name": "_isCollapsed", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "which", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_updateBarAria", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getPaneState", "privacy": "private", "return": { "type": { "text": "SplitterPaneState" } }, "parameters": [ { "name": "which", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_isPercentageSize", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "which", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_isAutoSize", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "which", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_normalizeValue", "privacy": "private", "return": { "type": { "text": "string | undefined" } }, "parameters": [ { "name": "value", "type": { "text": "string | undefined" } }, { "name": "fallback", "optional": true, "type": { "text": "'auto'" } } ] }, { "kind": "method", "name": "_getFlex", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "which", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_handleResizePanes", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "direction", "type": { "text": "-1 | 1" } }, { "name": "validOrientation", "type": { "text": "SplitterOrientation" } } ] }, { "kind": "method", "name": "_preventDefaultForEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_resolveDelta", "privacy": "private", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "deltaX", "type": { "text": "number" } }, { "name": "deltaY", "type": { "text": "number" } }, { "name": "direction", "optional": true, "type": { "text": "-1 | 1" } } ] }, { "kind": "method", "name": "_handleMinMaxResize", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "'min' | 'max'" } } ] }, { "kind": "method", "name": "_handleExpanderAction", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_handleArrowsExpandCollapse", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "target", "type": { "text": "PanePosition" } }, { "name": "validOrientation", "type": { "text": "SplitterOrientation" } } ] }, { "kind": "method", "name": "_resizeStart", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_createPaneState", "privacy": "private", "return": { "type": { "text": "PaneResizeSnapshot" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } }, { "name": "size", "type": { "text": "number" } }, { "name": "totalSize", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "_setMinMaxInPx", "privacy": "private", "return": { "type": { "text": "number | undefined" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } }, { "name": "type", "type": { "text": "'min' | 'max'" } }, { "name": "totalSize", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "_resizing", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_computeSize", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "pane", "type": { "text": "PaneResizeSnapshot" } }, { "name": "paneSize", "type": { "text": "number" } }, { "name": "totalSize", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_resizeEnd", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "delta", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_rectSize", "privacy": "private", "return": { "type": { "text": "[number, number]" } } }, { "kind": "method", "name": "_calcNewSizes", "privacy": "private", "return": { "type": { "text": "[number, number]" } }, "parameters": [ { "name": "delta", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_getTotalSize", "privacy": "private", "return": { "type": { "text": "number" } } }, { "kind": "method", "name": "_updatePanes", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_updatePaneStyles", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } }, { "name": "styles", "type": { "text": "StyleInfo" } } ] }, { "kind": "method", "name": "_setPaneMinMaxSizes", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } }, { "name": "minSize", "optional": true, "type": { "text": "string" } }, { "name": "maxSize", "optional": true, "type": { "text": "string" } }, { "name": "totalSize", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "_ensureMinConstraintIsWithinBounds", "privacy": "private", "return": { "type": { "text": "string | undefined" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } }, { "name": "minSize", "optional": true, "type": { "text": "string" } }, { "name": "totalSize", "optional": true, "type": { "text": "number" } } ] }, { "kind": "method", "name": "_handleExpanderClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "pane", "type": { "text": "PanePosition" } }, { "name": "event", "type": { "text": "PointerEvent" } } ] }, { "kind": "method", "name": "_resolvePartNames", "privacy": "private", "return": { "type": { "text": "Record" } }, "parameters": [ { "name": "expander", "type": { "text": "PanePosition" } } ] }, { "kind": "method", "name": "_renderBarControls", "privacy": "private" }, { "kind": "method", "name": "_renderAccessibleLabel", "privacy": "private" }, { "kind": "method", "name": "_renderSeparator", "privacy": "private" }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted once when a resize operation begins (pointer drag or keyboard).", "name": "igcResizeStart" }, { "description": "Emitted continuously while a pane is being resized.", "name": "igcResizing" }, { "description": "Emitted once when a resize operation completes.", "name": "igcResizeEnd" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "orientation", "type": { "text": "SplitterOrientation" }, "default": "'horizontal'", "description": "The orientation of the splitter, which determines the direction of resizing and collapsing.", "fieldName": "orientation", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "disable-collapse", "type": { "text": "boolean" }, "default": "false", "description": "When true, prevents the user from collapsing either pane.\nThis also hides the expand/collapse buttons on the splitter bar.", "fieldName": "disableCollapse", "attribute": "disable-collapse" }, { "name": "disable-resize", "type": { "text": "boolean" }, "default": "false", "description": "When true, prevents the user from resizing the panes by dragging the splitter bar or using keyboard shortcuts.\nThis also hides the drag handle on the splitter bar.", "fieldName": "disableResize", "attribute": "disable-resize" }, { "name": "hide-collapse-buttons", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the expand/collapse buttons on the splitter bar.\n\nNote that the buttons will also be hidden if `disable-collapse` is true or\nif a pane is currently collapsed.", "fieldName": "hideCollapseButtons", "attribute": "hide-collapse-buttons" }, { "name": "hide-drag-handle", "type": { "text": "boolean" }, "default": "false", "description": "When true, hides the drag handle on the splitter bar.\n\nNote that the drag handle will also be hidden if `disable-resize` is true.", "fieldName": "hideDragHandle", "attribute": "hide-drag-handle" }, { "name": "start-min-size", "description": "The minimum size of the start pane.", "fieldName": "startMinSize", "attribute": "start-min-size", "type": { "text": "string | undefined" } }, { "name": "end-min-size", "description": "The minimum size of the end pane.", "fieldName": "endMinSize", "attribute": "end-min-size", "type": { "text": "string | undefined" } }, { "name": "start-max-size", "description": "The maximum size of the start pane.", "fieldName": "startMaxSize", "attribute": "start-max-size", "type": { "text": "string | undefined" } }, { "name": "end-max-size", "description": "The maximum size of the end pane.", "fieldName": "endMaxSize", "attribute": "end-max-size", "type": { "text": "string | undefined" } }, { "name": "start-size", "description": "The size of the start pane.", "fieldName": "startSize", "attribute": "start-size", "type": { "text": "string | undefined" } }, { "name": "end-size", "description": "The size of the end pane.", "fieldName": "endSize", "attribute": "end-size", "type": { "text": "string | undefined" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-splitter", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcSplitterComponent", "module": "src/components/splitter/splitter.ts" } }, { "kind": "js", "name": "IgcSplitterComponentEventMap", "declaration": { "name": "IgcSplitterComponentEventMap", "module": "src/components/splitter/splitter.ts" } }, { "kind": "js", "name": "IgcSplitterResizeEventArgs", "declaration": { "name": "IgcSplitterResizeEventArgs", "module": "src/components/splitter/splitter.ts" } }, { "kind": "js", "name": "IgcSplitterResizeEventDetail", "declaration": { "name": "IgcSplitterResizeEventDetail", "module": "src/components/splitter/splitter.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper/common/animations.ts", "declarations": [ { "kind": "variable", "name": "bodyAnimations", "default": "new Map( Object.entries({ grow: animationPair({ in: growVerIn, out: growVerOut, }), fade: animationPair({ in: noopAnimation, out: noopAnimation, }), slide: animationPair({ in: slideInHor, out: slideOutHor, }), none: animationPair({ in: noopAnimation, out: noopAnimation, }), }) )" }, { "kind": "variable", "name": "contentAnimations", "default": "new Map( Object.entries({ grow: animationPair({ in: fadeIn, out: fadeOut, }), fade: animationPair({ in: fadeIn, out: fadeOut, }), slide: animationPair({ in: fadeIn, out: fadeOut, }), none: animationPair({ in: noopAnimation, out: noopAnimation, }), }) )" } ], "exports": [ { "kind": "js", "name": "bodyAnimations", "declaration": { "name": "bodyAnimations", "module": "src/components/stepper/common/animations.ts" } }, { "kind": "js", "name": "contentAnimations", "declaration": { "name": "contentAnimations", "module": "src/components/stepper/common/animations.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper/step.ts", "declarations": [ { "kind": "class", "description": "A step component used within an `igc-stepper` to represent an individual step in a wizard-like workflow.", "name": "IgcStepComponent", "cssParts": [ { "description": "Wrapper of the step's `header` and its separators.", "name": "header-container" }, { "description": "Indicates a disabled state. Applies to `header-container`.", "name": "disabled" }, { "description": "Indicates a complete state of the current step. Applies to `header-container`.", "name": "complete-start" }, { "description": "Indicates a complete state of the previous step. Applies to `header-container`.", "name": "complete-end" }, { "description": "Indicates an optional state. Applies to `header-container`.", "name": "optional" }, { "description": "Indicates an invalid state. Applies to `header-container`.", "name": "invalid" }, { "description": "Indicates that the title should be above the indicator. Applies to `header-container`.", "name": "top" }, { "description": "Indicates that the title should be below the indicator. Applies to `header-container`.", "name": "bottom" }, { "description": "Indicates that the title should be before the indicator. Applies to `header-container`.", "name": "start" }, { "description": "Indicates that the title should be after the indicator. Applies to `header-container`.", "name": "end" }, { "description": "Wrapper of the step's `indicator` and `text`.", "name": "header" }, { "description": "The indicator of the step.", "name": "indicator" }, { "description": "Wrapper of the step's `title` and `subtitle`.", "name": "text" }, { "description": "Indicates that no title and subtitle have been provided to the step. Applies to `text`.", "name": "empty" }, { "description": "The title of the step.", "name": "title" }, { "description": "The subtitle of the step.", "name": "subtitle" }, { "description": "Wrapper of the step's `content`.", "name": "body" }, { "description": "The step's `content`.", "name": "content" } ], "slots": [ { "description": "Renders the content of the step.", "name": "" }, { "description": "Renders the indicator of the step. By default, it displays the step index + 1.", "name": "indicator" }, { "description": "Renders the title of the step.", "name": "title" }, { "description": "Renders the subtitle of the step.", "name": "subtitle" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-step'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_bodyRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_contentRef", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_bodyPlayer", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_contentPlayer", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stepperContext", "type": { "text": "StepperContext | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_stepper", "type": { "text": "IgcStepperComponent | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_state", "type": { "text": "StepperState | undefined" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isHorizontal", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hasTitle", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_hasSubtitle", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_animation", "type": { "text": "| StepperVerticalAnimation\n | HorizontalTransitionAnimation" }, "privacy": "private", "readonly": true, "expandedType": { "text": "'grow' | 'fade' | 'none' | 'slide' | 'fade' | 'none'" } }, { "kind": "field", "name": "_animationDuration", "type": { "text": "number" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_contentTop", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_index", "type": { "text": "number" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_orientation", "type": { "text": "StepperOrientation" }, "privacy": "private", "readonly": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "_titlePosition", "type": { "text": "StepperTitlePosition" }, "privacy": "private", "readonly": true, "expandedType": { "text": "'auto' | 'bottom' | 'top' | 'end' | 'start'" } }, { "kind": "field", "name": "_stepType", "type": { "text": "StepperStepType" }, "privacy": "private", "readonly": true, "expandedType": { "text": "'full' | 'indicator' | 'title'" } }, { "kind": "field", "name": "_previousComplete", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_visited", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isAccessible", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the step is invalid.\n\nInvalid steps are styled with an error state and are not\ninteractive when the stepper is in linear mode.", "attribute": "invalid", "reflects": true }, { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the step is active.\n\nActive steps are styled with an active state and their content is visible.", "attribute": "active", "reflects": true }, { "kind": "field", "name": "optional", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the step is optional.\n\nOptional steps validity does not affect the default behavior when the stepper is in linear mode i.e.\nif optional step is invalid the user could still move to the next step.", "attribute": "optional", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the step is disabled.\n\nDisabled steps are styled with a disabled state and are not interactive.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "complete", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the step is completed.", "attribute": "complete", "reflects": true }, { "kind": "field", "name": "_headerContainerParts", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_textParts", "privacy": "private", "readonly": true }, { "kind": "method", "name": "_renderIndicator", "privacy": "private" }, { "kind": "method", "name": "_renderTitleAndSubtitle", "privacy": "private" }, { "kind": "method", "name": "_renderHeader", "privacy": "private" }, { "kind": "method", "name": "_renderContent", "privacy": "private" } ], "attributes": [ { "name": "invalid", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is invalid.\n\nInvalid steps are styled with an error state and are not\ninteractive when the stepper is in linear mode.", "fieldName": "invalid", "attribute": "invalid" }, { "name": "active", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is active.\n\nActive steps are styled with an active state and their content is visible.", "fieldName": "active", "attribute": "active" }, { "name": "optional", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is optional.\n\nOptional steps validity does not affect the default behavior when the stepper is in linear mode i.e.\nif optional step is invalid the user could still move to the next step.", "fieldName": "optional", "attribute": "optional" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is disabled.\n\nDisabled steps are styled with a disabled state and are not interactive.", "fieldName": "disabled", "attribute": "disabled" }, { "name": "complete", "type": { "text": "boolean" }, "default": "false", "description": "Whether the step is completed.", "fieldName": "complete", "attribute": "complete" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-step", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcStepComponent", "module": "src/components/stepper/step.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper/common/state.ts", "declarations": [ { "kind": "class", "description": "", "name": "StepperState", "members": [ { "kind": "field", "name": "_state", "privacy": "private", "readonly": true, "default": "new WeakMap()" }, { "kind": "field", "name": "_steps", "type": { "text": "IgcStepComponent[]" }, "privacy": "private", "default": "[]" }, { "kind": "field", "name": "_activeStep", "type": { "text": "IgcStepComponent | undefined" }, "privacy": "private" }, { "kind": "field", "name": "linear", "type": { "text": "boolean" }, "privacy": "public", "default": "false" }, { "kind": "field", "name": "steps", "type": { "text": "readonly IgcStepComponent[]" }, "privacy": "public", "description": "Returns all registered step components.", "readonly": true }, { "kind": "field", "name": "activeStep", "type": { "text": "IgcStepComponent | undefined" }, "privacy": "public", "description": "Returns the currently active step.", "readonly": true }, { "kind": "field", "name": "accessibleSteps", "type": { "text": "IgcStepComponent[]" }, "privacy": "public", "description": "Returns all steps that are currently accessible (not disabled or linear-disabled).", "readonly": true }, { "kind": "method", "name": "set", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } }, { "name": "state", "type": { "text": "Partial" } } ], "description": "Sets the state of a given step component.\n\nIf the step already has an existing state, it merges the new state with the existing one.\nIf the step does not have an existing state, it initializes it with default values and then applies the new state.\n\nAfter updating the state, it requests an update on the step component to reflect the changes in the UI." }, { "kind": "method", "name": "has", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ], "description": "Checks if a given step component has an associated state." }, { "kind": "method", "name": "get", "privacy": "public", "return": { "type": { "text": "StepState | undefined" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ], "description": "Retrieves the state of a given step component." }, { "kind": "method", "name": "delete", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ], "description": "Deletes the state of a given step component." }, { "kind": "method", "name": "isAccessible", "privacy": "public", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ], "description": "Determines if a given step component is accessible based on its `disabled` state\nand the `linearDisabled` state from the stepper state management." }, { "kind": "method", "name": "setSteps", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "steps", "type": { "text": "IgcStepComponent[]" } } ], "description": "Updates the registered steps collection." }, { "kind": "method", "name": "changeActiveStep", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ], "description": "Changes the active step, deactivating the previous one and marking the new one as visited." }, { "kind": "method", "name": "activateFirstStep", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Activates the first non-disabled step." }, { "kind": "method", "name": "getAdjacentStep", "privacy": "public", "return": { "type": { "text": "IgcStepComponent | undefined" } }, "parameters": [ { "name": "next", "default": "true" } ], "description": "Returns the next or previous accessible step relative to the active step." }, { "kind": "method", "name": "syncState", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Synchronizes the `active` and `previousCompleted` state across all steps." }, { "kind": "method", "name": "setVisitedState", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "value", "type": { "text": "boolean" } } ], "description": "Sets the visited state for all steps based on the current active step and the linear mode." }, { "kind": "method", "name": "setLinearState", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Computes and applies the linear-disabled state for all steps." }, { "kind": "method", "name": "onStepPropertyChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } }, { "name": "changed", "type": { "text": "PropertyValues" } } ], "description": "Handles step property changes, updating active step tracking and re-syncing state." }, { "kind": "method", "name": "stepsChanged", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Processes a change in the steps collection, resolving the active step and syncing state." }, { "kind": "method", "name": "reset", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Resets all step states and activates the first step." } ] }, { "kind": "function", "name": "createStepperState", "return": { "type": { "text": "StepperState" } }, "description": "Creates a new instance of the StepperState class, which manages the state of steps in a stepper component." } ], "exports": [ { "kind": "js", "name": "createStepperState", "declaration": { "name": "createStepperState", "module": "src/components/stepper/common/state.ts" } }, { "kind": "js", "name": "StepperState", "declaration": { "name": "StepperState", "module": "src/components/stepper/common/state.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper/common/context.ts", "declarations": [ { "kind": "variable", "name": "STEPPER_CONTEXT" } ], "exports": [ { "kind": "js", "name": "STEPPER_CONTEXT", "declaration": { "name": "STEPPER_CONTEXT", "module": "src/components/stepper/common/context.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/stepper/common/types.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/stepper/stepper.ts", "declarations": [ { "kind": "class", "description": "A stepper component that provides a wizard-like workflow by dividing content into logical steps.", "name": "IgcStepperComponent", "slots": [ { "description": "Renders `igc-step` components inside the default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-stepper'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_state", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_contextProvider", "privacy": "private", "readonly": true, "default": "new ContextProvider(this, { context: STEPPER_CONTEXT, initialValue: { stepper: this, state: this._state, }, })" }, { "kind": "field", "name": "_internals", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_slots", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_isHorizontal", "type": { "text": "boolean" }, "privacy": "private", "readonly": true }, { "kind": "field", "name": "steps", "type": { "text": "readonly IgcStepComponent[]" }, "privacy": "public", "description": "Returns all of the stepper's steps.", "readonly": true }, { "kind": "field", "name": "orientation", "type": { "text": "StepperOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "The orientation of the stepper.", "attribute": "orientation", "reflects": true, "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "kind": "field", "name": "stepType", "type": { "text": "StepperStepType" }, "privacy": "public", "default": "'full'", "description": "The visual type of the steps.", "attribute": "step-type", "reflects": true, "expandedType": { "text": "'full' | 'indicator' | 'title'" } }, { "kind": "field", "name": "linear", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the stepper is linear.", "attribute": "linear", "reflects": true }, { "kind": "field", "name": "contentTop", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether the content is displayed above the steps.", "attribute": "content-top", "reflects": true }, { "kind": "field", "name": "verticalAnimation", "type": { "text": "StepperVerticalAnimation" }, "privacy": "public", "default": "'grow'", "description": "The animation type when in vertical mode.", "attribute": "vertical-animation", "expandedType": { "text": "'grow' | 'fade' | 'none'" } }, { "kind": "field", "name": "horizontalAnimation", "type": { "text": "HorizontalTransitionAnimation" }, "privacy": "public", "default": "'slide'", "description": "The animation type when in horizontal mode.", "attribute": "horizontal-animation", "expandedType": { "text": "'slide' | 'fade' | 'none'" } }, { "kind": "field", "name": "animationDuration", "type": { "text": "number" }, "privacy": "public", "default": "320", "description": "The animation duration in either vertical or horizontal mode in milliseconds.", "attribute": "animation-duration" }, { "kind": "field", "name": "titlePosition", "type": { "text": "StepperTitlePosition" }, "privacy": "public", "default": "'auto'", "description": "The position of the steps title.", "attribute": "title-position", "expandedType": { "text": "'auto' | 'bottom' | 'top' | 'end' | 'start'" } }, { "kind": "method", "name": "_skipKeyboard", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "_", "type": { "text": "Element" } }, { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_handleHomeKey", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleEndKey", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleArrowDown", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleArrowUp", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleArrowLeft", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleArrowRight", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_handleInteraction", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "method", "name": "_handleSlotChange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_syncStepperAttributes", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "properties", "type": { "text": "PropertyValues" } } ] }, { "kind": "method", "name": "_animateSteps", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "nextStep", "type": { "text": "IgcStepComponent" } }, { "name": "currentStep", "type": { "text": "IgcStepComponent" } } ] }, { "kind": "method", "name": "_emitChanging", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "args", "type": { "text": "IgcActiveStepChangingEventArgs" } } ] }, { "kind": "method", "name": "_emitChanged", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "args", "type": { "text": "IgcActiveStepChangedEventArgs" } } ] }, { "kind": "method", "name": "_activateStep", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } }, { "name": "shouldEmit", "default": "true" } ] }, { "kind": "method", "name": "_moveToNextStep", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "next", "default": "true" } ] }, { "kind": "method", "name": "_getNextStep", "privacy": "private", "return": { "type": { "text": "IgcStepComponent" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ] }, { "kind": "method", "name": "_getPreviousStep", "privacy": "private", "return": { "type": { "text": "IgcStepComponent" } }, "parameters": [ { "name": "step", "type": { "text": "IgcStepComponent" } } ] }, { "kind": "method", "name": "_getActiveStepComponent", "privacy": "private", "return": { "type": { "text": "IgcStepComponent | null" } } }, { "kind": "method", "name": "_getStepHeader", "privacy": "private", "return": { "type": { "text": "HTMLElement | null" } }, "parameters": [ { "name": "step", "optional": true, "type": { "text": "IgcStepComponent" } } ] }, { "kind": "method", "name": "navigateTo", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ], "description": "Activates the step at a given index." }, { "kind": "method", "name": "next", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Activates the next enabled step." }, { "kind": "method", "name": "prev", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Activates the previous enabled step." }, { "kind": "method", "name": "reset", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Resets the stepper to its initial state i.e. activates the first step." }, { "kind": "method", "name": "addEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | AddEventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "removeEventListener", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "listener", "type": { "text": "(this: HTMLElement, ev: M[K]) => any" } }, { "name": "options", "optional": true, "type": { "text": "boolean | EventListenerOptions" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } }, { "kind": "method", "name": "emitEvent", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "K" } }, { "name": "eventInitDict", "optional": true, "type": { "text": "CustomEventInit" } } ], "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "events": [ { "description": "Emitted when the active step is about to change. Cancelable.", "name": "igcActiveStepChanging" }, { "description": "Emitted after the active step has changed.", "name": "igcActiveStepChanged" }, { "type": { "text": "CustomEvent" }, "inheritedFrom": { "name": "EventEmitterMixin", "module": "src/components/common/mixins/event-emitter.ts" } } ], "attributes": [ { "name": "orientation", "type": { "text": "StepperOrientation" }, "default": "'horizontal'", "description": "The orientation of the stepper.", "fieldName": "orientation", "attribute": "orientation", "expandedType": { "text": "'horizontal' | 'vertical'" } }, { "name": "step-type", "type": { "text": "StepperStepType" }, "default": "'full'", "description": "The visual type of the steps.", "fieldName": "stepType", "attribute": "step-type", "expandedType": { "text": "'full' | 'indicator' | 'title'" } }, { "name": "linear", "type": { "text": "boolean" }, "default": "false", "description": "Whether the stepper is linear.", "fieldName": "linear", "attribute": "linear" }, { "name": "content-top", "type": { "text": "boolean" }, "default": "false", "description": "Whether the content is displayed above the steps.", "fieldName": "contentTop", "attribute": "content-top" }, { "name": "vertical-animation", "type": { "text": "StepperVerticalAnimation" }, "default": "'grow'", "description": "The animation type when in vertical mode.", "fieldName": "verticalAnimation", "attribute": "vertical-animation", "expandedType": { "text": "'grow' | 'fade' | 'none'" } }, { "name": "horizontal-animation", "type": { "text": "HorizontalTransitionAnimation" }, "default": "'slide'", "description": "The animation type when in horizontal mode.", "fieldName": "horizontalAnimation", "attribute": "horizontal-animation", "expandedType": { "text": "'slide' | 'fade' | 'none'" } }, { "name": "animation-duration", "type": { "text": "number" }, "default": "320", "description": "The animation duration in either vertical or horizontal mode in milliseconds.", "fieldName": "animationDuration", "attribute": "animation-duration" }, { "name": "title-position", "type": { "text": "StepperTitlePosition" }, "default": "'auto'", "description": "The position of the steps title.", "fieldName": "titlePosition", "attribute": "title-position", "expandedType": { "text": "'auto' | 'bottom' | 'top' | 'end' | 'start'" } } ], "mixins": [ { "name": "EventEmitterMixin", "module": "/src/components/common/mixins/event-emitter.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-stepper", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcStepperComponent", "module": "src/components/stepper/stepper.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/highlight/service.ts", "declarations": [ { "kind": "function", "name": "createHighlightController", "return": { "type": { "text": "HighlightService" } }, "parameters": [ { "name": "host", "type": { "text": "IgcHighlightComponent" } } ] } ], "exports": [ { "kind": "js", "name": "createHighlightController", "declaration": { "name": "createHighlightController", "module": "src/components/highlight/service.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/highlight/highlight.ts", "declarations": [ { "kind": "class", "description": "The highlight component provides efficient searching and highlighting of text\nprojected into it via its default slot. It uses the native CSS Custom Highlight API\nto apply highlight styles to matched text nodes without modifying the DOM.\n\nThe component supports case-sensitive matching, programmatic navigation between\nmatches, and automatic scroll-into-view of the active match.", "name": "IgcHighlightComponent", "cssProperties": [ { "description": "The text color for a highlighted text node.", "name": "--foreground" }, { "description": "The background color for a highlighted text node.", "name": "--background" }, { "description": "The text color for the active highlighted text node.", "name": "--foreground-active" }, { "description": "The background color for the active highlighted text node.", "name": "--background-active" } ], "slots": [ { "description": "The default slot. Place the text content you want to search and highlight here.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-highlight'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_service", "privacy": "private", "readonly": true }, { "kind": "field", "name": "_caseSensitive", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_searchText", "type": { "text": "string" }, "privacy": "private", "default": "''" }, { "kind": "field", "name": "caseSensitive", "privacy": "public", "description": "Whether to match the searched text with case sensitivity in mind.\nWhen `true`, only exact-case occurrences of `searchText` are highlighted.", "default": "false", "attribute": "case-sensitive", "type": { "text": "boolean" }, "reflects": true }, { "kind": "field", "name": "searchText", "privacy": "public", "description": "The string to search and highlight in the DOM content of the component.\nSetting this property triggers a new search automatically.\nAn empty string clears all highlights.", "attribute": "search-text", "type": { "text": "string" } }, { "kind": "field", "name": "size", "type": { "text": "number" }, "privacy": "public", "description": "The total number of matches found for the current `searchText`. Returns `0` when there are no matches or `searchText` is empty.", "readonly": true }, { "kind": "field", "name": "current", "type": { "text": "number" }, "privacy": "public", "description": "The zero-based index of the currently active (focused) match. Returns `0` when there are no matches.", "readonly": true }, { "kind": "method", "name": "_addStylesheet", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "next", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "HighlightNavigation" }, "description": "Optional navigation options (e.g. `preventScroll`)." } ], "description": "Moves the active highlight to the next match.\nWraps around to the first match after the last one." }, { "kind": "method", "name": "previous", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "HighlightNavigation" }, "description": "Optional navigation options (e.g. `preventScroll`)." } ], "description": "Moves the active highlight to the previous match.\nWraps around to the last match when going back from the first one." }, { "kind": "method", "name": "setActive", "privacy": "public", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "index", "type": { "text": "number" }, "description": "The zero-based index of the match to activate." }, { "name": "options", "optional": true, "type": { "text": "HighlightNavigation" }, "description": "Optional navigation options (e.g. `preventScroll`)." } ], "description": "Moves the active highlight to the match at the specified zero-based index." }, { "kind": "method", "name": "search", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Re-runs the highlight search based on the current `searchText` and `caseSensitive` values.\n\nCall this method after the slotted content changes dynamically (e.g. after lazy loading\nor programmatic DOM mutations) to ensure all matches are up to date." } ], "attributes": [ { "name": "case-sensitive", "description": "Whether to match the searched text with case sensitivity in mind.\nWhen `true`, only exact-case occurrences of `searchText` are highlighted.", "default": "false", "fieldName": "caseSensitive", "attribute": "case-sensitive", "type": { "text": "boolean" } }, { "name": "search-text", "description": "The string to search and highlight in the DOM content of the component.\nSetting this property triggers a new search automatically.\nAn empty string clears all highlights.", "fieldName": "searchText", "attribute": "search-text", "type": { "text": "string" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-highlight", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcHighlightComponent", "module": "src/components/highlight/highlight.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/theme-provider/theme-provider.ts", "declarations": [ { "kind": "class", "description": "A theme provider component that uses Lit context to provide theme information\nto descendant components.\n\nThis component allows you to scope a theme to a specific part of the page.\nAll library components within this provider will use the specified theme\ninstead of the global theme.", "name": "IgcThemeProviderComponent", "slots": [ { "description": "Default slot for content that should receive the provided theme.", "name": "" } ], "members": [ { "kind": "field", "name": "tagName", "type": { "text": "string" }, "privacy": "public", "static": true, "readonly": true, "default": "'igc-theme-provider'" }, { "kind": "method", "name": "register", "privacy": "public", "static": true, "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_provider", "privacy": "private", "readonly": true, "default": "new ContextProvider(this, { context: themeContext, })" }, { "kind": "field", "name": "theme", "type": { "text": "Theme" }, "privacy": "public", "default": "'bootstrap'", "description": "The theme to provide to descendant components.", "attribute": "theme", "reflects": true, "expandedType": { "text": "'material' | 'bootstrap' | 'indigo' | 'fluent'" } }, { "kind": "field", "name": "variant", "type": { "text": "ThemeVariant" }, "privacy": "public", "default": "'light'", "description": "The theme variant to provide to descendant components.", "attribute": "variant", "reflects": true, "expandedType": { "text": "'light' | 'dark'" } }, { "kind": "method", "name": "_getContextValue", "privacy": "private", "return": { "type": { "text": "ThemeContext" } } } ], "attributes": [ { "name": "theme", "type": { "text": "Theme" }, "default": "'bootstrap'", "description": "The theme to provide to descendant components.", "fieldName": "theme", "attribute": "theme", "expandedType": { "text": "'material' | 'bootstrap' | 'indigo' | 'fluent'" } }, { "name": "variant", "type": { "text": "ThemeVariant" }, "default": "'light'", "description": "The theme variant to provide to descendant components.", "fieldName": "variant", "attribute": "variant", "expandedType": { "text": "'light' | 'dark'" } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "igc-theme-provider", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "IgcThemeProviderComponent", "module": "src/components/theme-provider/theme-provider.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/definitions/defineComponents.ts", "declarations": [ { "kind": "function", "name": "defineComponents", "parameters": [ { "name": "components", "type": { "text": "IgniteComponent[]" } } ] } ], "exports": [ { "kind": "js", "name": "defineComponents", "declaration": { "name": "defineComponents", "module": "src/components/common/definitions/defineComponents.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/common/definitions/defineAllComponents.ts", "declarations": [ { "kind": "function", "name": "defineAllComponents" } ], "exports": [ { "kind": "js", "name": "defineAllComponents", "declaration": { "name": "defineAllComponents", "module": "src/components/common/definitions/defineAllComponents.ts" } } ] }, { "kind": "javascript-module", "path": "src/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "IgcAvatarComponent", "declaration": { "name": "default", "module": "./components/avatar/avatar.js" } }, { "kind": "js", "name": "IgcAccordionComponent", "declaration": { "name": "default", "module": "./components/accordion/accordion.js" } }, { "kind": "js", "name": "IgcBadgeComponent", "declaration": { "name": "default", "module": "./components/badge/badge.js" } }, { "kind": "js", "name": "IgcBannerComponent", "declaration": { "name": "default", "module": "./components/banner/banner.js" } }, { "kind": "js", "name": "IgcButtonComponent", "declaration": { "name": "default", "module": "./components/button/button.js" } }, { "kind": "js", "name": "IgcButtonGroupComponent", "declaration": { "name": "default", "module": "./components/button-group/button-group.js" } }, { "kind": "js", "name": "IgcCalendarComponent", "declaration": { "name": "default", "module": "./components/calendar/calendar.js" } }, { "kind": "js", "name": "IgcCardComponent", "declaration": { "name": "default", "module": "./components/card/card.js" } }, { "kind": "js", "name": "IgcCardActionsComponent", "declaration": { "name": "default", "module": "./components/card/card.actions.js" } }, { "kind": "js", "name": "IgcCardContentComponent", "declaration": { "name": "default", "module": "./components/card/card.content.js" } }, { "kind": "js", "name": "IgcCardHeaderComponent", "declaration": { "name": "default", "module": "./components/card/card.header.js" } }, { "kind": "js", "name": "IgcCardMediaComponent", "declaration": { "name": "default", "module": "./components/card/card.media.js" } }, { "kind": "js", "name": "IgcCarouselComponent", "declaration": { "name": "default", "module": "./components/carousel/carousel.js" } }, { "kind": "js", "name": "IgcCarouselIndicatorComponent", "declaration": { "name": "default", "module": "./components/carousel/carousel-indicator.js" } }, { "kind": "js", "name": "IgcCarouselSlideComponent", "declaration": { "name": "default", "module": "./components/carousel/carousel-slide.js" } }, { "kind": "js", "name": "IgcChatComponent", "declaration": { "name": "default", "module": "./components/chat/chat.js" } }, { "kind": "js", "name": "IgcCheckboxComponent", "declaration": { "name": "default", "module": "./components/checkbox/checkbox.js" } }, { "kind": "js", "name": "IgcCircularProgressComponent", "declaration": { "name": "default", "module": "./components/progress/circular-progress.js" } }, { "kind": "js", "name": "IgcCircularGradientComponent", "declaration": { "name": "default", "module": "./components/progress/circular-gradient.js" } }, { "kind": "js", "name": "IgcChipComponent", "declaration": { "name": "default", "module": "./components/chip/chip.js" } }, { "kind": "js", "name": "IgcComboComponent", "declaration": { "name": "default", "module": "./components/combo/combo.js" } }, { "kind": "js", "name": "IgcDatePickerComponent", "declaration": { "name": "default", "module": "./components/date-picker/date-picker.js" } }, { "kind": "js", "name": "IgcDateRangePickerComponent", "declaration": { "name": "default", "module": "./components/date-range-picker/date-range-picker.js" } }, { "kind": "js", "name": "IgcDateTimeInputComponent", "declaration": { "name": "default", "module": "./components/date-time-input/date-time-input.js" } }, { "kind": "js", "name": "IgcDialogComponent", "declaration": { "name": "default", "module": "./components/dialog/dialog.js" } }, { "kind": "js", "name": "IgcDividerComponent", "declaration": { "name": "default", "module": "./components/divider/divider.js" } }, { "kind": "js", "name": "IgcDropdownComponent", "declaration": { "name": "default", "module": "./components/dropdown/dropdown.js" } }, { "kind": "js", "name": "IgcDropdownGroupComponent", "declaration": { "name": "default", "module": "./components/dropdown/dropdown-group.js" } }, { "kind": "js", "name": "IgcDropdownHeaderComponent", "declaration": { "name": "default", "module": "./components/dropdown/dropdown-header.js" } }, { "kind": "js", "name": "IgcDropdownItemComponent", "declaration": { "name": "default", "module": "./components/dropdown/dropdown-item.js" } }, { "kind": "js", "name": "IgcFileInputComponent", "declaration": { "name": "default", "module": "./components/file-input/file-input.js" } }, { "kind": "js", "name": "IgcSelectComponent", "declaration": { "name": "default", "module": "./components/select/select.js" } }, { "kind": "js", "name": "IgcSelectGroupComponent", "declaration": { "name": "default", "module": "./components/select/select-group.js" } }, { "kind": "js", "name": "IgcSelectHeaderComponent", "declaration": { "name": "default", "module": "./components/select/select-header.js" } }, { "kind": "js", "name": "IgcSelectItemComponent", "declaration": { "name": "default", "module": "./components/select/select-item.js" } }, { "kind": "js", "name": "IgcExpansionPanelComponent", "declaration": { "name": "default", "module": "./components/expansion-panel/expansion-panel.js" } }, { "kind": "js", "name": "IgcIconComponent", "declaration": { "name": "default", "module": "./components/icon/icon.js" } }, { "kind": "js", "name": "IgcIconButtonComponent", "declaration": { "name": "default", "module": "./components/button/icon-button.js" } }, { "kind": "js", "name": "IgcInputComponent", "declaration": { "name": "default", "module": "./components/input/input.js" } }, { "kind": "js", "name": "IgcLinearProgressComponent", "declaration": { "name": "default", "module": "./components/progress/linear-progress.js" } }, { "kind": "js", "name": "IgcListComponent", "declaration": { "name": "default", "module": "./components/list/list.js" } }, { "kind": "js", "name": "IgcListHeaderComponent", "declaration": { "name": "default", "module": "./components/list/list-header.js" } }, { "kind": "js", "name": "IgcListItemComponent", "declaration": { "name": "default", "module": "./components/list/list-item.js" } }, { "kind": "js", "name": "IgcMaskInputComponent", "declaration": { "name": "default", "module": "./components/mask-input/mask-input.js" } }, { "kind": "js", "name": "IgcNavDrawerComponent", "declaration": { "name": "default", "module": "./components/nav-drawer/nav-drawer.js" } }, { "kind": "js", "name": "IgcNavDrawerHeaderItemComponent", "declaration": { "name": "default", "module": "./components/nav-drawer/nav-drawer-header-item.js" } }, { "kind": "js", "name": "IgcNavDrawerItemComponent", "declaration": { "name": "default", "module": "./components/nav-drawer/nav-drawer-item.js" } }, { "kind": "js", "name": "IgcNavbarComponent", "declaration": { "name": "default", "module": "./components/navbar/navbar.js" } }, { "kind": "js", "name": "IgcRadioGroupComponent", "declaration": { "name": "default", "module": "./components/radio-group/radio-group.js" } }, { "kind": "js", "name": "IgcRadioComponent", "declaration": { "name": "default", "module": "./components/radio/radio.js" } }, { "kind": "js", "name": "IgcRatingComponent", "declaration": { "name": "default", "module": "./components/rating/rating.js" } }, { "kind": "js", "name": "IgcRatingSymbolComponent", "declaration": { "name": "default", "module": "./components/rating/rating-symbol.js" } }, { "kind": "js", "name": "IgcRippleComponent", "declaration": { "name": "default", "module": "./components/ripple/ripple.js" } }, { "kind": "js", "name": "IgcRangeSliderComponent", "declaration": { "name": "default", "module": "./components/slider/range-slider.js" } }, { "kind": "js", "name": "IgcSnackbarComponent", "declaration": { "name": "default", "module": "./components/snackbar/snackbar.js" } }, { "kind": "js", "name": "IgcSliderComponent", "declaration": { "name": "default", "module": "./components/slider/slider.js" } }, { "kind": "js", "name": "IgcSliderLabelComponent", "declaration": { "name": "default", "module": "./components/slider/slider-label.js" } }, { "kind": "js", "name": "IgcTabsComponent", "declaration": { "name": "default", "module": "./components/tabs/tabs.js" } }, { "kind": "js", "name": "IgcTabComponent", "declaration": { "name": "default", "module": "./components/tabs/tab.js" } }, { "kind": "js", "name": "IgcTileComponent", "declaration": { "name": "default", "module": "./components/tile-manager/tile.js" } }, { "kind": "js", "name": "IgcTileManagerComponent", "declaration": { "name": "default", "module": "./components/tile-manager/tile-manager.js" } }, { "kind": "js", "name": "IgcToastComponent", "declaration": { "name": "default", "module": "./components/toast/toast.js" } }, { "kind": "js", "name": "IgcToggleButtonComponent", "declaration": { "name": "default", "module": "./components/button-group/toggle-button.js" } }, { "kind": "js", "name": "IgcSwitchComponent", "declaration": { "name": "default", "module": "./components/checkbox/switch.js" } }, { "kind": "js", "name": "IgcTextareaComponent", "declaration": { "name": "default", "module": "./components/textarea/textarea.js" } }, { "kind": "js", "name": "IgcTreeComponent", "declaration": { "name": "default", "module": "./components/tree/tree.js" } }, { "kind": "js", "name": "IgcTreeItemComponent", "declaration": { "name": "default", "module": "./components/tree/tree-item.js" } }, { "kind": "js", "name": "IgcSplitterComponent", "declaration": { "name": "default", "module": "./components/splitter/splitter.js" } }, { "kind": "js", "name": "IgcStepperComponent", "declaration": { "name": "default", "module": "./components/stepper/stepper.js" } }, { "kind": "js", "name": "IgcStepComponent", "declaration": { "name": "default", "module": "./components/stepper/step.js" } }, { "kind": "js", "name": "IgcHighlightComponent", "declaration": { "name": "default", "module": "./components/highlight/highlight.js" } }, { "kind": "js", "name": "IgcTooltipComponent", "declaration": { "name": "default", "module": "./components/tooltip/tooltip.js" } }, { "kind": "js", "name": "IgcThemeProviderComponent", "declaration": { "name": "default", "module": "./components/theme-provider/theme-provider.js" } }, { "kind": "js", "name": "defineComponents", "declaration": { "name": "defineComponents", "module": "./components/common/definitions/defineComponents.js" } }, { "kind": "js", "name": "defineAllComponents", "declaration": { "name": "defineAllComponents", "module": "./components/common/definitions/defineAllComponents.js" } }, { "kind": "js", "name": "registerIcon", "declaration": { "name": "registerIcon", "module": "./components/icon/icon.registry.js" } }, { "kind": "js", "name": "registerIconFromText", "declaration": { "name": "registerIconFromText", "module": "./components/icon/icon.registry.js" } }, { "kind": "js", "name": "setIconRef", "declaration": { "name": "setIconRef", "module": "./components/icon/icon.registry.js" } }, { "kind": "js", "name": "configureTheme", "declaration": { "name": "configureTheme", "module": "./theming/config.js" } }, { "kind": "js", "name": "Theme", "declaration": { "name": "Theme", "module": "./theming/types.js" } }, { "kind": "js", "name": "ThemeVariant", "declaration": { "name": "ThemeVariant", "module": "./theming/types.js" } }, { "kind": "js", "name": "θaddThemingController", "declaration": { "name": "addThemingController", "module": "./theming/theming-controller.js" } }, { "kind": "js", "name": "θaddAdoptedStylesController", "declaration": { "name": "addAdoptedStylesController", "module": "./components/common/controllers/adopt-styles.js" } }, { "kind": "js", "name": "IgcCalendarResourceStringEN", "declaration": { "name": "IgcCalendarResourceStringEN", "module": "./components/common/i18n/EN/calendar.resources.js" } }, { "kind": "js", "name": "IgcCalendarResourceStrings", "declaration": { "name": "IgcCalendarResourceStrings", "module": "./components/common/i18n/EN/calendar.resources.js" } }, { "kind": "js", "name": "IgcDateRangePickerResourceStringsEN", "declaration": { "name": "IgcDateRangePickerResourceStringsEN", "module": "./components/common/i18n/EN/date-range-picker.resources.js" } }, { "kind": "js", "name": "IgcDateRangePickerResourceStrings", "declaration": { "name": "IgcDateRangePickerResourceStrings", "module": "./components/common/i18n/EN/date-range-picker.resources.js" } }, { "kind": "js", "name": "IgcChatResourceStringEN", "declaration": { "name": "IgcChatResourceStringEN", "module": "./components/common/i18n/EN/chat.resources.js" } }, { "kind": "js", "name": "IgcChatResourceStrings", "declaration": { "name": "IgcChatResourceStrings", "module": "./components/common/i18n/EN/chat.resources.js" } }, { "kind": "js", "name": "ICalendarResourceStrings", "declaration": { "name": "ICalendarResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "ICarouselResourceStrings", "declaration": { "name": "ICarouselResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "IChipResourceStrings", "declaration": { "name": "IChipResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "IComboResourceStrings", "declaration": { "name": "IComboResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "IDateRangePickerResourceStrings", "declaration": { "name": "IDateRangePickerResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "IFileInputResourceStrings", "declaration": { "name": "IFileInputResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "ITreeResourceStrings", "declaration": { "name": "ITreeResourceStrings", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "CalendarResourceStringsEN", "declaration": { "name": "CalendarResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "CarouselResourceStringsEN", "declaration": { "name": "CarouselResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "ChipResourceStringsEN", "declaration": { "name": "ChipResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "ComboResourceStringsEN", "declaration": { "name": "ComboResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "DateRangePickerResourceStringsEN", "declaration": { "name": "DateRangePickerResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "FileInputResourceStringsEN", "declaration": { "name": "FileInputResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "TreeResourceStringsEN", "declaration": { "name": "TreeResourceStringsEN", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "registerI18n", "declaration": { "name": "registerI18n", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "setCurrentI18n", "declaration": { "name": "setCurrentI18n", "package": "igniteui-i18n-core" } }, { "kind": "js", "name": "IgcBannerComponentEventMap", "declaration": { "name": "IgcBannerComponentEventMap", "module": "./components/banner/banner.js" } }, { "kind": "js", "name": "IgcButtonGroupComponentEventMap", "declaration": { "name": "IgcButtonGroupComponentEventMap", "module": "./components/button-group/button-group.js" } }, { "kind": "js", "name": "IgcCalendarComponentEventMap", "declaration": { "name": "IgcCalendarComponentEventMap", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "IgcCarouselComponentEventMap", "declaration": { "name": "IgcCarouselComponentEventMap", "module": "./components/carousel/carousel.js" } }, { "kind": "js", "name": "IgcChatComponentEventMap", "declaration": { "name": "IgcChatComponentEventMap", "module": "./components/chat/chat.js" } }, { "kind": "js", "name": "IgcCheckboxComponentEventMap", "declaration": { "name": "IgcCheckboxComponentEventMap", "module": "./components/checkbox/checkbox-base.js" } }, { "kind": "js", "name": "IgcSwitchComponentEventMap", "declaration": { "name": "IgcCheckboxComponentEventMap", "module": "./components/checkbox/checkbox-base.js" } }, { "kind": "js", "name": "IgcChipComponentEventMap", "declaration": { "name": "IgcChipComponentEventMap", "module": "./components/chip/chip.js" } }, { "kind": "js", "name": "IgcComboComponentEventMap", "declaration": { "name": "IgcComboComponentEventMap", "module": "./components/combo/types.js" } }, { "kind": "js", "name": "IgcDatePickerComponentEventMap", "declaration": { "name": "IgcDatePickerComponentEventMap", "module": "./components/date-picker/date-picker.js" } }, { "kind": "js", "name": "IgcDateRangePickerComponentEventMap", "declaration": { "name": "IgcDateRangePickerComponentEventMap", "module": "./components/date-range-picker/date-range-picker.js" } }, { "kind": "js", "name": "IgcDateTimeInputComponentEventMap", "declaration": { "name": "IgcDateTimeInputComponentEventMap", "module": "./components/date-time-input/date-time-input.js" } }, { "kind": "js", "name": "IgcDialogComponentEventMap", "declaration": { "name": "IgcDialogComponentEventMap", "module": "./components/dialog/dialog.js" } }, { "kind": "js", "name": "IgcDropdownComponentEventMap", "declaration": { "name": "IgcDropdownComponentEventMap", "module": "./components/dropdown/dropdown.js" } }, { "kind": "js", "name": "IgcExpansionPanelComponentEventMap", "declaration": { "name": "IgcExpansionPanelComponentEventMap", "module": "./components/expansion-panel/expansion-panel.js" } }, { "kind": "js", "name": "IgcInputComponentEventMap", "declaration": { "name": "IgcInputComponentEventMap", "module": "./components/input/input-base.js" } }, { "kind": "js", "name": "IgcMaskInputComponentEventMap", "declaration": { "name": "IgcInputComponentEventMap", "module": "./components/input/input-base.js" } }, { "kind": "js", "name": "IgcFileInputComponentEventMap", "declaration": { "name": "IgcFileInputComponentEventMap", "module": "./components/file-input/file-input.js" } }, { "kind": "js", "name": "IgcRadioComponentEventMap", "declaration": { "name": "IgcRadioComponentEventMap", "module": "./components/radio/radio.js" } }, { "kind": "js", "name": "IgcRatingComponentEventMap", "declaration": { "name": "IgcRatingComponentEventMap", "module": "./components/rating/rating.js" } }, { "kind": "js", "name": "IgcSelectComponentEventMap", "declaration": { "name": "IgcSelectComponentEventMap", "module": "./components/select/select.js" } }, { "kind": "js", "name": "IgcSliderComponentEventMap", "declaration": { "name": "IgcSliderComponentEventMap", "module": "./components/slider/slider.js" } }, { "kind": "js", "name": "IgcRangeSliderComponentEventMap", "declaration": { "name": "IgcRangeSliderComponentEventMap", "module": "./components/slider/range-slider.js" } }, { "kind": "js", "name": "IgcSnackbarComponentEventMap", "declaration": { "name": "IgcSnackbarComponentEventMap", "module": "./components/snackbar/snackbar.js" } }, { "kind": "js", "name": "IgcSplitterComponentEventMap", "declaration": { "name": "IgcSplitterComponentEventMap", "module": "./components/splitter/splitter.js" } }, { "kind": "js", "name": "IgcStepperComponentEventMap", "declaration": { "name": "IgcStepperComponentEventMap", "module": "./components/stepper/common/types.js" } }, { "kind": "js", "name": "IgcTabsComponentEventMap", "declaration": { "name": "IgcTabsComponentEventMap", "module": "./components/tabs/tabs.js" } }, { "kind": "js", "name": "IgcTextareaComponentEventMap", "declaration": { "name": "IgcTextareaComponentEventMap", "module": "./components/textarea/textarea.js" } }, { "kind": "js", "name": "IgcTileComponentEventMap", "declaration": { "name": "IgcTileComponentEventMap", "module": "./components/tile-manager/tile.js" } }, { "kind": "js", "name": "IgcTreeComponentEventMap", "declaration": { "name": "IgcTreeComponentEventMap", "module": "./components/tree/tree.common.js" } }, { "kind": "js", "name": "IgcTooltipComponentEventMap", "declaration": { "name": "IgcTooltipComponentEventMap", "module": "./components/tooltip/tooltip.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/types.js" } }, { "kind": "js", "name": "IgcTileChangeStateEventArgs", "declaration": { "name": "IgcTileChangeStateEventArgs", "module": "./components/tile-manager/tile.js" } }, { "kind": "js", "name": "CalendarActiveView", "declaration": { "name": "CalendarActiveView", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "CalendarHeaderOrientation", "declaration": { "name": "CalendarHeaderOrientation", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "CalendarSelection", "declaration": { "name": "CalendarSelection", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "DateRangeDescriptor", "declaration": { "name": "DateRangeDescriptor", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "WeekDays", "declaration": { "name": "WeekDays", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "DateRangeType", "declaration": { "name": "DateRangeType", "module": "./components/calendar/types.js" } }, { "kind": "js", "name": "IgcCheckboxChangeEventArgs", "declaration": { "name": "IgcCheckboxChangeEventArgs", "module": "./components/checkbox/checkbox-base.js" } }, { "kind": "js", "name": "DatePart", "declaration": { "name": "DatePart", "module": "./components/date-time-input/date-part.js" } }, { "kind": "js", "name": "DatePartDeltas", "declaration": { "name": "DatePartDeltas", "module": "./components/date-time-input/date-part.js" } }, { "kind": "js", "name": "CustomDateRange", "declaration": { "name": "CustomDateRange", "module": "./components/date-range-picker/date-range-picker.js" } }, { "kind": "js", "name": "DateRangeValue", "declaration": { "name": "DateRangeValue", "module": "./components/date-range-picker/date-range-picker.js" } }, { "kind": "js", "name": "PopoverPlacement", "declaration": { "name": "PopoverPlacement", "module": "./components/popover/popover.js" } }, { "kind": "js", "name": "IgcRadioChangeEventArgs", "declaration": { "name": "IgcRadioChangeEventArgs", "module": "./components/radio/radio.js" } }, { "kind": "js", "name": "IgcRangeSliderValueEventArgs", "declaration": { "name": "IgcRangeSliderValueEventArgs", "module": "./components/slider/range-slider.js" } }, { "kind": "js", "name": "IgcSplitterResizeEventArgs", "declaration": { "name": "IgcSplitterResizeEventArgs", "module": "./components/splitter/splitter.js" } }, { "kind": "js", "name": "IgcSplitterResizeEventDetail", "declaration": { "name": "IgcSplitterResizeEventDetail", "module": "./components/splitter/splitter.js" } }, { "kind": "js", "name": "IgcActiveStepChangingEventArgs", "declaration": { "name": "IgcActiveStepChangingEventArgs", "module": "./components/stepper/common/types.js" } }, { "kind": "js", "name": "IgcActiveStepChangedEventArgs", "declaration": { "name": "IgcActiveStepChangedEventArgs", "module": "./components/stepper/common/types.js" } }, { "kind": "js", "name": "IgcTreeSelectionEventArgs", "declaration": { "name": "IgcTreeSelectionEventArgs", "module": "./components/tree/tree.common.js" } }, { "kind": "js", "name": "ComboItemTemplate", "declaration": { "name": "ComboItemTemplate", "module": "./components/combo/types.js" } }, { "kind": "js", "name": "ComboTemplateProps", "declaration": { "name": "ComboTemplateProps", "module": "./components/combo/types.js" } }, { "kind": "js", "name": "FilteringOptions", "declaration": { "name": "FilteringOptions", "module": "./components/combo/types.js" } }, { "kind": "js", "name": "GroupingDirection", "declaration": { "name": "GroupingDirection", "module": "./components/combo/types.js" } }, { "kind": "js", "name": "IgcComboChangeEventArgs", "declaration": { "name": "IgcComboChangeEventArgs", "module": "./components/combo/types.js" } }, { "kind": "js", "name": "IconMeta", "declaration": { "name": "IconMeta", "module": "./components/icon/registry/types.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/components/chat/types.js" } } ] }, { "kind": "javascript-module", "path": "src/extras/chat-markdown-renderer.ts", "declarations": [ { "kind": "function", "name": "setupMarkdownRenderer", "return": { "type": { "text": "" } }, "parameters": [ { "name": "options", "optional": true, "type": { "text": "MarkdownRendererOptions" }, "description": "Configuration options for the markdown renderer" } ], "description": "Sets up a markdown renderer with syntax highlighting and sanitization.\nThis is the core setup function that can be used in any framework." }, { "kind": "function", "name": "createMarkdownRenderer", "parameters": [ { "name": "options", "optional": true, "type": { "text": "MarkdownRendererOptions" }, "description": "Configuration options for the markdown renderer" } ], "description": "Creates a markdown renderer specifically for igc-chat messages.\nThis function wraps the renderer to work with IgcChatMessage objects\nand returns Lit's unsafeHTML directive for rendering.", "return": { "type": { "text": "" } } } ], "exports": [ { "kind": "js", "name": "setupMarkdownRenderer", "declaration": { "name": "setupMarkdownRenderer", "module": "src/extras/chat-markdown-renderer.ts" } }, { "kind": "js", "name": "createMarkdownRenderer", "declaration": { "name": "createMarkdownRenderer", "module": "src/extras/chat-markdown-renderer.ts" } } ] }, { "kind": "javascript-module", "path": "src/extras/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "module": "src/extras/chat-markdown-renderer.js" } } ] }, { "kind": "javascript-module", "path": "src/animations/presets/slide/index.ts", "declarations": [ { "kind": "function", "name": "slideInHor", "parameters": [ { "name": "options", "default": "baseOptions" } ] }, { "kind": "function", "name": "slideOutHor", "parameters": [ { "name": "options", "default": "baseOptions" } ] } ], "exports": [ { "kind": "js", "name": "slideInHor", "declaration": { "name": "slideInHor", "module": "src/animations/presets/slide/index.ts" } }, { "kind": "js", "name": "slideOutHor", "declaration": { "name": "slideOutHor", "module": "src/animations/presets/slide/index.ts" } } ] } ] }