igniteui-webcomponents
Version:
Ignite UI for Web Components is a complete library of UI components, giving you the ability to build modern web applications using encapsulation and the concept of reusable components in a dependency-free approach.
1,736 lines (1,735 loc) • 2.24 MB
JSON
{
"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": "Record<string, string>"
}
}
}
],
"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/theming-controller.ts",
"declarations": [
{
"kind": "class",
"description": "",
"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": "_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": "theme",
"type": {
"text": "Theme"
},
"privacy": "public",
"readonly": true,
"expandedType": {
"text": "'material' | 'bootstrap' | 'indigo' | 'fluent'"
}
},
{
"kind": "method",
"name": "_getStyles",
"privacy": "private"
},
{
"kind": "method",
"name": "_adoptStyles",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "_handleThemeChanged",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
}
]
},
{
"kind": "function",
"name": "addThemingController",
"return": {
"type": {
"text": "ThemingController"
}
},
"parameters": [
{
"name": "host",
"type": {
"text": "ReactiveControllerHost & ReactiveElement"
}
},
{
"name": "themes",
"type": {
"text": "Themes"
}
},
{
"name": "config",
"optional": true,
"type": {
"text": "ThemingControllerConfig"
}
}
]
}
],
"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": "daysInWeek",
"type": {
"text": "number"
},
"default": "7"
},
{
"kind": "function",
"name": "toCalendarDay",
"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",
"privacy": "public",
"static": true,
"description": "Constructs and returns the current day.",
"readonly": true
},
{
"kind": "method",
"name": "from",
"privacy": "public",
"static": true,
"parameters": [
{
"name": "date",
"type": {
"text": "Date"
}
}
],
"description": "Constructs a new CalendarDay instance from a Date object."
},
{
"kind": "method",
"name": "compare",
"privacy": "public",
"static": true,
"parameters": [
{
"name": "first",
"type": {
"text": "DayParameter"
}
},
{
"name": "second",
"type": {
"text": "DayParameter"
}
}
],
"description": "Compares the date portion of two date objects.",
"return": {
"type": {
"text": ""
}
}
},
{
"kind": "method",
"name": "clone",
"privacy": "public",
"description": "Returns a copy of this instance."
},
{
"kind": "method",
"name": "set",
"privacy": "public",
"parameters": [
{
"name": "args",
"type": {
"text": "Partial<CalendarDayParams>"
}
}
],
"description": "Returns a new instance with values replaced."
},
{
"kind": "method",
"name": "add",
"privacy": "public",
"parameters": [
{
"name": "unit",
"type": {
"text": "DayInterval"
}
},
{
"name": "value",
"type": {
"text": "number"
}
}
]
},
{
"kind": "field",
"name": "day",
"privacy": "public",
"description": "Returns the day of the week (Sunday = 0).",
"readonly": true
},
{
"kind": "field",
"name": "year",
"privacy": "public",
"description": "Returns the full year.",
"readonly": true
},
{
"kind": "field",
"name": "month",
"privacy": "public",
"description": "Returns the month.",
"readonly": true
},
{
"kind": "field",
"name": "date",
"privacy": "public",
"description": "Returns the date",
"readonly": true
},
{
"kind": "field",
"name": "timestamp",
"privacy": "public",
"description": "Returns the timestamp since epoch in milliseconds.",
"readonly": true
},
{
"kind": "field",
"name": "week",
"privacy": "public",
"description": "Returns the current week number.",
"readonly": true
},
{
"kind": "field",
"name": "native",
"privacy": "public",
"description": "Returns the underlying native date instance.",
"readonly": true
},
{
"kind": "field",
"name": "weekend",
"privacy": "public",
"description": "Whether the current date is a weekend day.",
"readonly": true
},
{
"kind": "method",
"name": "equalTo",
"privacy": "public",
"parameters": [
{
"name": "value",
"type": {
"text": "DayParameter"
}
}
]
},
{
"kind": "method",
"name": "greaterThan",
"privacy": "public",
"parameters": [
{
"name": "value",
"type": {
"text": "DayParameter"
}
}
]
},
{
"kind": "method",
"name": "greaterThanOrEqual",
"privacy": "public",
"parameters": [
{
"name": "value",
"type": {
"text": "DayParameter"
}
}
]
},
{
"kind": "method",
"name": "lessThan",
"privacy": "public",
"parameters": [
{
"name": "value",
"type": {
"text": "DayParameter"
}
}
]
},
{
"kind": "method",
"name": "lessThanOrEqual",
"privacy": "public",
"parameters": [
{
"name": "value",
"type": {
"text": "DayParameter"
}
}
]
},
{
"kind": "method",
"name": "toString",
"privacy": "public"
}
]
}
],
"exports": [
{
"kind": "js",
"name": "daysInWeek",
"declaration": {
"name": "daysInWeek",
"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<ShadowRootInit>"
}
}
],
"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<D>"
}
}
]
}
]
},
{
"kind": "function",
"name": "EventEmitterMixin",
"return": {
"type": {
"text": "Constructor<EventEmitterInterface<E>> & 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<D>"
}
}
]
}
],
"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<string> | 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<D>"
}
}
],
"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",