import React from "react"; import { XmArtifact as XmArtifactElement } from "../lit/components/artifact/index.js"; /** * A generic type for strongly typing custom events with their targets * @template T - The type of the event target (extends EventTarget) * @template D - The type of the detail payload for the custom event */ type TypedEvent = E & { target: T; }; /** `XmArtifact` component event */ export type XmArtifactElementEvent = TypedEvent< XmArtifactElement, E >; export type { XmArtifactElement }; export interface XmArtifactProps extends Pick< React.AllHTMLAttributes, | "children" | "dir" | "hidden" | "id" | "lang" | "slot" | "style" | "title" | "translate" | "onClick" | "onFocus" | "onBlur" > { /** undefined */ showRefresh?: boolean; /** undefined */ showClose?: boolean; /** undefined */ title?: XmArtifactElement["title"]; /** undefined */ subCsv?: XmArtifactElement["subCsv"]; /** undefined */ view?: XmArtifactElement["view"]; /** A space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method `Document.getElementsByClassName()`. */ className?: string; /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */ exportparts?: string; /** Used for labels to link them with their inputs (using input id). */ htmlFor?: string; /** Used to help React identify which items have changed, are added, or are removed within a list. */ key?: number | string; /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */ part?: string; /** A mutable ref object whose `.current` property is initialized to the passed argument (`initialValue`). The returned object will persist for the full lifetime of the component. */ ref?: React.Ref; /** Allows developers to make HTML elements focusable, allow or prevent them from being sequentially focusable (usually with the `Tab` key, hence the name) and determine their relative ordering for sequential focus navigation. */ tabIndex?: number; /** Fired when the element requests to close. */ onClose?: (event: XmArtifactElementEvent) => void; /** Fired when a refresh is requested. */ onRefresh?: (event: XmArtifactElementEvent) => void; /** Fired when the active view changes. */ onViewChange?: (event: XmArtifactElementEvent) => void; } /** * * * ## Attributes & Properties * * Component attributes and properties that can be applied to the element or by using JavaScript. * * - `title`: undefined * - `sub-csv`/`subCsv`: undefined * - `view`: undefined * - `show-refresh`/`showRefresh`: undefined * - `show-close`/`showClose`: undefined * - `sub`: undefined (property only) * * ## Events * * Events that will be emitted by the component. * * - `close`: Fired when the element requests to close. * - `refresh`: Fired when a refresh is requested. * - `view-change`: Fired when the active view changes. * * ## Methods * * Methods that can be called to access component functionality. * * - `setBodies(preview: ChildNode[], code: ChildNode[]) => void`: Imperatively set the preview/code body nodes from a host. Replaces any * authored or previously-set bodies. Used by to hand the * panel its slot content; the chat shell can't author them as direct * children of the lit-rendered tag without the snapshot * timing race that this method sidesteps. */ export const XmArtifact: React.ForwardRefExoticComponent;