@carbon/ibm-products-web-components 0.26.0-rc.0 → 0.27.0-rc.0

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.d.ts

@@ -0,0 +1,397 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+import '@carbon/web-components/es-custom/components/button/button.js';
+import { BEACON_KIND } from './defs';
+declare const CDSCoachmarkBeacon_base: {
+    new (...args: any[]): {
+        _handles: Set<import("@carbon/web-components/es/globals/internal/handle").default>;
+        connectedCallback(): void;
+        disconnectedCallback(): void;
+        accessKey: string;
+        readonly accessKeyLabel: string;
+        autocapitalize: string;
+        dir: string;
+        draggable: boolean;
+        hidden: boolean;
+        inert: boolean;
+        innerText: string;
+        lang: string;
+        readonly offsetHeight: number;
+        readonly offsetLeft: number;
+        readonly offsetParent: Element | null;
+        readonly offsetTop: number;
+        readonly offsetWidth: number;
+        outerText: string;
+        popover: string | null;
+        spellcheck: boolean;
+        title: string;
+        translate: boolean;
+        writingSuggestions: string;
+        attachInternals(): ElementInternals;
+        click(): void;
+        hidePopover(): void;
+        showPopover(): void;
+        togglePopover(force?: boolean): boolean;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+        readonly attributes: NamedNodeMap;
+        readonly classList: DOMTokenList;
+        className: string;
+        readonly clientHeight: number;
+        readonly clientLeft: number;
+        readonly clientTop: number;
+        readonly clientWidth: number;
+        readonly currentCSSZoom: number;
+        id: string;
+        innerHTML: string;
+        readonly localName: string;
+        readonly namespaceURI: string | null;
+        onfullscreenchange: ((this: Element, ev: Event) => any) | null;
+        onfullscreenerror: ((this: Element, ev: Event) => any) | null;
+        outerHTML: string;
+        readonly ownerDocument: Document;
+        readonly part: DOMTokenList;
+        readonly prefix: string | null;
+        readonly scrollHeight: number;
+        scrollLeft: number;
+        scrollTop: number;
+        readonly scrollWidth: number;
+        readonly shadowRoot: ShadowRoot | null;
+        slot: string;
+        readonly tagName: string;
+        attachShadow(init: ShadowRootInit): ShadowRoot;
+        checkVisibility(options?: CheckVisibilityOptions): boolean;
+        closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K] | null;
+        closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K] | null;
+        closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K] | null;
+        closest<E extends Element = Element>(selectors: string): E | null;
+        computedStyleMap(): StylePropertyMapReadOnly;
+        getAttribute(qualifiedName: string): string | null;
+        getAttributeNS(namespace: string | null, localName: string): string | null;
+        getAttributeNames(): string[];
+        getAttributeNode(qualifiedName: string): Attr | null;
+        getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;
+        getBoundingClientRect(): DOMRect;
+        getClientRects(): DOMRectList;
+        getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
+        getElementsByTagName<K extends keyof HTMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
+        getElementsByTagName<K extends keyof SVGElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
+        getElementsByTagName<K extends keyof MathMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
+        getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
+        getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
+        getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;
+        getHTML(options?: GetHTMLOptions): string;
+        hasAttribute(qualifiedName: string): boolean;
+        hasAttributeNS(namespace: string | null, localName: string): boolean;
+        hasAttributes(): boolean;
+        hasPointerCapture(pointerId: number): boolean;
+        insertAdjacentElement(where: InsertPosition, element: Element): Element | null;
+        insertAdjacentHTML(position: InsertPosition, string: string): void;
+        insertAdjacentText(where: InsertPosition, data: string): void;
+        matches(selectors: string): boolean;
+        releasePointerCapture(pointerId: number): void;
+        removeAttribute(qualifiedName: string): void;
+        removeAttributeNS(namespace: string | null, localName: string): void;
+        removeAttributeNode(attr: Attr): Attr;
+        requestFullscreen(options?: FullscreenOptions): Promise<void>;
+        requestPointerLock(options?: PointerLockOptions): Promise<void>;
+        scroll(options?: ScrollToOptions): void;
+        scroll(x: number, y: number): void;
+        scrollBy(options?: ScrollToOptions): void;
+        scrollBy(x: number, y: number): void;
+        scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
+        scrollTo(options?: ScrollToOptions): void;
+        scrollTo(x: number, y: number): void;
+        setAttribute(qualifiedName: string, value: string): void;
+        setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
+        setAttributeNode(attr: Attr): Attr | null;
+        setAttributeNodeNS(attr: Attr): Attr | null;
+        setHTMLUnsafe(html: string): void;
+        setPointerCapture(pointerId: number): void;
+        toggleAttribute(qualifiedName: string, force?: boolean): boolean;
+        webkitMatchesSelector(selectors: string): boolean;
+        readonly baseURI: string;
+        readonly childNodes: NodeListOf<ChildNode>;
+        readonly firstChild: ChildNode | null;
+        readonly isConnected: boolean;
+        readonly lastChild: ChildNode | null;
+        readonly nextSibling: ChildNode | null;
+        readonly nodeName: string;
+        readonly nodeType: number;
+        nodeValue: string | null;
+        readonly parentElement: HTMLElement | null;
+        readonly parentNode: ParentNode | null;
+        readonly previousSibling: ChildNode | null;
+        textContent: string | null;
+        appendChild<T_1 extends Node>(node: T_1): T_1;
+        cloneNode(deep?: boolean): Node;
+        compareDocumentPosition(other: Node): number;
+        contains(other: Node | null): boolean;
+        getRootNode(options?: GetRootNodeOptions): Node;
+        hasChildNodes(): boolean;
+        insertBefore<T_1 extends Node>(node: T_1, child: Node | null): T_1;
+        isDefaultNamespace(namespace: string | null): boolean;
+        isEqualNode(otherNode: Node | null): boolean;
+        isSameNode(otherNode: Node | null): boolean;
+        lookupNamespaceURI(prefix: string | null): string | null;
+        lookupPrefix(namespace: string | null): string | null;
+        normalize(): void;
+        removeChild<T_1 extends Node>(child: T_1): T_1;
+        replaceChild<T_1 extends Node>(node: Node, child: T_1): T_1;
+        readonly ELEMENT_NODE: 1;
+        readonly ATTRIBUTE_NODE: 2;
+        readonly TEXT_NODE: 3;
+        readonly CDATA_SECTION_NODE: 4;
+        readonly ENTITY_REFERENCE_NODE: 5;
+        readonly ENTITY_NODE: 6;
+        readonly PROCESSING_INSTRUCTION_NODE: 7;
+        readonly COMMENT_NODE: 8;
+        readonly DOCUMENT_NODE: 9;
+        readonly DOCUMENT_TYPE_NODE: 10;
+        readonly DOCUMENT_FRAGMENT_NODE: 11;
+        readonly NOTATION_NODE: 12;
+        readonly DOCUMENT_POSITION_DISCONNECTED: 1;
+        readonly DOCUMENT_POSITION_PRECEDING: 2;
+        readonly DOCUMENT_POSITION_FOLLOWING: 4;
+        readonly DOCUMENT_POSITION_CONTAINS: 8;
+        readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
+        readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
+        dispatchEvent(event: Event): boolean;
+        ariaAtomic: string | null;
+        ariaAutoComplete: string | null;
+        ariaBrailleLabel: string | null;
+        ariaBrailleRoleDescription: string | null;
+        ariaBusy: string | null;
+        ariaChecked: string | null;
+        ariaColCount: string | null;
+        ariaColIndex: string | null;
+        ariaColIndexText: string | null;
+        ariaColSpan: string | null;
+        ariaCurrent: string | null;
+        ariaDescription: string | null;
+        ariaDisabled: string | null;
+        ariaExpanded: string | null;
+        ariaHasPopup: string | null;
+        ariaHidden: string | null;
+        ariaInvalid: string | null;
+        ariaKeyShortcuts: string | null;
+        ariaLabel: string | null;
+        ariaLevel: string | null;
+        ariaLive: string | null;
+        ariaModal: string | null;
+        ariaMultiLine: string | null;
+        ariaMultiSelectable: string | null;
+        ariaOrientation: string | null;
+        ariaPlaceholder: string | null;
+        ariaPosInSet: string | null;
+        ariaPressed: string | null;
+        ariaReadOnly: string | null;
+        ariaRequired: string | null;
+        ariaRoleDescription: string | null;
+        ariaRowCount: string | null;
+        ariaRowIndex: string | null;
+        ariaRowIndexText: string | null;
+        ariaRowSpan: string | null;
+        ariaSelected: string | null;
+        ariaSetSize: string | null;
+        ariaSort: string | null;
+        ariaValueMax: string | null;
+        ariaValueMin: string | null;
+        ariaValueNow: string | null;
+        ariaValueText: string | null;
+        role: string | null;
+        animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;
+        getAnimations(options?: GetAnimationsOptions): Animation[];
+        after(...nodes: (Node | string)[]): void;
+        before(...nodes: (Node | string)[]): void;
+        remove(): void;
+        replaceWith(...nodes: (Node | string)[]): void;
+        readonly nextElementSibling: Element | null;
+        readonly previousElementSibling: Element | null;
+        readonly childElementCount: number;
+        readonly children: HTMLCollection;
+        readonly firstElementChild: Element | null;
+        readonly lastElementChild: Element | null;
+        append(...nodes: (Node | string)[]): void;
+        prepend(...nodes: (Node | string)[]): void;
+        querySelector<K extends keyof HTMLElementTagNameMap>(selectors: K): HTMLElementTagNameMap[K] | null;
+        querySelector<K extends keyof SVGElementTagNameMap>(selectors: K): SVGElementTagNameMap[K] | null;
+        querySelector<K extends keyof MathMLElementTagNameMap>(selectors: K): MathMLElementTagNameMap[K] | null;
+        querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;
+        querySelector<E extends Element = Element>(selectors: string): E | null;
+        querySelectorAll<K extends keyof HTMLElementTagNameMap>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;
+        querySelectorAll<K extends keyof SVGElementTagNameMap>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;
+        querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
+        querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
+        querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
+        replaceChildren(...nodes: (Node | string)[]): void;
+        readonly assignedSlot: HTMLSlotElement | null;
+        readonly attributeStyleMap: StylePropertyMap;
+        readonly style: CSSStyleDeclaration;
+        contentEditable: string;
+        enterKeyHint: string;
+        inputMode: string;
+        readonly isContentEditable: boolean;
+        onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
+        onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onauxclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;
+        onbeforetoggle: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
+        oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncontextmenu: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
+        oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
+        ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onerror: OnErrorEventHandler;
+        onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
+        onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null;
+        ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null;
+        onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null;
+        onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
+        onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null;
+        onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;
+        onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontoggle: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;
+        autofocus: boolean;
+        readonly dataset: DOMStringMap;
+        nonce?: string;
+        tabIndex: number;
+        blur(): void;
+        focus(options?: FocusOptions): void;
+    };
+    _hostListeners: {
+        [listenerName: string]: {
+            [type: string]: {
+                options?: boolean | AddEventListenerOptions;
+            };
+        };
+    };
+} & typeof LitElement;
+/**
+ * CoachmarkBeacon.
+ *
+ * @element c4p-coachmark-beacon
+ * @fires c4p-coachmark-beacon-clicked Custom event fired when beacon is clicked
+ * */
+declare class CDSCoachmarkBeacon extends CDSCoachmarkBeacon_base {
+    /**
+     * What style of beacon.
+     * BEACON_KIND is an enum from the Coachmark and can be used for this value.
+     * @see {@Link BEACON_KIND}
+     */
+    kind?: BEACON_KIND;
+    /**
+     * The aria label.
+     */
+    label: string;
+    /**
+     * id for the coachmark beacon
+     */
+    id: string;
+    private expanded;
+    firstUpdated(): void;
+    private _handleClick;
+    private handleOutsideClick;
+    render(): import("lit-html").TemplateResult<1>;
+    static shadowRootOptions: {
+        delegatesFocus: boolean;
+        mode: ShadowRootMode;
+        serializable?: boolean;
+        slotAssignment?: SlotAssignmentMode;
+        customElements?: CustomElementRegistry;
+        registry?: CustomElementRegistry;
+    };
+    static get beaconClicked(): string;
+    static styles: any;
+}
+export default CDSCoachmarkBeacon;

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.js

@@ -0,0 +1,126 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { __decorate } from 'tslib';
+import { LitElement, html } from 'lit';
+import { property, state } from 'lit/decorators.js';
+import { prefix } from '../../../globals/settings.js';
+import HostListenerMixin from '@carbon/web-components/es/globals/mixins/host-listener.js';
+import { carbonElement } from '@carbon/web-components/es/globals/decorators/carbon-element.js';
+import styles from './coachmark-beacon.scss.js';
+import '@carbon/web-components/es-custom/components/button/button.js';
+import { BEACON_KIND } from './defs.js';
+
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const blockClass = `${prefix}--coachmark-beacon`;
+/**
+ * CoachmarkBeacon.
+ *
+ * @element c4p-coachmark-beacon
+ * @fires c4p-coachmark-beacon-clicked Custom event fired when beacon is clicked
+ * */
+let CDSCoachmarkBeacon = class CDSCoachmarkBeacon extends HostListenerMixin(LitElement) {
+    constructor() {
+        super(...arguments);
+        /**
+         * What style of beacon.
+         * BEACON_KIND is an enum from the Coachmark and can be used for this value.
+         * @see {@Link BEACON_KIND}
+         */
+        this.kind = BEACON_KIND.DEFAULT;
+        /**
+         * The aria label.
+         */
+        this.label = 'Show information';
+        /**
+         * id for the coachmark beacon
+         */
+        this.id = crypto.randomUUID();
+        this.expanded = false;
+        this.handleOutsideClick = (event) => {
+            if (!this.contains(event.target)) {
+                this.expanded = false;
+                document.removeEventListener('click', this.handleOutsideClick);
+            }
+        };
+    }
+    firstUpdated() {
+        this.classList.add(blockClass);
+        if (this.kind) {
+            this.classList.add(`${blockClass}-${this.kind}`);
+        }
+    }
+    _handleClick() {
+        this.expanded = !this.expanded;
+        if (this.expanded) {
+            document.addEventListener('click', this.handleOutsideClick);
+        }
+        else {
+            document.removeEventListener('click', this.handleOutsideClick);
+        }
+        this.dispatchEvent(new CustomEvent(this.constructor.beaconClicked, {
+            detail: { expanded: this.expanded },
+            bubbles: true,
+            composed: true,
+        }));
+    }
+    render() {
+        return html `
+      <cds-custom-button
+        class="${blockClass}__target"
+        type="button"
+        id=${this.id}
+        aria-expanded="${String(this.expanded)}"
+        @click=${this._handleClick}
+      >
+        <slot name="icon">
+          <svg
+            class="${blockClass}__center"
+            aria-label=${this.label}
+            width="76"
+            height="76"
+            viewBox="0 0 76 76"
+          >
+            <title>${this.label}</title>
+            <circle r="1" cx="36" cy="36"></circle>
+          </svg>
+        </slot>
+      </cds-custom-button>
+    `;
+    }
+    static get beaconClicked() {
+        return `${prefix}-coachmark-beacon-clicked`;
+    }
+};
+CDSCoachmarkBeacon.shadowRootOptions = Object.assign(Object.assign({}, LitElement.shadowRootOptions), { delegatesFocus: true });
+CDSCoachmarkBeacon.styles = styles;
+__decorate([
+    property({ reflect: true })
+], CDSCoachmarkBeacon.prototype, "kind", void 0);
+__decorate([
+    property({ type: String, reflect: true })
+], CDSCoachmarkBeacon.prototype, "label", void 0);
+__decorate([
+    property({ type: String, reflect: true })
+], CDSCoachmarkBeacon.prototype, "id", void 0);
+__decorate([
+    state()
+], CDSCoachmarkBeacon.prototype, "expanded", void 0);
+CDSCoachmarkBeacon = __decorate([
+    carbonElement(`${prefix}-coachmark-beacon`)
+], CDSCoachmarkBeacon);
+var CDSCoachmarkBeacon$1 = CDSCoachmarkBeacon;
+
+export { CDSCoachmarkBeacon$1 as default };
+//# sourceMappingURL=coachmark-beacon.js.map

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coachmark-beacon.js","sources":["../../../../src/components/coachmark/coachmark-beacon/coachmark-beacon.ts"],"sourcesContent":[null],"names":["customElement"],"mappings":";;;;;;;;;;;;;;;;;AAAA;;;;;;;AAOG;AAWH,MAAM,UAAU,GAAG,CAAG,EAAA,MAAM,oBAAoB;AAEhD;;;;;AAKK;AAEL,IAAM,kBAAkB,GAAxB,MAAM,kBAAmB,SAAQ,iBAAiB,CAAC,UAAU,CAAC,CAAA;AAA9D,IAAA,WAAA,GAAA;;AACE;;;;AAIG;AAEH,QAAA,IAAA,CAAA,IAAI,GAAiB,WAAW,CAAC,OAAO;AAExC;;AAEG;QAEH,IAAK,CAAA,KAAA,GAAG,kBAAkB;AAC1B;;AAEG;AAEH,QAAA,IAAA,CAAA,EAAE,GAAW,MAAM,CAAC,UAAU,EAAE;QAEf,IAAQ,CAAA,QAAA,GAAG,KAAK;AA8BzB,QAAA,IAAA,CAAA,kBAAkB,GAAG,CAAC,KAAY,KAAI;YAC5C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAc,CAAC,EAAE;AACxC,gBAAA,IAAI,CAAC,QAAQ,GAAG,KAAK;gBACrB,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,CAAC;;AAElE,SAAC;;IAjCD,YAAY,GAAA;AACV,QAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC;AAC9B,QAAA,IAAI,IAAI,CAAC,IAAI,EAAE;AACb,YAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA,EAAG,UAAU,CAAA,CAAA,EAAI,IAAI,CAAC,IAAI,CAAA,CAAE,CAAC;;;IAI5C,YAAY,GAAA;AAClB,QAAA,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ;AAE9B,QAAA,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,CAAC;;aACtD;YACL,QAAQ,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,CAAC;;QAGhE,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CACZ,IAAI,CAAC,WAAyC,CAAC,aAAa,EAC7D;AACE,YAAA,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE;AACnC,YAAA,OAAO,EAAE,IAAI;AACb,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA,CACF,CACF;;IAUH,MAAM,GAAA;AACJ,QAAA,OAAO,IAAI,CAAA;;iBAEE,UAAU,CAAA;;AAEd,WAAA,EAAA,IAAI,CAAC,EAAE;AACK,uBAAA,EAAA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;AAC7B,eAAA,EAAA,IAAI,CAAC,YAAY;;;;qBAIb,UAAU,CAAA;AACN,uBAAA,EAAA,IAAI,CAAC,KAAK;;;;;AAKd,mBAAA,EAAA,IAAI,CAAC,KAAK,CAAA;;;;;KAK1B;;AAOH,IAAA,WAAW,aAAa,GAAA;QACtB,OAAO,CAAA,EAAG,MAAM,CAAA,yBAAA,CAA2B;;;AANtC,kBAAiB,CAAA,iBAAA,GAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EACnB,UAAU,CAAC,iBAAiB,KAC/B,cAAc,EAAE,IAAI,EAAA,CAFE;AASjB,kBAAM,CAAA,MAAA,GAAG,MAAH;AAnFb,UAAA,CAAA;AADC,IAAA,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE;AACc,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,MAAA,EAAA,MAAA,CAAA;AAMzC,UAAA,CAAA;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE;AACd,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,OAAA,EAAA,MAAA,CAAA;AAK3B,UAAA,CAAA;IADC,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE;AACR,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,IAAA,EAAA,MAAA,CAAA;AAEhB,UAAA,CAAA;AAAhB,IAAA,KAAK;AAA4B,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,UAAA,EAAA,MAAA,CAAA;AApB9B,kBAAkB,GAAA,UAAA,CAAA;AADvB,IAAAA,aAAa,CAAC,CAAA,EAAG,MAAM,CAAA,iBAAA,CAAmB;AACrC,CAAA,EAAA,kBAAkB,CA2FvB;AACD,2BAAe,kBAAkB;;;;"}

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.scss.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { css } from 'lit';
+
+var styles = css([".c4p--coachmark-beacon{position:relative}.c4p--coachmark-beacon-default .c4p--coachmark-beacon__target:before{display:none}.c4p--coachmark-beacon-default .c4p--coachmark-beacon__target:after{background-color:#4589ff;block-size:.75rem;border-radius:50%;content:\"\";inline-size:.75rem;inset-block-start:.625rem;inset-inline-start:.625rem;position:absolute}.c4p--coachmark-beacon-default .c4p--coachmark-beacon__target:focus{outline:transparent}.c4p--coachmark-beacon-default .c4p--coachmark-beacon__target:focus:before{block-size:18px;border-radius:100%;content:\"\";display:block;inline-size:18px;inset-block-start:7px;inset-inline-start:7px;outline:.125rem var(--cds-focus,#0f62fe) solid;position:absolute}.c4p--coachmark-beacon .c4p--coachmark-beacon__target{background-color:transparent;block-size:2rem;border:none;border-radius:50%;cursor:pointer;display:flex;inline-size:2rem;padding:0}.c4p--coachmark-beacon .c4p--coachmark-beacon__target[aria-expanded=true] circle{animation:none}.c4p--coachmark-beacon__center{block-size:5rem;inline-size:5rem;inset-block-start:-1.375rem;inset-inline-start:-1.375rem;pointer-events:none;position:absolute;z-index:6900}.c4p--coachmark-beacon__center circle{animation:ripple 2s infinite;fill:var(--cds-support-info,#0043ce);fill-opacity:0;-webkit-mask-image:none;mask-image:none;stroke:var(--cds-support-info,#0043ce);stroke-opacity:0;stroke-width:1px;transition-timing-function:motion exit,productive}@media (prefers-reduced-motion){.c4p--coachmark-beacon__center circle{animation:none}}@keyframes ripple{0%{fill-opacity:0;r:1px;stroke-opacity:0;transition-timing-function:cubic-bezier(0,0,.38,.9)}31%{fill-opacity:.2;stroke-opacity:1}62%{fill-opacity:0;r:32px;stroke-opacity:0}to{fill-opacity:0;r:32px;stroke-opacity:0}}@keyframes ring-ripple{0%{fill-opacity:0;r:12px;stroke-opacity:0;transition-timing-function:cubic-bezier(0,0,.38,.9)}31%{fill-opacity:.2;stroke-opacity:1}62%{fill-opacity:0;r:32px;stroke-opacity:0}to{fill-opacity:0;r:32px;stroke-opacity:0}}:host(c4p-coachmark-beacon){position:relative}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target:before{display:none}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target:after{background-color:#4589ff;block-size:.75rem;border-radius:50%;content:\"\";inline-size:.75rem;inset-block-start:.625rem;inset-inline-start:.625rem;position:absolute}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target:focus{outline:transparent}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target:focus:before{block-size:18px;border-radius:100%;content:\"\";display:block;inline-size:18px;inset-block-start:7px;inset-inline-start:7px;outline:.125rem var(--cds-focus,#0f62fe) solid;position:absolute}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target{background-color:transparent;block-size:2rem;border:none;border-radius:50%;box-shadow:none;cursor:pointer;display:flex;inline-size:2rem;padding:0}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target[aria-expanded=true] circle{animation:none}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target::part(button){background-color:transparent;max-block-size:0;min-block-size:0;padding-inline:0}:host(.c4p--coachmark-beacon-default) .c4p--coachmark-beacon__target::part(button):focus{border-color:transparent;box-shadow:none}"]);
+
+export { styles as default };
+//# sourceMappingURL=coachmark-beacon.scss.js.map

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.scss.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coachmark-beacon.scss.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.test.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import './index';

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.test.js

@@ -0,0 +1,70 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { describe, it, expect } from 'vitest';
+import { fixture, oneEvent, html } from '@open-wc/testing';
+import './coachmark-beacon.js';
+import { prefix } from '../../../globals/settings.js';
+
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const blockClass = `${prefix}--coachmark-beacon`;
+const defaultProps = {
+    label: 'show information',
+    id: 'coachmarkBeacon',
+};
+const template = (props = defaultProps) => html `
+  <c4p-coachmark-beacon
+    label=${props.label}
+    @c4p-coachmark-beacon-clicked=${(e) => {
+    console.log('Beacon clicked!', e.detail.expanded);
+}}
+  >
+  </c4p-coachmark-beacon>
+`;
+describe('c4p-coachmark-beacon', () => {
+    it('should render a beacon', async () => {
+        const beacon = await fixture(template(Object.assign({}, defaultProps)));
+        expect(beacon).toBeDefined();
+    });
+    it('has correct host classes', async () => {
+        const el = await fixture(template(Object.assign({}, defaultProps)));
+        expect(el.classList.contains(blockClass)).to.be.true;
+        expect(el.classList.contains(`${blockClass}-default`)).to.be.true;
+    });
+    it('applies className to the containing node', async () => {
+        const customClass = 'test';
+        const beacon = await fixture(template(Object.assign({}, defaultProps)));
+        beacon.classList.add(customClass);
+        expect(beacon.getAttribute('class')).to.include(customClass);
+    });
+    it('should render icon for the beacon', async () => {
+        var _a;
+        const beacon = await fixture(template(Object.assign({}, defaultProps)));
+        const renderedSVG = (_a = beacon === null || beacon === void 0 ? void 0 : beacon.shadowRoot) === null || _a === void 0 ? void 0 : _a.querySelector('slot[name="icon"]');
+        expect(renderedSVG).to.exist;
+        const assignedNodes = renderedSVG.assignedNodes({ flatten: true });
+        const svg = assignedNodes.find((node) => node.nodeName.toLowerCase() === 'svg');
+        expect(svg).to.exist;
+    });
+    it('toggles expanded state and dispatches event on click', async () => {
+        const el = await fixture(template(Object.assign({}, defaultProps)));
+        const button = el.shadowRoot.querySelector('cds-custom-button');
+        const eventPromise = oneEvent(el, 'c4p-coachmark-beacon-clicked');
+        button.click();
+        const event = await eventPromise;
+        expect(event).to.exist;
+        expect(event.detail.expanded).to.be.true;
+    });
+});
+//# sourceMappingURL=coachmark-beacon.test.js.map

package/es-custom/components/coachmark/coachmark-beacon/coachmark-beacon.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coachmark-beacon.test.js","sources":["../../../../src/components/coachmark/coachmark-beacon/coachmark-beacon.test.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;;AAOG;AAOH,MAAM,UAAU,GAAG,CAAG,EAAA,MAAM,oBAAoB;AAEhD,MAAM,YAAY,GAAG;AACnB,IAAA,KAAK,EAAE,kBAAkB;AACzB,IAAA,EAAE,EAAE,iBAAiB;CACf;AAER,MAAM,QAAQ,GAAG,CAAC,KAAK,GAAG,YAAY,KAAK,IAAI,CAAA;;AAEnC,UAAA,EAAA,KAAK,CAAC,KAAK;oCACa,CAAC,CAAc,KAAI;IACjD,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;AACnD,CAAC;;;CAGJ;AAED,QAAQ,CAAC,sBAAsB,EAAE,MAAK;AACpC,IAAA,EAAE,CAAC,wBAAwB,EAAE,YAAW;QACtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAM,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,YAAY,CAAG,CAAA,CAAC;AAC3D,QAAA,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE;AAC9B,KAAC,CAAC;AAEF,IAAA,EAAE,CAAC,0BAA0B,EAAE,YAAW;QACxC,MAAM,EAAE,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAM,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,YAAY,CAAG,CAAA,CAAC;AAEvD,QAAA,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI;AACpD,QAAA,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAG,EAAA,UAAU,CAAU,QAAA,CAAA,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI;AACnE,KAAC,CAAC;AAEF,IAAA,EAAE,CAAC,0CAA0C,EAAE,YAAW;QACxD,MAAM,WAAW,GAAG,MAAM;QAC1B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAM,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,YAAY,CAAG,CAAA,CAAC;AAC3D,QAAA,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC;AACjC,QAAA,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;AAC9D,KAAC,CAAC;AAEF,IAAA,EAAE,CAAC,mCAAmC,EAAE,YAAW;;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAM,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,YAAY,CAAG,CAAA,CAAC;AAC3D,QAAA,MAAM,WAAW,GAAG,CAAA,EAAA,GAAA,MAAM,aAAN,MAAM,KAAA,MAAA,GAAA,MAAA,GAAN,MAAM,CAAE,UAAU,MAAE,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAA,aAAa,CACnD,mBAAmB,CACD;AACpB,QAAA,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK;AAC5B,QAAA,MAAM,aAAa,GAAG,WAAW,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAClE,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,CAC5B,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,KAAK,CAClC;AACf,QAAA,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK;AACtB,KAAC,CAAC;AAEF,IAAA,EAAE,CAAC,sDAAsD,EAAE,YAAW;QACpE,MAAM,EAAE,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAM,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,YAAY,CAAG,CAAA,CAAC;QAEvD,MAAM,MAAM,GAAG,EAAE,CAAC,UAAW,CAAC,aAAa,CAAc,YAAY,CAAE;QAEvE,MAAM,YAAY,GAAG,QAAQ,CAAC,EAAE,EAAE,8BAA8B,CAAC;QAEjE,MAAM,CAAC,KAAK,EAAE;AAEd,QAAA,MAAM,KAAK,GAAG,MAAM,YAAY;AAChC,QAAA,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK;AACtB,QAAA,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI;AAC1C,KAAC,CAAC;AACJ,CAAC,CAAC"}

package/es-custom/components/coachmark/coachmark-beacon/defs.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Reserved for future expansion, i.e. "RING".
+ */
+export declare enum BEACON_KIND {
+    DEFAULT = "default"
+}