@colletdev/docs 0.2.4 → 0.2.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -21
- package/components.md +35 -1
- package/index.md +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @colletdev/docs
|
|
2
2
|
|
|
3
3
|
API reference and framework integration guides for the Collet component library -- 48 accessible web components built in Rust/WASM.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @
|
|
8
|
+
npm install @colletdev/docs
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Contents
|
|
12
12
|
|
|
13
13
|
| File | Export | Description |
|
|
14
14
|
|------|--------|-------------|
|
|
15
|
-
| `index.md` | `@
|
|
16
|
-
| `components.md` | `@
|
|
17
|
-
| `core.md` | `@
|
|
18
|
-
| `react.md` | `@
|
|
19
|
-
| `vue.md` | `@
|
|
20
|
-
| `svelte.md` | `@
|
|
21
|
-
| `angular.md` | `@
|
|
15
|
+
| `index.md` | `@colletdev/docs` | Library overview and architecture |
|
|
16
|
+
| `components.md` | `@colletdev/docs/components` | All 48 components: props, events, slots, ARIA |
|
|
17
|
+
| `core.md` | `@colletdev/docs/core` | `init()` options, theming, CSS architecture, SSR |
|
|
18
|
+
| `react.md` | `@colletdev/docs/react` | React 18+ wrappers, hooks, ref types, events |
|
|
19
|
+
| `vue.md` | `@colletdev/docs/vue` | Vue 3.3+ wrappers, Volar setup, emits |
|
|
20
|
+
| `svelte.md` | `@colletdev/docs/svelte` | Svelte 5 runes wrappers, callback props |
|
|
21
|
+
| `angular.md` | `@colletdev/docs/angular` | Angular 16+ standalone components, forms |
|
|
22
22
|
|
|
23
23
|
## Usage
|
|
24
24
|
|
|
25
25
|
Import the markdown content directly:
|
|
26
26
|
|
|
27
27
|
```js
|
|
28
|
-
import components from '@
|
|
29
|
-
import react from '@
|
|
28
|
+
import components from '@colletdev/docs/components';
|
|
29
|
+
import react from '@colletdev/docs/react';
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
This package ships `.md` files and a CLI. Use it to build documentation sites, power in-app help, or set up AI agent context.
|
|
@@ -36,11 +36,11 @@ This package ships `.md` files and a CLI. Use it to build documentation sites, p
|
|
|
36
36
|
Set up Collet knowledge for your AI coding assistant:
|
|
37
37
|
|
|
38
38
|
```bash
|
|
39
|
-
npx @
|
|
40
|
-
npx @
|
|
41
|
-
npx @
|
|
42
|
-
npx @
|
|
43
|
-
npx @
|
|
39
|
+
npx @colletdev/docs init # auto-detect (Claude Code by default)
|
|
40
|
+
npx @colletdev/docs init --claude # Claude Code (.claude/skills/collet/)
|
|
41
|
+
npx @colletdev/docs init --codex # OpenAI Codex (AGENTS.md)
|
|
42
|
+
npx @colletdev/docs init --cursor # Cursor AI (.cursor/rules/collet.md)
|
|
43
|
+
npx @colletdev/docs init --all # All formats
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
The CLI auto-detects your framework from `package.json` and generates context-aware agent configuration with the full 48-component API reference.
|
|
@@ -49,11 +49,11 @@ The CLI auto-detects your framework from `package.json` and generates context-aw
|
|
|
49
49
|
|
|
50
50
|
| Package | Description |
|
|
51
51
|
|---------|-------------|
|
|
52
|
-
| `@
|
|
53
|
-
| `@
|
|
54
|
-
| `@
|
|
55
|
-
| `@
|
|
56
|
-
| `@
|
|
52
|
+
| `@colletdev/core` | Custom Elements + WASM runtime |
|
|
53
|
+
| `@colletdev/react` | React 18+ wrappers |
|
|
54
|
+
| `@colletdev/vue` | Vue 3.3+ wrappers |
|
|
55
|
+
| `@colletdev/svelte` | Svelte 5 wrappers |
|
|
56
|
+
| `@colletdev/angular` | Angular 16+ wrappers |
|
|
57
57
|
|
|
58
58
|
## License
|
|
59
59
|
|
package/components.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
## Overview
|
|
7
7
|
|
|
8
|
-
Collet ships
|
|
8
|
+
Collet ships 50 components as Custom Elements (`<cx-*>`) with
|
|
9
9
|
framework wrappers for React, Vue, Svelte, and Angular.
|
|
10
10
|
|
|
11
11
|
**npm packages:**
|
|
@@ -527,6 +527,7 @@ Multi-line text area optimized for chat message composition.
|
|
|
527
527
|
| actionLabel | `string` | — | |
|
|
528
528
|
| submitLabel | `string` | — | |
|
|
529
529
|
| label | `string` | — | |
|
|
530
|
+
| maxLength | `number` | `0` | |
|
|
530
531
|
| slotted | `boolean` | `false` | |
|
|
531
532
|
|
|
532
533
|
#### Events
|
|
@@ -731,6 +732,7 @@ Calendar-based date input with keyboard navigation and locale support.
|
|
|
731
732
|
| readonly | `boolean` | `false` | |
|
|
732
733
|
| name | `string` | — | |
|
|
733
734
|
| onChange | `string` | — | |
|
|
735
|
+
| viewing | `string` | — | |
|
|
734
736
|
|
|
735
737
|
#### Events
|
|
736
738
|
|
|
@@ -1134,6 +1136,34 @@ Individual message segment with streaming markdown support.
|
|
|
1134
1136
|
|
|
1135
1137
|
---
|
|
1136
1138
|
|
|
1139
|
+
### MessageTimeline
|
|
1140
|
+
|
|
1141
|
+
MessageTimeline component.
|
|
1142
|
+
|
|
1143
|
+
**Tag:** `<cx-message-timeline>` | **Form:** no
|
|
1144
|
+
|
|
1145
|
+
#### Import
|
|
1146
|
+
|
|
1147
|
+
| Framework | Import |
|
|
1148
|
+
|-----------|--------|
|
|
1149
|
+
| React | `import { MessageTimeline } from '@colletdev/react'` |
|
|
1150
|
+
| Vue | `import { MessageTimeline } from '@colletdev/vue'` |
|
|
1151
|
+
| Svelte | `import MessageTimeline from '@colletdev/svelte/message-timeline.svelte'` |
|
|
1152
|
+
| Angular | `import { CxMessageTimeline } from '@colletdev/angular'` |
|
|
1153
|
+
|
|
1154
|
+
#### Props
|
|
1155
|
+
|
|
1156
|
+
| Prop | Type | Default | Description |
|
|
1157
|
+
|------|------|---------|-------------|
|
|
1158
|
+
| id | `string` | — | |
|
|
1159
|
+
| role | `string` | — | |
|
|
1160
|
+
| alignment | `string` | — | |
|
|
1161
|
+
| size | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | — | |
|
|
1162
|
+
| senderName | `string` | — | |
|
|
1163
|
+
| events | `string` | — | |
|
|
1164
|
+
|
|
1165
|
+
---
|
|
1166
|
+
|
|
1137
1167
|
### Pagination
|
|
1138
1168
|
|
|
1139
1169
|
Page navigation controls with page size selector.
|
|
@@ -1915,12 +1945,14 @@ Data table with sorting, selection, pagination, and expandable rows.
|
|
|
1915
1945
|
| selectable | `string` | — | |
|
|
1916
1946
|
| selected | `string[] \| string` | — | |
|
|
1917
1947
|
| sorts | `SortState[] \| string` | — | |
|
|
1948
|
+
| filters | `FilterState[] \| string` | — | |
|
|
1918
1949
|
| pagination | `PaginationConfig \| string` | — | |
|
|
1919
1950
|
| hoverable | `boolean` | `false` | |
|
|
1920
1951
|
| stickyHeader | `boolean` | `false` | |
|
|
1921
1952
|
| footer | `FooterRow[] \| string` | — | |
|
|
1922
1953
|
| emptyState | `EmptyStateConfig \| string` | — | |
|
|
1923
1954
|
| columnOrder | `string[] \| string` | — | |
|
|
1955
|
+
| virtualScroll | `VirtualScrollConfig \| string` | — | |
|
|
1924
1956
|
| disabled | `boolean` | `false` | |
|
|
1925
1957
|
| loading | `number` | `0` | |
|
|
1926
1958
|
| error | `string` | — | |
|
|
@@ -1941,6 +1973,7 @@ Data table with sorting, selection, pagination, and expandable rows.
|
|
|
1941
1973
|
Import from `@colletdev/core/types`:
|
|
1942
1974
|
|
|
1943
1975
|
- `EmptyStateConfig`
|
|
1976
|
+
- `FilterState`
|
|
1944
1977
|
- `FooterRow`
|
|
1945
1978
|
- `KeyboardDetail`
|
|
1946
1979
|
- `PageDetail`
|
|
@@ -1951,6 +1984,7 @@ Import from `@colletdev/core/types`:
|
|
|
1951
1984
|
- `TableExpandDetail`
|
|
1952
1985
|
- `TableRow`
|
|
1953
1986
|
- `TableSelectDetail`
|
|
1987
|
+
- `VirtualScrollConfig`
|
|
1954
1988
|
|
|
1955
1989
|
---
|
|
1956
1990
|
|
package/index.md
CHANGED
|
@@ -7,21 +7,21 @@ Custom Elements with first-class framework wrappers.
|
|
|
7
7
|
|
|
8
8
|
| Package | Description | Peer Dependencies |
|
|
9
9
|
|---------|-------------|-------------------|
|
|
10
|
-
| `@
|
|
11
|
-
| `@
|
|
12
|
-
| `@
|
|
13
|
-
| `@
|
|
14
|
-
| `@
|
|
10
|
+
| `@colletdev/core` | Custom Elements + WASM runtime + CSS tokens | — |
|
|
11
|
+
| `@colletdev/react` | React 18+ wrappers with typed refs and hooks | `react >= 18`, `@colletdev/core` |
|
|
12
|
+
| `@colletdev/vue` | Vue 3.3+ wrappers with Volar support | `vue >= 3.3`, `@colletdev/core` |
|
|
13
|
+
| `@colletdev/svelte` | Svelte 5 wrappers with runes and snippets | `svelte >= 5`, `@colletdev/core` |
|
|
14
|
+
| `@colletdev/angular` | Angular 16+ standalone wrappers with CVA | `@angular/core >= 16`, `@colletdev/core` |
|
|
15
15
|
|
|
16
16
|
## Quick Start
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
npm install @
|
|
19
|
+
npm install @colletdev/core @colletdev/react # or vue/svelte/angular
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
```tsx
|
|
23
|
-
import { init } from '@
|
|
24
|
-
import { Button } from '@
|
|
23
|
+
import { init } from '@colletdev/core';
|
|
24
|
+
import { Button } from '@colletdev/react';
|
|
25
25
|
|
|
26
26
|
await init();
|
|
27
27
|
|