@carbon/ibm-products-web-components
Version:
Carbon for IBM Products Web Components
99 lines • 3.2 kB
TypeScript
/**
* @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/components/popover/index.js';
export declare const blockClass = "c4p--coachmark";
declare const CDSCoachmark_base: {
new (...args: any[]): {
_handles: Set<import("@carbon/web-components/es/globals/internal/handle").default>;
connectedCallback(): void;
disconnectedCallback(): void;
};
_hostListeners: {
[listenerName: string]: {
[type: string]: {
options?: boolean | AddEventListenerOptions;
};
};
};
} & typeof LitElement & (new (...args: any[]) => import("@lit-labs/signals").SignalWatcherApi);
/**
* coachmark main component
* @element c4p-coachmark
* @fires c4p-coachmark-opened
* The custom event fired when the coachmark is opened.
* This event can be used to perform actions such as focusing elements when the coachmark becomes visible.
* @fires c4p-coachmark-closed
* The custom event fired when the coachmark is closed.
* This event can be used to perform actions such as restoring focus when the coachmark is dismissed.
*/
declare class CDSCoachmark extends CDSCoachmark_base {
/**
* Specifies whether the component is currently open.
*/
open: boolean;
/**
* Where to render the Coachmark relative to its target.
*/
align?: string;
/**
* Fine tune the position of the target in pixels.
*/
position?: {
x: number;
y: number;
};
/**
* Specifies whether the component is floating or not.
*/
floating?: boolean;
/**
* Specify whether the component should be rendered on high-contrast.
*/
highContrast?: boolean;
/**
* Specify whether a drop shadow should be rendered on the popover.
*/
dropShadow?: boolean;
/**
* Specify whether a caret should be rendered on the popover. This is intended to use only for coachmark patterns.
*/
caret?: boolean;
/**
* CSS selector for the element that should receive focus when the coachmark opens.
* If not provided, no automatic focus management will occur.
*/
selectorPrimaryFocus?: string;
/**
* Aria label for when the floating coachmark is picked up for dragging.
*/
dragAriaLabel?: string;
private dragCleanup;
private keydownHandler;
private moveCounter;
private isDragging;
private moveAnnouncement;
disconnectedCallback(): void;
private setupDraggable;
firstUpdated(): void;
updated(changedProps: Map<string, unknown>): void;
private handlePopoverClosed;
render(): import("lit-html").TemplateResult<1>;
/**
* The name of the custom event fired when this coachmark is opened.
*/
static get eventOpen(): string;
/**
* The name of the custom event fired when this coachmark is closed.
*/
static get eventClose(): string;
static styles: any;
}
export default CDSCoachmark;
//# sourceMappingURL=coachmark.d.ts.map