{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/components/accordion-item/accordion-item.ts", "declarations": [ { "kind": "class", "description": "A single accordion header and its expandable content.", "name": "CuiAccordionItem", "members": [ { "kind": "field", "name": "_headingLevel", "type": { "text": "number | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "field", "name": "_open", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" }, "default": "'accordion-item'" }, { "kind": "field", "name": "dependencies", "type": { "text": "(typeof CharmElement)[]" }, "privacy": "public", "static": true, "readonly": true, "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "detailsTemplate", "privacy": "protected", "description": "Returns the template for the details.", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "privacy": "public", "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "attribute": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Disables the emitted click event.", "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "emitRequestClose", "privacy": "protected", "parameters": [ { "name": "source", "type": { "text": "string" }, "description": "The source of the close request." } ], "description": "Emits cancelable `{baseName}-request-close` event that hides the popup if default is not prevented.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "method", "name": "emitScopedEvent", "privacy": "protected", "parameters": [ { "name": "name", "type": { "text": "string" }, "description": "The name of the event to emit." }, { "name": "detail", "optional": true, "type": { "text": "any" }, "description": "The detail object to include with the event." } ], "description": "Emits event scoped to component `${this.baseName}-${name}`.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "field", "name": "expandIconPosition", "type": { "text": "'start' | 'end' | undefined" }, "privacy": "public", "description": "Determines whether the expand icon position: 'start' or 'end'.", "attribute": "expand-icon-position", "reflects": true, "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "handleSummaryClick", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ], "description": "Handles click event and prevents toggle if disabled.", "return": { "type": { "text": "" } }, "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "handleToggle", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "description": "Handles the `details` element toggle event.", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "handleTransitionEnd", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "TransitionEvent" } } ], "description": "Handles transitionend event to emit `{baseName}-after-show` and `{baseName}-after-hide` events after transitions are complete. Should be added to the element with the CSS transition.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "method", "name": "headerTemplate", "privacy": "protected", "description": "Returns the template for the header.", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "field", "name": "heading", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The content of the toggle element. Can be used in lieu of the slot if only a string is needed.", "attribute": "heading", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "field", "name": "headingLevel", "type": { "text": "HeadingLevel | undefined" }, "privacy": "public", "description": "The header level value (1-6) for summary, when summary is rendered as a header.", "attribute": "heading-level", "parsedType": { "text": "number | undefined" }, "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "hide", "privacy": "public", "description": "Hides/closes the component.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" }, "type": { "text": "hide() => void" } }, { "kind": "method", "name": "iconTemplate", "privacy": "protected", "description": "Returns the template for the open/close indicator.", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "onOpenChange", "privacy": "protected", "parameters": [ { "name": "open", "type": { "text": "boolean" }, "description": "Whether or not the component is changing to open or closed." } ], "description": "Additional functionality that happens when `open` changes. Will also run when first updated if `open` is true.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "privacy": "public", "description": "Indicates whether or not the component is open. Can be used in lieu of show/hide methods.", "attribute": "open", "reflects": true, "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "field", "name": "scope", "type": { "text": "any" }, "privacy": "protected", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "method", "name": "show", "privacy": "public", "description": "Shows/opens the component.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" }, "type": { "text": "show() => void" } }, { "kind": "method", "name": "summaryTemplate", "privacy": "protected", "description": "Returns the template for the summary.", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "kind": "method", "name": "toggle", "privacy": "public", "description": "Shows or hides the component depending on whether it is currently visible.", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" }, "type": { "text": "toggle() => void" } }, { "kind": "field", "name": "transition", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } }, { "kind": "field", "name": "transitionProperty", "type": { "text": "string | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" } } ], "superclass": { "name": "FluentAccordionItem", "package": "@charm-ux/fui" }, "tagName": "cui-accordion-item", "since": { "name": "1.0.0", "description": "" }, "status": { "name": "preview", "description": "" }, "dependencies": [ { "name": "icon", "description": "" } ], "customElement": true, "cssProperties": [ { "description": "Sets border width.", "name": "--accordion-item-border-width", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets focus width.", "name": "--accordion-item-focus-width", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets font size.", "name": "--accordion-item-font-size", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets font weight.", "name": "--accordion-item-font-weight", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets the line height of accordion-item.", "name": "--accordion-item-line-height", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets vertical padding.", "name": "--accordion-item-padding-y", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets horizontal padding.", "name": "--accordion-item-padding-x", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets background color.", "name": "--accordion-item-bg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets border color.", "name": "--accordion-item-border-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets foreground color.", "name": "--accordion-item-fg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets background color of accordion-item when disabled.", "name": "--accordion-item-disabled-bg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets border color of accordion-item when disabled.", "name": "--accordion-item-disabled-border-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets foreground color of accordion-item when disabled.", "name": "--accordion-item-disabled-fg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets background color of accordion-item when hovered.", "name": "--accordion-item-hover-bg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets border color of accordion-item when hovered.", "name": "--accordion-item-hover-border-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets foreground color of accordion-item when hovered.", "name": "--accordion-item-hover-fg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets background color of accordion-item when focused.", "name": "--accordion-item-focus-bg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "the border color of accordion-item when focused.", "name": "--accordion-item-focus-border-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets foreground color of accordion-item when focused.", "name": "--accordion-item-focus-fg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets background color of accordion-item when active.", "name": "--accordion-item-active-bg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets border color of accordion-item when active.", "name": "--accordion-item-active-border-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets foreground color of accordion-item when active.", "name": "--accordion-item-active-fg-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Transition for the icon when opening an accordion item", "name": "--accordion-item-indicator-open-transition", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Transition for the icon when closing an accordion item", "name": "--accordion-item-indicator-close-transition", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Transition for the content when opening an accordion item", "name": "--accordion-item-open-transition", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Transition for the content when closing an accordion item", "name": "--accordion-item-close-transition", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets the transform for the orientation of the icon when collapsed.", "name": "--accordion-item-icon-collapsed-transform", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Sets the transform for the orientation of the icon when expanded.", "name": "--accordion-item-icon-expanded-transform", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The bottom border color of the accordion item.", "name": "--accordion-item-bottom-border-color", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The duration of the accordion item animation.", "name": "--accordion-item-animation-duration", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The timing function of the accordion item animation.", "name": "--accordion-item-animation-timing-function", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The transition for the icon when the state changes.", "name": "--accordion-item-icon-transition", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The starting transform for the down icon when the icon position is 'start'.", "name": "--accordion-item-icon-down-start-transform", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The starting transform for the down icon when the icon position is 'end'.", "name": "--accordion-item-icon-down-end-transform", "inheritedFrom": { "name": "CoreAccordionItem" } } ], "cssParts": [ { "description": "The wrapper element.", "name": "accordion-item-base", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The expand/collapse icon.", "name": "accordion-item-chevron", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The end slot container.", "name": "accordion-item-end", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The heading element.", "name": "accordion-item-heading", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The wrapper element for the expand/collapse icon.", "name": "accordion-item-icon", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The start slot container.", "name": "accordion-item-start", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The summary element.", "name": "accordion-item-summary", "inheritedFrom": { "name": "CoreAccordionItem" } } ], "attributes": [ { "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "fieldName": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" }, "propName": "dir" }, { "name": "disabled", "type": { "text": "boolean | undefined" }, "description": "Disables the emitted click event.", "fieldName": "disabled", "inheritedFrom": { "name": "CoreAccordionItem" }, "propName": "disabled" }, { "name": "expand-icon-position", "type": { "text": "'start' | 'end' | undefined" }, "description": "Determines whether the expand icon position: 'start' or 'end'.", "fieldName": "expandIconPosition", "inheritedFrom": { "name": "CoreAccordionItem" }, "propName": "expandIconPosition" }, { "name": "heading", "type": { "text": "string | undefined" }, "description": "The content of the toggle element. Can be used in lieu of the slot if only a string is needed.", "fieldName": "heading", "inheritedFrom": { "name": "CoreAccordionItem" }, "propName": "heading" }, { "name": "heading-level", "type": { "text": "HeadingLevel | undefined" }, "description": "The header level value (1-6) for summary, when summary is rendered as a header.", "fieldName": "headingLevel", "parsedType": { "text": "number | undefined" }, "inheritedFrom": { "name": "CoreAccordionItem" }, "propName": "headingLevel" }, { "name": "open", "type": { "text": "boolean" }, "description": "Indicates whether or not the component is open. Can be used in lieu of show/hide methods.", "fieldName": "open", "inheritedFrom": { "name": "CharmDismissibleElement", "module": "src/base/dismissible-element/charm-dismissible-element.ts" }, "propName": "open" } ], "events": [ { "description": "Dispatched when the accordion item is expanded or collapsed.", "name": "accordion-item-open-change", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Emitted when the component is ready.", "name": "ready", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } } ], "slots": [ { "description": "The collapsible content of the accordion item.", "name": "", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Custom collapse icon. If no icon is provided, a default icon will be used.", "name": "collapse-icon", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Content rendered after the content in the toggle element", "name": "end", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Custom expand icon. If no icon is provided, a default icon will be used.", "name": "expand-icon", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "The content of the toggle element.", "name": "heading", "inheritedFrom": { "name": "CoreAccordionItem" } }, { "description": "Content rendered before the content in the toggle element", "name": "start", "inheritedFrom": { "name": "CoreAccordionItem" } } ], "modulePath": "src/components/accordion-item/accordion-item.ts" } ], "exports": [ { "kind": "js", "name": "CuiAccordionItem", "declaration": { "name": "CuiAccordionItem", "module": "src/components/accordion-item/accordion-item.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "CuiAccordionItem", "module": "src/components/accordion-item/accordion-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/accordion/accordion.ts", "declarations": [ { "kind": "class", "description": "An accordion groups sections of related content that can be opened and closed.", "name": "CuiAccordion", "members": [ { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large' | 'extra-large' | undefined" }, "privacy": "public", "description": "Sets the size of the accordion and accepts predefined size values.\nIt reflects its value to the attribute for styling purposes. The available sizes are:\n- 'small': Sets the accordion to a small size.\n- 'medium': Sets the accordion to a medium size. This is the default size.\n- 'large': Sets the accordion to a large size.\n- 'extra-large': Sets the accordion to an extra-large size.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "FluentAccordion" } }, { "kind": "method", "name": "accordionTemplate", "privacy": "protected", "description": "Generate the accordion template with declarative event handling.", "inheritedFrom": { "name": "CoreAccordion" } }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "default": "'accordion'", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "privacy": "public", "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "attribute": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "method", "name": "handleOpenChange", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "Event" } } ], "description": "Ensures only one item is open at a time.", "inheritedFrom": { "name": "CoreAccordion" } }, { "kind": "field", "name": "openSingle", "type": { "text": "boolean | undefined" }, "privacy": "public", "default": "false", "description": "If set, allows only one child accordion-item to be open at a time.", "attribute": "open-single", "reflects": true, "inheritedFrom": { "name": "CoreAccordion" } }, { "kind": "field", "name": "scope", "type": { "text": "any" }, "privacy": "protected", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "updating", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "description": "Used to prevent multiple calls to the logic when updating the `open` attribute when `openSingle` is true", "inheritedFrom": { "name": "CoreAccordion" } } ], "superclass": { "name": "FluentAccordion", "package": "@charm-ux/fui" }, "tagName": "cui-accordion", "since": { "name": "1.0.0", "description": "" }, "status": { "name": "preview", "description": "" }, "customElement": true, "cssProperties": [ { "description": "Sets the border top color of the accordion.", "name": "--accordion-top-border-color", "inheritedFrom": { "name": "CoreAccordion" } } ], "cssParts": [], "attributes": [ { "name": "size", "type": { "text": "'small' | 'medium' | 'large' | 'extra-large' | undefined" }, "description": "Sets the size of the accordion and accepts predefined size values.\nIt reflects its value to the attribute for styling purposes. The available sizes are:\n- 'small': Sets the accordion to a small size.\n- 'medium': Sets the accordion to a medium size. This is the default size.\n- 'large': Sets the accordion to a large size.\n- 'extra-large': Sets the accordion to an extra-large size.", "fieldName": "size", "propName": "size", "inheritedFrom": { "name": "FluentAccordion" } }, { "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "fieldName": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" }, "propName": "dir" }, { "name": "open-single", "type": { "text": "boolean | undefined" }, "default": "false", "description": "If set, allows only one child accordion-item to be open at a time.", "fieldName": "openSingle", "inheritedFrom": { "name": "CoreAccordion" }, "propName": "openSingle" } ], "events": [ { "description": "Emitted when the component is ready.", "name": "ready", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } } ], "slots": [ { "description": "The default slot where accordion items are placed.", "name": "", "inheritedFrom": { "name": "CoreAccordion" } } ], "modulePath": "src/components/accordion/accordion.ts" } ], "exports": [ { "kind": "js", "name": "CuiAccordion", "declaration": { "name": "CuiAccordion", "module": "src/components/accordion/accordion.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "CuiAccordion", "module": "src/components/accordion/accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/ai-chat/ai-chat.ts", "declarations": [ { "kind": "class", "description": "The AI Chat component is a chat window that allows users to ask questions and receive responses. It can be used with any backend service that can provide responses to user input.", "name": "CuiAiChat", "members": [ { "kind": "field", "name": "_inputCount", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "_loading", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "_responseCount", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "_transcript", "type": { "text": "AiChatPrompt[]" }, "privacy": "protected", "default": "[]", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "addInput", "privacy": "public", "parameters": [ { "name": "input", "type": { "text": "AiChatInput" }, "parsedType": { "text": "{ value: string, promptId?: string, isSuggestion?: false | true }" } } ], "description": "Adds a input to display.", "type": { "text": "addInput(input: AiChatInput) => void" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "addInputToChat", "privacy": "protected", "parameters": [ { "name": "value", "type": { "text": "string" } }, { "name": "isSuggestion", "default": "false" }, { "name": "timestamp", "optional": true, "type": { "text": "string" } } ], "description": "Adds an input to chat.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "addPromptToTranscript", "privacy": "protected", "parameters": [ { "name": "id", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } }, { "name": "timestamp", "optional": true, "type": { "text": "string" } } ], "description": "Adds a prompt to transcript.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "addResponse", "privacy": "public", "parameters": [ { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Adds a response to display for a given user's input.", "type": { "text": "addResponse(response: AiChatResponse) => void" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "addText", "privacy": "public", "parameters": [ { "name": "text", "type": { "text": "string" } } ], "description": "Adds input text without submitting it and sets the focus on the chat input.", "type": { "text": "addText(text: string) => void" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "afterLoad", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "aiChatTemplate", "privacy": "protected", "description": "Generates the template for the chat window.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "aiDisclaimerTemplate", "privacy": "protected", "description": "Generates the template for the AI disclaimer.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "aiDisclaimerWrapperTemplate", "privacy": "protected", "parameters": [ { "name": "hideDisclaimer", "default": "false", "type": { "text": "boolean" } } ], "description": "Generates the template for the wrapper of the AI disclaimer.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "allowInputOverMaxlength", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Allows user to type in input when the input length is longer than the maxlength.", "attribute": "allow-input-over-maxlength", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "default": "'ai-chat'", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "chatContentTemplate", "privacy": "protected", "description": "Generates the template for the chat content.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "chatFooterTemplate", "privacy": "protected", "description": "Generates the template for the chat footer.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "citationLabel", "type": { "text": "string" }, "privacy": "public", "default": "'citation'", "description": "The label of the citation button with a number in it used by assistive technologies.", "attribute": "citation-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "content", "type": { "text": "Promise" }, "privacy": "protected", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "customResponseHeadingIcon", "type": { "text": "string" }, "privacy": "protected", "default": "''", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "dependencies", "type": { "text": "(typeof CharmElement)[]" }, "privacy": "public", "static": true, "readonly": true, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "disableInput", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Disables the input and submission button so that users are not able to add input to the chat window.", "attribute": "disable-input", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "errorMessage", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The error message of the input.", "attribute": "error-message", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "errorMessageTemplate", "privacy": "protected", "description": "Generates the template for form control error message", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "feedbackTemplate", "privacy": "protected", "parameters": [ { "name": "hasDefaultContent", "type": { "text": "boolean" } }, { "name": "promptId", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Generates the template for the feedback slot and feedback buttons.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "formFooterTemplate", "privacy": "protected", "description": "Generates the template for the footer of the form in the input.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getActionsTemplate", "privacy": "protected", "parameters": [ { "name": "promptId", "type": { "text": "string" } }, { "name": "actions", "optional": true, "type": { "text": "Action[] | null" } } ], "description": "Generates the template for the actionable insights.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getInputTemplate", "privacy": "protected", "parameters": [ { "name": "prompt", "type": { "text": "AiChatPrompt" }, "parsedType": { "text": "{ id: string, timestamp: string, response: AiChatResponse }" } } ], "description": "Generates the template of the input chat bubble.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getLoadingTemplate", "privacy": "protected", "description": "Generates the template of the loading state.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getReferencesTemplate", "privacy": "protected", "parameters": [ { "name": "promptId", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Generates the template for the the list of references tooltip.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getResponseBody", "privacy": "protected", "parameters": [ { "name": "promptId", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Handles the click of a citation button.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getResponseCountTemplate", "privacy": "protected", "parameters": [ { "name": "id", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Generates the template for the response count.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getResponseFooterTemplate", "privacy": "protected", "parameters": [ { "name": "promptId", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Generates the template for the response footer that contains the AI disclaimer and the feedback buttons.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getResponseReferencesTemplate", "privacy": "protected", "parameters": [ { "name": "promptId", "type": { "text": "string" } }, { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Generates the template for the references wrapper in a response.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getResponseTemplate", "privacy": "protected", "parameters": [ { "name": "prompt", "type": { "text": "AiChatPrompt" }, "parsedType": { "text": "{ id: string, timestamp: string, response: AiChatResponse }" } } ], "description": "Generates the template of the response chat bubble.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "getSuggestionsTemplate", "privacy": "protected", "description": "Generates the template for the suggestions and the prompt guide.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleActionClick", "privacy": "protected", "parameters": [ { "name": "detail", "type": { "text": "Action" }, "parsedType": { "text": "{ id?: number, data?: string, content?: string, promptId?: string }" } } ], "description": "Handles clicking on actionable insights.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleActionsSlotChange", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "hasActionsProp", "type": { "text": "boolean" } } ], "description": "Handles the change of the actionable insights slot.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleConversationLimiterChange", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "noDefaultLimiter", "type": { "text": "boolean" } } ], "description": "Handles the change of the change of the response count.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleFeedbackButtonsChange", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "description": "Handles the change of the value of the feedback-buttons.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleFooterSlotChange", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "Event" } }, { "name": "hasDefaultContent", "type": { "text": "boolean" } }, { "name": "promptId", "type": { "text": "string" } } ], "description": "Handles changes in the footer slot.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleInput", "privacy": "protected", "description": "Handles input.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleInputKeydown", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "KeyboardEvent" } } ], "description": "Handles keydown event on the input.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleLoadingButtonClick", "privacy": "protected", "description": "Handles the click of the loading button.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handlePromptGuideClick", "privacy": "protected", "description": "Handles clicking on the prompt guide button.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleRegenerateButtonClick", "privacy": "protected", "description": "Handles the click of the regenerate button.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleResponse", "privacy": "protected", "parameters": [ { "name": "response", "type": { "text": "AiChatResponse" }, "parsedType": { "text": "{ value?: string, hideFeedback?: false | true, hideAiDisclaimer?: false | true, hideHeader?: false | true, actions?: Action[] | null | undefined, references?: AiChatReference[] | undefined, suggestions?: string[] | undefined, count?: number }" } } ], "description": "Handles response.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleResponseHeadingIconSlotChange", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "description": "Handles changes in the response heading slot.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleSubmit", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "description": "Handles the submission of an input", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleSuggestionClick", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "MouseEvent" } } ], "description": "Handles clicking on a suggestion.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "handleUpdate", "privacy": "protected", "parameters": [ { "name": "response", "type": { "text": "AiChatResponseUpdate" }, "parsedType": { "text": "{ id: string, response: AiChatResponse }" } } ], "description": "Handles the update of a response.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "heading", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The heading in the response chat.", "attribute": "heading", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "hiddenResponseHeadingIconSlotTemplate", "privacy": "protected", "description": "Generates the template for the hidden response heading slot.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "hideResponseCountUntilRemaining", "type": { "text": "number | undefined" }, "privacy": "public", "description": "The number of remaining responses in the conversation before the reponse count start showing.", "attribute": "hide-response-count-until-remaining", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "hideStopGenerationButton", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Hides empty state.", "attribute": "hide-stop-generation-button", "reflects": true, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "input", "type": { "text": "HTMLInputElement" }, "privacy": "protected", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "inputCount", "type": { "text": "number" }, "privacy": "public", "description": "The number of user inputs that have occurred in this conversation.", "readonly": true, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "inputLabel", "type": { "text": "string" }, "privacy": "public", "default": "'Ask a question or request info'", "description": "The label used by assistive technologies for the input field.", "attribute": "inputLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "inputLength", "type": { "text": "number" }, "privacy": "protected", "default": "0", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "inputTemplate", "privacy": "protected", "description": "Generates the template for the chat input.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "isSendHovered", "type": { "text": "boolean | undefined" }, "privacy": "protected", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "privacy": "public", "default": "'AI Chat Window'", "description": "The label used by assistive technologies.", "attribute": "label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "loadConversationData", "privacy": "protected", "description": "Load transcript from sessionStorage.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "privacy": "public", "description": "Enables the loading state of the component.", "attribute": "loading", "reflects": true, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "loadingFromTranscript", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "loadingLabel", "type": { "text": "string" }, "privacy": "public", "default": "'Looking for references...'", "description": "The default progress text in loading.", "attribute": "loading-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "markdownToHTML", "privacy": "protected", "return": { "type": { "text": "DirectiveResult" } }, "parameters": [ { "name": "value", "type": { "text": "string" } } ], "description": "Transform a markdown to html format.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "maxlength", "type": { "text": "number | undefined" }, "privacy": "public", "description": "The maximum number of characters allowed for the input.", "attribute": "maxlength", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "maxResponseCount", "type": { "text": "number | undefined" }, "privacy": "public", "description": "The maximum number of responses in the conversation.", "attribute": "max-response-count", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "messageLabel", "type": { "text": "string" }, "privacy": "public", "default": "'AI Chat says'", "description": "The label for the AI Chat messages for assistive technologies before reading the content of the message.", "attribute": "message-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "privacy": "public", "default": "'Ask a question or request info'", "description": "The placeholder text for the input.", "attribute": "placeholder", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "promptGuide", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Show the prompt guide button. This will also hide the refresh button.", "attribute": "prompt-guide", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "promptGuideTemplate", "privacy": "protected", "description": "Generates the template for the prompt guide.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "referenceCardContentTemplate", "privacy": "protected", "parameters": [ { "name": "reference", "type": { "text": "AiChatReference" }, "parsedType": { "text": "{ excerpt?: string, graphicURL?: string, linkText?: string, linkURL?: string, name?: string, primaryText?: string, secondaryText?: string, tertiaryText?: string, title: string }" } }, { "name": "refNumber", "type": { "text": "number" } } ], "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "referenceCardTemplate", "privacy": "protected", "parameters": [ { "name": "reference", "type": { "text": "AiChatReference" }, "parsedType": { "text": "{ excerpt?: string, graphicURL?: string, linkText?: string, linkURL?: string, name?: string, primaryText?: string, secondaryText?: string, tertiaryText?: string, title: string }" } }, { "name": "refNumber", "type": { "text": "number" } }, { "name": "promptId", "type": { "text": "string" } } ], "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "RegenerateButtonLabel", "type": { "text": "string" }, "privacy": "public", "default": "'Regenerate'", "description": "The label of the regeneration button after the loading state.", "attribute": "regenerate-button-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "regenerateButtonTemplate", "privacy": "protected", "description": "Generates the template for the regenerate button.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "resetInput", "privacy": "public", "description": "Resets the input field.", "type": { "text": "resetInput() => void" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "responseCount", "type": { "text": "number" }, "privacy": "public", "description": "The number of responses that have occurred in this conversation.", "readonly": true, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "responseHeadingTemplate", "privacy": "protected", "parameters": [ { "name": "hideDisclaimer", "default": "false", "type": { "text": "boolean" } }, { "name": "hideHeader", "default": "false", "type": { "text": "boolean" } } ], "description": "Generates the template for the response heading.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "saveConversationData", "privacy": "protected", "description": "Saves transcript in sessionStorage.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "saveTranscript", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Save the in sessionStorage and restore it when the component is reloaded.", "attribute": "save-transcript", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "sendButtonTemplate", "privacy": "protected", "description": "Generates the template for the send button in the footer form.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "sendIconLabel", "type": { "text": "string" }, "privacy": "public", "default": "'send'", "description": "The label of the send icon in the input used by assistive technologies.", "attribute": "send-icon-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "setPromptsFromTranscript", "privacy": "protected", "description": "Sets the display of prompts based on transcript", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "stopGenerationButtonLabel", "type": { "text": "string" }, "privacy": "public", "default": "'Stop generating'", "description": "The label of the stop generation button in the loading state.", "attribute": "loading-stop-generation-button-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "suggestions", "type": { "text": "string[] | undefined" }, "privacy": "public", "description": "The placeholder text for the input.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "suggestionsLabel", "type": { "text": "string" }, "privacy": "public", "default": "'Suggested responses'", "description": "The label for the suggestions for assistive technologies before reading the content of the suggestions.", "attribute": "suggestions-label", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "textAreaTemplate", "privacy": "protected", "description": "Generates the template for the text area in the footer form.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "transcript", "type": { "text": "AiChatPrompt[]" }, "privacy": "public", "description": "A record of the conversation.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "updateResponse", "privacy": "public", "parameters": [ { "name": "response", "type": { "text": "AiChatResponseUpdate" }, "parsedType": { "text": "{ id: string, response: AiChatResponse }" } } ], "description": "Updates the information for a specified response", "type": { "text": "updateResponse(response: AiChatResponseUpdate) => void" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "method", "name": "updateResponseUI", "privacy": "protected", "parameters": [ { "name": "suggestions", "default": "[]", "type": { "text": "string[]" } } ], "description": "Updates the UI of a response.", "inheritedFrom": { "name": "FluentAiChat" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "privacy": "public", "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "attribute": "dir", "inheritedFrom": { "name": "CharmElement" } }, { "kind": "field", "name": "scope", "type": { "text": "any" }, "privacy": "protected", "inheritedFrom": { "name": "CharmElement" } } ], "superclass": { "name": "FluentAiChat", "package": "@charm-ux/fui" }, "tagName": "cui-ai-chat", "since": { "name": "1.0.0", "description": "" }, "status": { "name": "preview", "description": "" }, "dependencies": [ { "name": "button", "description": "" }, { "name": "divider", "description": "" }, { "name": "feedback-buttons", "description": "" }, { "name": "icon", "description": "" }, { "name": "overflow", "description": "" }, { "name": "pop-over", "description": "" }, { "name": "progress-bar", "description": "" } ], "customElement": true, "attributes": [ { "name": "allow-input-over-maxlength", "type": { "text": "boolean | undefined" }, "description": "Allows user to type in input when the input length is longer than the maxlength.", "fieldName": "allowInputOverMaxlength", "propName": "allowInputOverMaxlength", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "citation-label", "type": { "text": "string" }, "default": "'citation'", "description": "The label of the citation button with a number in it used by assistive technologies.", "fieldName": "citationLabel", "propName": "citationLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "disable-input", "type": { "text": "boolean | undefined" }, "description": "Disables the input and submission button so that users are not able to add input to the chat window.", "fieldName": "disableInput", "propName": "disableInput", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "error-message", "type": { "text": "string | undefined" }, "description": "The error message of the input.", "fieldName": "errorMessage", "propName": "errorMessage", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "heading", "type": { "text": "string | undefined" }, "description": "The heading in the response chat.", "fieldName": "heading", "propName": "heading", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "hide-response-count-until-remaining", "type": { "text": "number | undefined" }, "description": "The number of remaining responses in the conversation before the reponse count start showing.", "fieldName": "hideResponseCountUntilRemaining", "propName": "hideResponseCountUntilRemaining", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "hide-stop-generation-button", "type": { "text": "boolean | undefined" }, "description": "Hides empty state.", "fieldName": "hideStopGenerationButton", "propName": "hideStopGenerationButton", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "inputLabel", "type": { "text": "string" }, "default": "'Ask a question or request info'", "description": "The label used by assistive technologies for the input field.", "fieldName": "inputLabel", "propName": "inputlabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "label", "type": { "text": "string" }, "default": "'AI Chat Window'", "description": "The label used by assistive technologies.", "fieldName": "label", "propName": "label", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "loading", "type": { "text": "boolean" }, "description": "Enables the loading state of the component.", "fieldName": "loading", "propName": "loading", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "loading-label", "type": { "text": "string" }, "default": "'Looking for references...'", "description": "The default progress text in loading.", "fieldName": "loadingLabel", "propName": "loadingLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "loading-stop-generation-button-label", "type": { "text": "string" }, "default": "'Stop generating'", "description": "The label of the stop generation button in the loading state.", "fieldName": "stopGenerationButtonLabel", "propName": "loadingStopGenerationButtonLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "max-response-count", "type": { "text": "number | undefined" }, "description": "The maximum number of responses in the conversation.", "fieldName": "maxResponseCount", "propName": "maxResponseCount", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "maxlength", "type": { "text": "number | undefined" }, "description": "The maximum number of characters allowed for the input.", "fieldName": "maxlength", "propName": "maxlength", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "message-label", "type": { "text": "string" }, "default": "'AI Chat says'", "description": "The label for the AI Chat messages for assistive technologies before reading the content of the message.", "fieldName": "messageLabel", "propName": "messageLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "placeholder", "type": { "text": "string" }, "default": "'Ask a question or request info'", "description": "The placeholder text for the input.", "fieldName": "placeholder", "propName": "placeholder", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "prompt-guide", "type": { "text": "boolean | undefined" }, "description": "Show the prompt guide button. This will also hide the refresh button.", "fieldName": "promptGuide", "propName": "promptGuide", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "regenerate-button-label", "type": { "text": "string" }, "default": "'Regenerate'", "description": "The label of the regeneration button after the loading state.", "fieldName": "RegenerateButtonLabel", "propName": "regenerateButtonLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "save-transcript", "type": { "text": "boolean | undefined" }, "description": "Save the in sessionStorage and restore it when the component is reloaded.", "fieldName": "saveTranscript", "propName": "saveTranscript", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "send-icon-label", "type": { "text": "string" }, "default": "'send'", "description": "The label of the send icon in the input used by assistive technologies.", "fieldName": "sendIconLabel", "propName": "sendIconLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "suggestions-label", "type": { "text": "string" }, "default": "'Suggested responses'", "description": "The label for the suggestions for assistive technologies before reading the content of the suggestions.", "fieldName": "suggestionsLabel", "propName": "suggestionsLabel", "inheritedFrom": { "name": "FluentAiChat" } }, { "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "fieldName": "dir", "inheritedFrom": { "name": "CharmElement" }, "propName": "dir" } ], "events": [ { "type": { "text": "Action" }, "description": "Emitted when the user clicks on an actionable insight.", "name": "ai-chat-action", "parsedType": { "text": "{ id?: number, data?: string, content?: string, promptId?: string }" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "Emitted when the user clicks on the stop generation button.", "name": "ai-chat-cancel", "inheritedFrom": { "name": "FluentAiChat" } }, { "type": { "text": "AiChatFeedback" }, "description": "Emitted when the user clicks on feedback options.", "name": "ai-chat-feedback", "parsedType": { "text": "{ value: string, promptId: string }" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "type": { "text": "AiChatInput" }, "description": "Emitted when the user submits a question or request.", "name": "ai-chat-input", "parsedType": { "text": "{ value: string, promptId?: string, isSuggestion?: false | true }" }, "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "Emitted when the user clicks the prompt guide button.", "name": "ai-chat-prompt-guide", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "Emitted when the user clicks on the regenerate button.", "name": "ai-chat-regenerate", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "Emitted when the component is ready.", "name": "ready", "inheritedFrom": { "name": "CharmElement" } } ], "slots": [ { "description": "A dynamic slot use to add rich content to a response body in place of a response `value`.", "name": "[promptId]-body", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "A dynamic slot use to add rich content to a response in place of the default feedback control.", "name": "[promptId]-feedback", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "A dynamic slot for adding your own content for the response count.", "name": "[promptId]-response-count-message", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "A dynamic slot for adding additional content at the end of the response.", "name": "[promptId]-response-footer", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "A slot use to add rich content to a response in place of the default AI disclaimer.", "name": "ai-message", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "The actions button in the input footer.", "name": "input-footer-actions", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "Content that is displayed while loading.", "name": "loading-content", "inheritedFrom": { "name": "FluentAiChat" } }, { "description": "Content of loading progress text.", "name": "loading-progress-text", "inheritedFrom": { "name": "FluentAiChat" } } ], "modulePath": "src/components/ai-chat/ai-chat.ts" } ], "exports": [ { "kind": "js", "name": "Action", "declaration": { "name": "Action", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "AiChatFeedback", "declaration": { "name": "AiChatFeedback", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "AiChatInput", "declaration": { "name": "AiChatInput", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "AiChatPrompt", "declaration": { "name": "AiChatPrompt", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "AiChatReference", "declaration": { "name": "AiChatReference", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "AiChatResponse", "declaration": { "name": "AiChatResponse", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "AiChatResponseUpdate", "declaration": { "name": "AiChatResponseUpdate", "package": "@charm-ux/fui" } }, { "kind": "js", "name": "CuiAiChat", "declaration": { "name": "CuiAiChat", "module": "src/components/ai-chat/ai-chat.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "CuiAiChat", "module": "src/components/ai-chat/ai-chat.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/app-frame/app-frame.ts", "declarations": [ { "kind": "class", "description": "", "name": "CuiAppFrame", "cssProperties": [ { "description": "Height of the header.", "name": "--app-frame-header-height" }, { "description": "Width of the navigation.", "name": "--app-frame-navigation-width" }, { "description": "Background color of the drawer.", "name": "--app-frame-drawer-bg-color" } ], "slots": [ { "description": "Aside slot on right hand side of main content", "name": "aside" }, { "description": "Header slot", "name": "header" }, { "description": "Links inside the skip-to component.", "name": "links" }, { "description": "Main slot in center of app frame", "name": "main" }, { "description": "Navigation slot on left hand side of main content", "name": "navigation" } ], "members": [ { "kind": "method", "name": "appFrameTemplate", "privacy": "protected", "description": "App frame template" }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "default": "'app-frame'" }, { "kind": "field", "name": "dependencies", "type": { "text": "(typeof CharmElement)[]" }, "privacy": "public", "static": true, "readonly": true }, { "kind": "method", "name": "focusElement", "privacy": "protected", "parameters": [ { "name": "elementId", "type": { "text": "string" } } ] }, { "kind": "method", "name": "handleDrawerHide", "privacy": "protected", "description": "When drawer is closed, remove expanded in header" }, { "kind": "method", "name": "handleDrawerShow", "privacy": "protected", "description": "When drawer is opened, set expanded in header" }, { "kind": "method", "name": "handleHeaderExpandedChange", "privacy": "protected", "parameters": [ { "name": "e", "type": { "text": "Event" } } ], "description": "When header is expanded, open drawer" }, { "kind": "method", "name": "handleHeaderSlotChange", "privacy": "protected" }, { "kind": "method", "name": "handleMainClick", "privacy": "protected", "description": "Handles the main content click event" }, { "kind": "method", "name": "handleNavigationSlotChange", "privacy": "protected" }, { "kind": "method", "name": "handleSkipToClick", "privacy": "protected", "parameters": [ { "name": "event", "type": { "text": "Event" } } ] }, { "kind": "field", "name": "header", "type": { "text": "CuiHeader | undefined" }, "privacy": "private", "description": "Header element" }, { "kind": "field", "name": "hideSkipTo", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Hides the skip to component", "attribute": "hide-skip-to" }, { "kind": "field", "name": "navigationButton", "type": { "text": "HTMLElement | null" }, "privacy": "protected", "description": "Gets navigation button from header", "readonly": true }, { "kind": "field", "name": "navigationDrawer", "type": { "text": "CuiDrawer | undefined" }, "privacy": "private", "description": "Navigation element" }, { "kind": "method", "name": "setNavigationButtonPressed", "privacy": "protected", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "isPressed", "type": { "text": "boolean" } } ], "description": "Sets the navigation button pressed state" }, { "kind": "method", "name": "setupOverflowListener", "privacy": "protected", "description": "Updates the dropdown trigger's pressed state based on overflow menu visibility." }, { "kind": "field", "name": "shadowRootOptions", "type": { "text": "object" }, "privacy": "public", "static": true, "default": "{ ...LitElement.shadowRootOptions, delegatesFocus: true }" }, { "kind": "field", "name": "skipToMain", "type": { "text": "HTMLElement[] | undefined" }, "privacy": "protected", "description": "Skip to main content element" }, { "kind": "field", "name": "skipToMainText", "type": { "text": "string" }, "privacy": "public", "default": "'Skip to main content'", "description": "Text for the skip to main content link", "attribute": "skip-to-main-text", "reflects": true }, { "kind": "method", "name": "skipToTemplate", "privacy": "protected", "description": "Skip to template" }, { "kind": "method", "name": "syncComponentsIfReady", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "When the component is first updated, sync drawer state" }, { "kind": "method", "name": "toggleDrawerHeaderVisibility", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Updates the drawer header based on the drawer state" }, { "kind": "method", "name": "updateSlotElements", "privacy": "protected" } ], "attributes": [ { "name": "hide-skip-to", "type": { "text": "boolean" }, "default": "false", "description": "Hides the skip to component", "fieldName": "hideSkipTo", "propName": "hideSkipTo" }, { "name": "skip-to-main-text", "type": { "text": "string" }, "default": "'Skip to main content'", "description": "Text for the skip to main content link", "fieldName": "skipToMainText", "propName": "skipToMainText" } ], "superclass": { "name": "CharmElement", "package": "@charm-ux/fui" }, "tagName": "cui-app-frame", "since": { "name": "1.0.0", "description": "" }, "status": { "name": "preview", "description": "" }, "figma": { "name": "https://www.figma.com/design/CcehRyneBI2vZtFL3ofttH/App-frame?m=auto&t=lqwuYHQ4tFEnSiMa-6", "description": "" }, "dependencies": [ { "name": "skip-to", "description": "" } ], "customElement": true, "modulePath": "src/components/app-frame/app-frame.ts" } ], "exports": [ { "kind": "js", "name": "CuiAppFrame", "declaration": { "name": "CuiAppFrame", "module": "src/components/app-frame/app-frame.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "CuiAppFrame", "module": "src/components/app-frame/app-frame.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/avatar/avatar.ts", "declarations": [ { "kind": "class", "description": "An avatar shows an image or text to represent a person or group. They also can provide additional information like a person’s status (also called presence) and activity.", "name": "CuiAvatar", "members": [ { "kind": "field", "name": "active", "type": { "text": "AvatarActive | undefined" }, "privacy": "public", "description": "Indicates whether the avatar is in an active state.", "attribute": "active", "reflects": true, "parsedType": { "text": "'active' | 'inactive' | 'unset' | undefined" }, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "activeAppearance", "type": { "text": "AvatarActiveAppearance | undefined" }, "privacy": "public", "attribute": "active-appearance", "reflects": true, "parsedType": { "text": "'ring' | 'shadow' | 'ring-shadow' | undefined" }, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "method", "name": "applyDynamicColorScheme", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Applies a dynamic color scheme to the avatar if the 'color' property is set to 'colorful'.", "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "avatarColors", "type": { "text": "string[]" }, "privacy": "protected", "default": "[ 'lilac', 'dark-red', 'blue', 'teal', 'gold', 'purple', 'pink', 'anchor', 'lavender', 'seafoam', 'dark-green', 'purple', 'marigold', ]", "description": "An array of color strings representing the available color themes for the avatar.", "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "color", "type": { "text": "AvatarColor | undefined" }, "privacy": "public", "description": "Defines the color theme of the avatar.", "attribute": "color", "reflects": true, "parsedType": { "text": "'neutral' | 'brand' | 'colorful' | undefined" }, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "method", "name": "getHashCode", "privacy": "protected", "return": { "type": { "text": "number" } }, "parameters": [ { "name": "inputString", "type": { "text": "string" } } ], "description": "Generates a hash code from a given string.", "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "idForColor", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Property to determine the color based on an ID", "attribute": "id-for-color", "reflects": true, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "privacy": "public", "default": "''", "description": "The name of the avatar user", "attribute": "name", "reflects": true, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "method", "name": "setInitials", "privacy": "protected", "description": "Computes the initials from the user's name. Returns one initial for one-word name; returns maximum two initials for names containing two or more words.", "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "shape", "type": { "text": "AvatarShape | undefined" }, "privacy": "public", "description": "Specifies the shape of the avatar.", "attribute": "shape", "reflects": true, "parsedType": { "text": "'circular' | 'square' | undefined" }, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "field", "name": "size", "type": { "text": "16 | 20 | 24 | 28 | 32 | 36 | 40 | 48 | 56 | 64 | 72 | 96 | 120 | 128 | undefined" }, "privacy": "public", "description": "Controls the size of the avatar.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "method", "name": "statusIndicatorSlotChange", "privacy": "protected", "description": "If the status indicator slot contains a badge, set the badge size based on the avatar size (if not already set).", "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "method", "name": "statusIndicatorSlotTemplate", "privacy": "protected", "inheritedFrom": { "name": "FluentAvatar" } }, { "kind": "method", "name": "avatarTemplate", "privacy": "protected", "description": "Generates the complete template for the avatar component.", "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "method", "name": "backgroundTemplate", "privacy": "protected", "description": "Generates the template for the avatar's background. The slot image is used to provide custom image content that will override the image property.", "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "default": "'avatar'", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "privacy": "public", "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "attribute": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "hasSlotController", "privacy": "protected", "readonly": true, "default": "new HasSlotController(this, 'status-indicator', 'image')", "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "field", "name": "image", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The image URL for the user's avatar.", "attribute": "image", "reflects": true, "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "field", "name": "initials", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The initials of the represented user.", "attribute": "initials", "reflects": true, "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "field", "name": "label", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The alt text for the avatar.", "attribute": "label", "reflects": true, "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "field", "name": "scope", "type": { "text": "any" }, "privacy": "protected", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "statusIndicatorSlotName", "type": { "text": "string" }, "privacy": "protected", "default": "'status-indicator'", "inheritedFrom": { "name": "CoreAvatar" } }, { "kind": "method", "name": "statusIndicatorTemplate", "privacy": "protected", "description": "Generates a template for the status indicator.", "inheritedFrom": { "name": "CoreAvatar" } } ], "superclass": { "name": "FluentAvatar", "package": "@charm-ux/fui" }, "tagName": "cui-avatar", "since": { "name": "1.0.0", "description": "" }, "status": { "name": "preview", "description": "" }, "customElement": true, "cssProperties": [ { "description": "determine the avatar font size.", "name": "--avatar-font-size", "inheritedFrom": { "name": "FluentAvatar" } }, { "description": "determine the background color.", "name": "--avatar-bg-color", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the avatar size.", "name": "--avatar-size", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine a round or square shape of the avatar.", "name": "--avatar-border-radius", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the background color of the status indicator.", "name": "--avatar-indicator-bg-color", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the border width of the status indicator.", "name": "--avatar-indicator-border-width", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the border color of the status indicator.", "name": "--avatar-indicator-border-color", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the border radius of the status indicator.", "name": "--avatar-indicator-border-radius", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the color of the status indicator.", "name": "--avatar-indicator-color", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the size of the status indicator.", "name": "--avatar-indicator-size", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "determine the padding of the status indicator.", "name": "--avatar-indicator-padding", "inheritedFrom": { "name": "CoreAvatar" } } ], "cssParts": [ { "description": "A wrapper around the default slot and image.", "name": "avatar-background", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "A wrapper for the entire avatar.", "name": "avatar-base", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "The image tag for the avatar.", "name": "avatar-image", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "A wrapper for the user initials.", "name": "avatar-initials", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "A wrapper for the status indicator.", "name": "avatar-status-container", "inheritedFrom": { "name": "CoreAvatar" } } ], "attributes": [ { "name": "active", "type": { "text": "AvatarActive | undefined" }, "description": "Indicates whether the avatar is in an active state.", "fieldName": "active", "parsedType": { "text": "'active' | 'inactive' | 'unset' | undefined" }, "propName": "active", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "active-appearance", "type": { "text": "AvatarActiveAppearance | undefined" }, "fieldName": "activeAppearance", "parsedType": { "text": "'ring' | 'shadow' | 'ring-shadow' | undefined" }, "propName": "activeAppearance", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "color", "type": { "text": "AvatarColor | undefined" }, "description": "Defines the color theme of the avatar.", "fieldName": "color", "parsedType": { "text": "'neutral' | 'brand' | 'colorful' | undefined" }, "propName": "color", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "id-for-color", "type": { "text": "string | undefined" }, "description": "Property to determine the color based on an ID", "fieldName": "idForColor", "propName": "idForColor", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "name", "type": { "text": "string" }, "default": "''", "description": "The name of the avatar user", "fieldName": "name", "propName": "name", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "shape", "type": { "text": "AvatarShape | undefined" }, "description": "Specifies the shape of the avatar.", "fieldName": "shape", "parsedType": { "text": "'circular' | 'square' | undefined" }, "propName": "shape", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "size", "type": { "text": "16 | 20 | 24 | 28 | 32 | 36 | 40 | 48 | 56 | 64 | 72 | 96 | 120 | 128 | undefined" }, "description": "Controls the size of the avatar.", "fieldName": "size", "propName": "size", "inheritedFrom": { "name": "FluentAvatar" } }, { "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "fieldName": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" }, "propName": "dir" }, { "name": "image", "type": { "text": "string | undefined" }, "description": "The image URL for the user's avatar.", "fieldName": "image", "inheritedFrom": { "name": "CoreAvatar" }, "propName": "image" }, { "name": "initials", "type": { "text": "string | undefined" }, "description": "The initials of the represented user.", "fieldName": "initials", "inheritedFrom": { "name": "CoreAvatar" }, "propName": "initials" }, { "name": "label", "type": { "text": "string | undefined" }, "description": "The alt text for the avatar.", "fieldName": "label", "inheritedFrom": { "name": "CoreAvatar" }, "propName": "label" } ], "events": [ { "description": "Emitted when the component is ready.", "name": "ready", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } } ], "slots": [ { "description": "Utilized for specifying the default element, typically an icon.", "name": "", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "Utilized for specifying a custom image to be used as the avatar.", "name": "image", "inheritedFrom": { "name": "CoreAvatar" } }, { "description": "Provides an indicator on the avatar, commonly using a badge or an icon element. This component should have a `label` provided for assistive technologies.", "name": "status-indicator", "inheritedFrom": { "name": "CoreAvatar" } } ], "modulePath": "src/components/avatar/avatar.ts" } ], "exports": [ { "kind": "js", "name": "CuiAvatar", "declaration": { "name": "CuiAvatar", "module": "src/components/avatar/avatar.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "CuiAvatar", "module": "src/components/avatar/avatar.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/badge/badge.ts", "declarations": [ { "kind": "class", "description": "A badge is a visual indicator that communicates a status or description of an associated component. It uses short text, color, and icons for quick recognition and is placed near the relevant content.", "name": "CuiBadge", "members": [ { "kind": "field", "name": "appearance", "type": { "text": "'filled' | 'ghost' | 'outline' | 'tint' | undefined" }, "privacy": "public", "default": "'filled'", "description": "Determines the visual appearance of the badge.", "attribute": "appearance", "reflects": true, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "method", "name": "badgeTemplate", "privacy": "protected", "return": { "type": { "text": "TemplateResult<1>" } }, "description": "Generates the HTML template for badge.", "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "color", "type": { "text": "'brand' | 'danger' | 'important' | 'informative' | 'severe' | 'subtle' | 'success' | 'warning' | undefined" }, "privacy": "public", "description": "Determines the background color of the badge.", "attribute": "color", "reflects": true, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "dependencies", "type": { "text": "(typeof CharmElement)[]" }, "privacy": "public", "static": true, "readonly": true, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "method", "name": "iconTemplate", "privacy": "protected", "description": "Generates the HTML template for the status icon.", "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "outOfOffice", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Determines presence out-of-office state.", "attribute": "out-of-office", "reflects": true, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "shape", "type": { "text": "'circular' | 'rounded' | 'square' | undefined" }, "privacy": "public", "description": "Determines the shape of the badge.", "attribute": "shape", "reflects": true, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "size", "type": { "text": "'tiny' | 'extra-small' | 'small' | 'medium' | 'large' | 'extra-large' | undefined" }, "privacy": "public", "description": "Determines the size of the badge.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "status", "type": { "text": "BadgeStatus | undefined" }, "privacy": "public", "description": "Determines status visual rendering of badge.", "attribute": "status", "reflects": true, "parsedType": { "text": "undefined | 'available' | 'away' | 'blocked' | 'busy' | 'do-not-disturb' | 'offline' | 'out-of-office' | 'unknown' | undefined" }, "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "method", "name": "statusIcon", "privacy": "protected", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "status", "type": { "text": "BadgeStatus" }, "parsedType": { "text": "undefined | 'available' | 'away' | 'blocked' | 'busy' | 'do-not-disturb' | 'offline' | 'out-of-office' | 'unknown'" } } ], "description": "Determines the name of the icon based on the status.", "inheritedFrom": { "name": "FluentBadge" } }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "default": "'badge'", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "privacy": "public", "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "attribute": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "scope", "type": { "text": "any" }, "privacy": "protected", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } } ], "superclass": { "name": "FluentBadge", "package": "@charm-ux/fui" }, "tagName": "cui-badge", "since": { "name": "1.0.0", "description": "" }, "status": { "name": "preview", "description": "" }, "customElement": true, "cssProperties": [ { "description": "determines the background color.", "name": "--badge-bg-color", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "determines the border color.", "name": "--badge-border-color", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "override css property `--badge-shape` if customs are needed.", "name": "--badge-border-radius", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "determines border style.", "name": "--badge-border-style", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "determines the border.", "name": "--badge-border-width", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "determines the color of the text.", "name": "--badge-fg-color", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "determines the padding.", "name": "--badge-padding", "inheritedFrom": { "name": "CoreBadge" } }, { "description": "used to size the badge in relation to the font.", "name": "--badge-size", "inheritedFrom": { "name": "CoreBadge" } } ], "cssParts": [ { "description": "The status icon of the badge.", "name": "badge-icon", "inheritedFrom": { "name": "FluentBadge" } }, { "description": "The component's base wrapper.", "name": "badge-base", "inheritedFrom": { "name": "CoreBadge" } } ], "attributes": [ { "name": "appearance", "type": { "text": "'filled' | 'ghost' | 'outline' | 'tint' | undefined" }, "default": "'filled'", "description": "Determines the visual appearance of the badge.", "fieldName": "appearance", "propName": "appearance", "inheritedFrom": { "name": "FluentBadge" } }, { "name": "color", "type": { "text": "'brand' | 'danger' | 'important' | 'informative' | 'severe' | 'subtle' | 'success' | 'warning' | undefined" }, "description": "Determines the background color of the badge.", "fieldName": "color", "propName": "color", "inheritedFrom": { "name": "FluentBadge" } }, { "name": "out-of-office", "type": { "text": "boolean | undefined" }, "description": "Determines presence out-of-office state.", "fieldName": "outOfOffice", "propName": "outOfOffice", "inheritedFrom": { "name": "FluentBadge" } }, { "name": "shape", "type": { "text": "'circular' | 'rounded' | 'square' | undefined" }, "description": "Determines the shape of the badge.", "fieldName": "shape", "propName": "shape", "inheritedFrom": { "name": "FluentBadge" } }, { "name": "size", "type": { "text": "'tiny' | 'extra-small' | 'small' | 'medium' | 'large' | 'extra-large' | undefined" }, "description": "Determines the size of the badge.", "fieldName": "size", "propName": "size", "inheritedFrom": { "name": "FluentBadge" } }, { "name": "status", "type": { "text": "BadgeStatus | undefined" }, "description": "Determines status visual rendering of badge.", "fieldName": "status", "parsedType": { "text": "undefined | 'available' | 'away' | 'blocked' | 'busy' | 'do-not-disturb' | 'offline' | 'out-of-office' | 'unknown' | undefined" }, "propName": "status", "inheritedFrom": { "name": "FluentBadge" } }, { "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "fieldName": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" }, "propName": "dir" } ], "events": [ { "description": "Emitted when the component is ready.", "name": "ready", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } } ], "slots": [ { "description": "The content of the badge.", "name": "", "inheritedFrom": { "name": "CoreBadge" } } ], "modulePath": "src/components/badge/badge.ts" } ], "exports": [ { "kind": "js", "name": "CuiBadge", "declaration": { "name": "CuiBadge", "module": "src/components/badge/badge.ts" } }, { "kind": "js", "name": "default", "declaration": { "name": "CuiBadge", "module": "src/components/badge/badge.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/breadcrumb-item/breadcrumb-item.ts", "declarations": [ { "kind": "class", "description": "A single breadcrumb node.", "name": "CuiBreadcrumbItem", "members": [ { "kind": "field", "name": "active", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Defines active state of the breadcrumb.", "attribute": "active", "reflects": true, "inheritedFrom": { "name": "FluentBreadcrumbItem" } }, { "kind": "field", "name": "dependencies", "type": { "text": "(typeof CharmElement)[]" }, "privacy": "public", "static": true, "readonly": true, "inheritedFrom": { "name": "FluentBreadcrumbItem" } }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large' | undefined" }, "privacy": "public", "description": "The size of the breadcrumb.", "attribute": "size", "reflects": true, "inheritedFrom": { "name": "FluentBreadcrumbItem" } }, { "kind": "field", "name": "autofocus", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Auto focuses the component on page load.", "attribute": "autofocus", "reflects": true, "inheritedFrom": { "name": "CharmFocusableElement", "module": "src/base/focusable-element/charm-focusable-element.ts" } }, { "kind": "field", "name": "baseName", "type": { "text": "string" }, "privacy": "public", "static": true, "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" }, "default": "'breadcrumb-item'" }, { "kind": "method", "name": "breadcrumbItemControlTemplate", "privacy": "protected", "description": "Generates the HTML template for the control.", "inheritedFrom": { "name": "CoreBreadcrumbItem" } }, { "kind": "method", "name": "breadcrumbItemSeparatorTemplate", "privacy": "protected", "description": "Generates the HTML template for the separator.", "inheritedFrom": { "name": "CoreBreadcrumbItem" } }, { "kind": "method", "name": "breadcrumbItemTemplate", "privacy": "protected", "description": "Generates the HTML template for the breadcrumb item.", "inheritedFrom": { "name": "CoreBreadcrumbItem" } }, { "kind": "field", "name": "current", "type": { "text": "'page' | 'step' | undefined" }, "privacy": "public", "description": "Sets `aria-current` on the div.", "attribute": "current", "reflects": true, "inheritedFrom": { "name": "CoreBreadcrumbItem" } }, { "kind": "field", "name": "dir", "type": { "text": "'ltr' | 'rtl' | 'auto'" }, "privacy": "public", "description": "The dir global attribute is an enumerated attribute that indicates the directionality of the element's text.", "attribute": "dir", "inheritedFrom": { "name": "CharmElement", "module": "src/base/charm-element/charm-element.ts" } }, { "kind": "field", "name": "focusableEventOptions", "type": { "text": "CustomEventInit" }, "privacy": "protected", "default": "{}", "inheritedFrom": { "name": "CharmFocusableElement", "module": "src/base/focusable-element/charm-focusable-element.ts" } }, { "kind": "field", "name": "hadFocus", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "CharmFocusableElement", "module": "src/base/focusable-element/charm-focusable-element.ts" } }, { "kind": "method", "name": "handleBlur", "privacy": "protected", "inheritedFrom": { "name": "CharmFocusableElement", "module": "src/base/focusable-element/charm-focusable-element.ts" } }, { "kind": "method", "name": "handleFocus", "privacy": "protected", "inheritedFrom": { "name": "CharmFocusableElement", "module": "src/base/focusable-element/charm-focusable-element.ts" } }, { "kind": "field", "name": "hasFocus", "type": { "text": "boolean" }, "privacy": "protected", "default": "false", "inheritedFrom": { "name": "CharmFocusableElement", "module": "src/base/focusable-element/charm-focusable-element.ts" } }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "privacy": "public", "description": "When set, the underlying button will be rendered as an `` with this `href`\ninstead of a `