sandai-react
Version:
React components and utilities for the Sandai 3D AI Characters.
37 lines • 1.34 kB
TypeScript
import { SandaiClient } from "sandai-core";
/**
* Props for the AI3DCharacterDocs component.
*
* @property {SandaiClient} client - The SandaiClient instance you retrieve from the [AI3DCharacter] components [onLoad] callback.
* ```js
* <AI3DCharacter
onLoad={handleLoad}
url="https://sandai.org/chat"
showControls
/>
```
*/
export type AI3DCharacterDocsProps = {
client: SandaiClient;
};
/**
* AI3DCharacterDocs is a React component that dynamically renders
* interactive documentation for functions exposed by the provided
* SandaiClient instance.
*
* This component fetches function documentation from the client and
* displays each function along with a testing interface.
*
* @param {AI3DCharacterDocsProps} props - Component props containing the SandaiClient instance.
* @param {SandaiClient} props.client - The [SandaiClient] you get from the [AI3DCharacter] components [onLoad] callback.
* ```js
* <AI3DCharacter
onLoad={handleLoad}
url="https://sandai.org/chat"
showControls
/>
```
* @returns {JSX.Element} A styled documentation interface displaying functions and their descriptions.
*/
export declare const AI3DCharacterDocs: (props: AI3DCharacterDocsProps) => import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=AI3DCharacterDocs.d.ts.map