@colletdev/docs

API reference and framework integration guides for the Collet component library -- 60 accessible web components built in Rust/WASM.

Install

npm install @colletdev/docs

Contents

| File | Export | Description | |------|--------|-------------| | index.md | @colletdev/docs | Library overview, target tiers, architecture | | components.md | @colletdev/docs/components | All 60 components: props, events, slots, ARIA | | core.md | @colletdev/docs/core | init() options, theming, CSS architecture, SSR | | react.md | @colletdev/docs/react | React 18+ wrappers, hooks, ref types, events | | vue.md | @colletdev/docs/vue | Vue 3.3+ wrappers, Volar setup, emits | | svelte.md | @colletdev/docs/svelte | Svelte 5 runes wrappers, callback props | | angular.md | @colletdev/docs/angular | Angular 16+ standalone components, forms | | messages.md | @colletdev/docs/messages | Chat/AI message components, streaming | | react-native.md | @colletdev/docs/react-native | React Native WebView-bridge wrappers (experimental) | | ios.md | @colletdev/docs/ios | iOS SwiftUI native target (experimental) |

Usage

Import the markdown content directly:

import components from '@colletdev/docs/components';
import react from '@colletdev/docs/react';

This package ships .md files and a CLI. Use it to build documentation sites, power in-app help, or set up AI agent context.

AI Agent Setup

Set up Collet knowledge for your AI coding assistant:

npx @colletdev/docs init            # auto-detect (Claude Code by default)
npx @colletdev/docs init --claude   # Claude Code (.claude/skills/collet/)
npx @colletdev/docs init --codex    # OpenAI Codex (AGENTS.md)
npx @colletdev/docs init --cursor   # Cursor AI (.cursor/rules/collet.md)
npx @colletdev/docs init --all      # All formats

The CLI auto-detects your framework from package.json and generates context-aware agent configuration with the full 60-component API reference.

Related Packages

| Package | Description | Status | |---------|-------------|--------| | @colletdev/core | Custom Elements + WASM runtime | GA | | @colletdev/react | React 18+ wrappers | GA | | @colletdev/vue | Vue 3.3+ wrappers | GA | | @colletdev/svelte | Svelte 5 wrappers | GA | | @colletdev/angular | Angular 16+ wrappers | GA | | @colletdev/react-native | React Native wrappers | Experimental |

Native desktop/mobile targets: Iced (collet-iced crate) is EXPERIMENTAL (renders; interaction/layout fidelity under repair); GPUI, Slint, iOS (SwiftUI), and Android (Jetpack Compose) are experimental — see the target tier table in index.md.

License

MIT -- github.com/Danrozen87/collet