@oneworks/avatar-react 0.0.0-onboarding.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-present One Works contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# @oneworks/avatar-react
+
+[English](README.md) | [简体中文](README.zh-Hans.md)
+
+React renderer and embeddable full editor for OneWorks 3D Avatar.
+
+```tsx
+import { Avatar, AvatarEditor } from '@oneworks/avatar-react'
+import '@oneworks/avatar-react/style.css'
+
+<Avatar definition={avatar} animationLibraries={[supportAnimations]} />
+<AvatarEditor definition={avatar} animationLibraries={[supportAnimations]} />
+```
+
+See the [Avatar Runtime guide](https://oneworks.cloud/docs/en/usage/avatar-runtime#react).

package/README.zh-Hans.md

@@ -0,0 +1,15 @@
+# @oneworks/avatar-react
+
+[English](README.md) | [简体中文](README.zh-Hans.md)
+
+OneWorks 3D Avatar 的 React 渲染组件与可嵌入完整编辑器。
+
+```tsx
+import { Avatar, AvatarEditor } from '@oneworks/avatar-react'
+import '@oneworks/avatar-react/style.css'
+
+<Avatar definition={avatar} animationLibraries={[supportAnimations]} />
+<AvatarEditor definition={avatar} animationLibraries={[supportAnimations]} />
+```
+
+完整说明见 [Avatar Runtime 指南](https://oneworks.cloud/docs/usage/avatar-runtime#react)。

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { HTMLAttributes } from 'react';
+import { AvatarAnimationClip, AvatarAnimationLibrary, AvatarAnimationRef, AvatarDefinition } from '@oneworks/avatar';
+export type { AvatarAnimationClip, AvatarAnimationGroup, AvatarAnimationKeyframe, AvatarAnimationLibrary, AvatarAnimationRef, AvatarDefinition } from '@oneworks/avatar';
+export type AvatarTheme = 'dark' | 'light' | 'system';
+export type AvatarLocale = 'en' | 'zh-Hans';
+export type AvatarCaptureOptions = {
+    readonly background?: string | 'transparent';
+    readonly format: 'png' | 'svg';
+    readonly frame?: 'circle' | 'rounded' | 'square';
+    readonly size: 128 | 256 | 512;
+};
+export interface AvatarPlayOptions {
+    readonly playback?: 'loop' | 'once';
+    readonly speed?: number;
+}
+export interface AvatarHandle {
+    capture(options: AvatarCaptureOptions): Promise<Blob>;
+    getDefinition(): AvatarDefinition;
+    pause(): void;
+    play(animation: AvatarAnimationClip | AvatarAnimationRef, options?: AvatarPlayOptions): Promise<void>;
+    resume(): void;
+    seek(timeMs: number): void;
+    setDefinition(definition: AvatarDefinition): void;
+    stop(options?: {
+        readonly reset?: boolean;
+    }): void;
+}
+export interface AvatarProps extends Omit<HTMLAttributes<HTMLDivElement>, 'children' | 'onError'> {
+    readonly animation?: AvatarAnimationClip | AvatarAnimationRef | null;
+    readonly animationLibraries?: readonly AvatarAnimationLibrary[];
+    readonly autoplay?: boolean;
+    readonly definition?: AvatarDefinition;
+    readonly interactive?: boolean;
+    readonly onAnimationEnd?: () => void;
+    readonly onAnimationLoop?: () => void;
+    readonly onAnimationStart?: () => void;
+    readonly onDefinitionChange?: (definition: AvatarDefinition) => void;
+    readonly onError?: (error: Error) => void;
+    readonly theme?: AvatarTheme;
+}
+export declare const Avatar: import('react').ForwardRefExoticComponent<AvatarProps & import('react').RefAttributes<AvatarHandle>>;
+export interface AvatarEditorHandle {
+    focus(): void;
+    getDefinition(): AvatarDefinition;
+    setDefinition(definition: AvatarDefinition): void;
+}
+export interface AvatarEditorProps extends Omit<HTMLAttributes<HTMLDivElement>, 'children' | 'onChange'> {
+    readonly animationLibraries?: readonly AvatarAnimationLibrary[];
+    readonly defaultDefinition?: AvatarDefinition;
+    readonly definition?: AvatarDefinition;
+    readonly locale?: AvatarLocale;
+    readonly onDefinitionChange?: (definition: AvatarDefinition) => void;
+    readonly theme?: AvatarTheme;
+}
+export declare const AvatarEditor: import('react').ForwardRefExoticComponent<AvatarEditorProps & import('react').RefAttributes<AvatarEditorHandle>>;