Wiki/Brand.md
Brand — heygen-avatar
heygen-avatar is a developer package, not a UI product. Brand guidance applies to the package's minimal default styling and any demo/documentation surfaces.
Package Philosophy
Un-opinionated by design. The <HeygenAvatar> component ships with the minimum CSS needed to be functional (video element, loading overlay with aria-label, error state with role="alert"). Everything else is the developer's responsibility via className and style props.
The package does not bundle a UI framework, does not impose a color palette, and does not add animation libraries. It is infrastructure, not a product UI.
Default Component States
| State | Visual | Accessibility |
|---|---|---|
idle |
Video hidden (display: none) | — |
loading |
Loading overlay visible | aria-label="Loading avatar" |
ready |
Video visible, overlay hidden | Standard <video> element |
error |
Error message rendered | role="alert" |
Demo / Smoke Test Styling
The smoke test example (example/nextjs/app/page.tsx) uses inline styles only:
- Black background (#000) on the video container
- 640×480 default dimensions
- No framework, no design tokens
Package Name & CLI
- npm package:
heygen-avatar - CLI command:
heygen-avatar init - Python module:
heygen_avatar - GitHub:
heygen-avatar(matches npm name)
Documentation Tone
- Direct, developer-first
- Show code, not descriptions
- Protocol Read Receipt standard for any SDK API references (see CLAUDE.md)
[NOT CAPTURED — update after V1 public release]
- README header image / banner
- npm badge styling
- Any documentation site design (if created)