@colletdev/docs 0.2.12 → 0.2.14
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/components.md +47 -1
- package/package.json +1 -1
package/components.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
## Overview
|
|
7
7
|
|
|
8
|
-
Collet ships
|
|
8
|
+
Collet ships 52 components as Custom Elements (`<cx-*>`) with
|
|
9
9
|
framework wrappers for React, Vue, Svelte, and Angular.
|
|
10
10
|
|
|
11
11
|
**npm packages:**
|
|
@@ -538,6 +538,8 @@ Multi-line text area optimized for chat message composition.
|
|
|
538
538
|
| `cx-blur` | `onBlur` | `@cx-blur` | `FocusDetail` |
|
|
539
539
|
| `cx-keydown` | `onKeydown` | `@cx-keydown` | `KeyboardDetail` |
|
|
540
540
|
| `cx-keyup` | `onKeyup` | `@cx-keyup` | `KeyboardDetail` |
|
|
541
|
+
| `cx-submit` | `onSubmit` | `@cx-submit` | `ChatSubmitDetail` |
|
|
542
|
+
| `cx-input` | `onInput` | `@cx-input` | `InputDetail` |
|
|
541
543
|
|
|
542
544
|
#### Ref Methods
|
|
543
545
|
|
|
@@ -549,7 +551,9 @@ Multi-line text area optimized for chat message composition.
|
|
|
549
551
|
|
|
550
552
|
Import from `@colletdev/core/types`:
|
|
551
553
|
|
|
554
|
+
- `ChatSubmitDetail`
|
|
552
555
|
- `FocusDetail`
|
|
556
|
+
- `InputDetail`
|
|
553
557
|
- `KeyboardDetail`
|
|
554
558
|
|
|
555
559
|
---
|
|
@@ -1022,6 +1026,7 @@ Keyboard-navigable list of selectable options (single or multi).
|
|
|
1022
1026
|
|
|
1023
1027
|
| Event | React | Vue | Detail |
|
|
1024
1028
|
|-------|-------|-----|--------|
|
|
1029
|
+
| `cx-change` | `onChange` | `@cx-change` | `SelectDetail` |
|
|
1025
1030
|
| `cx-focus` | `onFocus` | `@cx-focus` | `FocusDetail` |
|
|
1026
1031
|
| `cx-blur` | `onBlur` | `@cx-blur` | `FocusDetail` |
|
|
1027
1032
|
| `cx-keydown` | `onKeydown` | `@cx-keydown` | `KeyboardDetail` |
|
|
@@ -1034,6 +1039,7 @@ Import from `@colletdev/core/types`:
|
|
|
1034
1039
|
- `FocusDetail`
|
|
1035
1040
|
- `KeyboardDetail`
|
|
1036
1041
|
- `OptionGroup`
|
|
1042
|
+
- `SelectDetail`
|
|
1037
1043
|
- `SelectOption`
|
|
1038
1044
|
|
|
1039
1045
|
---
|
|
@@ -1319,6 +1325,7 @@ Avatar-triggered dropdown menu for user account actions.
|
|
|
1319
1325
|
| Event | React | Vue | Detail |
|
|
1320
1326
|
|-------|-------|-----|--------|
|
|
1321
1327
|
| `cx-action` | `onAction` | `@cx-action` | `MenuActionDetail` |
|
|
1328
|
+
| `cx-change` | `onChange` | `@cx-change` | `MenuChangeDetail` |
|
|
1322
1329
|
|
|
1323
1330
|
#### Ref Methods
|
|
1324
1331
|
|
|
@@ -1332,6 +1339,7 @@ Avatar-triggered dropdown menu for user account actions.
|
|
|
1332
1339
|
Import from `@colletdev/core/types`:
|
|
1333
1340
|
|
|
1334
1341
|
- `MenuActionDetail`
|
|
1342
|
+
- `MenuChangeDetail`
|
|
1335
1343
|
- `MenuEntry`
|
|
1336
1344
|
|
|
1337
1345
|
---
|
|
@@ -1487,10 +1495,13 @@ Search input with clear button, shimmer animation, and icon.
|
|
|
1487
1495
|
|
|
1488
1496
|
| Event | React | Vue | Detail |
|
|
1489
1497
|
|-------|-------|-----|--------|
|
|
1498
|
+
| `cx-change` | `onChange` | `@cx-change` | `InputDetail` |
|
|
1490
1499
|
| `cx-focus` | `onFocus` | `@cx-focus` | `FocusDetail` |
|
|
1491
1500
|
| `cx-blur` | `onBlur` | `@cx-blur` | `FocusDetail` |
|
|
1492
1501
|
| `cx-keydown` | `onKeydown` | `@cx-keydown` | `KeyboardDetail` |
|
|
1493
1502
|
| `cx-keyup` | `onKeyup` | `@cx-keyup` | `KeyboardDetail` |
|
|
1503
|
+
| `cx-submit` | `onSubmit` | `@cx-submit` | `InputDetail` |
|
|
1504
|
+
| `cx-input` | `onInput` | `@cx-input` | `InputDetail` |
|
|
1494
1505
|
|
|
1495
1506
|
#### Ref Methods
|
|
1496
1507
|
|
|
@@ -1504,6 +1515,7 @@ Search input with clear button, shimmer animation, and icon.
|
|
|
1504
1515
|
Import from `@colletdev/core/types`:
|
|
1505
1516
|
|
|
1506
1517
|
- `FocusDetail`
|
|
1518
|
+
- `InputDetail`
|
|
1507
1519
|
- `KeyboardDetail`
|
|
1508
1520
|
|
|
1509
1521
|
---
|
|
@@ -2343,3 +2355,37 @@ Hover/focus-triggered informational overlay anchored to a trigger.
|
|
|
2343
2355
|
| openDelay | `number` | `0` | |
|
|
2344
2356
|
| closeDelay | `number` | `0` | |
|
|
2345
2357
|
|
|
2358
|
+
---
|
|
2359
|
+
|
|
2360
|
+
### TopBar
|
|
2361
|
+
|
|
2362
|
+
TopBar component.
|
|
2363
|
+
|
|
2364
|
+
**Tag:** `<cx-top-bar>` | **Form:** no | **Slots:** leading, content, trailing
|
|
2365
|
+
|
|
2366
|
+
#### Import
|
|
2367
|
+
|
|
2368
|
+
| Framework | Import |
|
|
2369
|
+
|-----------|--------|
|
|
2370
|
+
| React | `import { TopBar } from '@colletdev/react'` |
|
|
2371
|
+
| Vue | `import { TopBar } from '@colletdev/vue'` |
|
|
2372
|
+
| Svelte | `import TopBar from '@colletdev/svelte/top-bar.svelte'` |
|
|
2373
|
+
| Angular | `import { CxTopBar } from '@colletdev/angular'` |
|
|
2374
|
+
|
|
2375
|
+
#### Props
|
|
2376
|
+
|
|
2377
|
+
| Prop | Type | Default | Description |
|
|
2378
|
+
|------|------|---------|-------------|
|
|
2379
|
+
| id | `string` | — | |
|
|
2380
|
+
| label | `string` | — | |
|
|
2381
|
+
| mobileContent | `string` | — | |
|
|
2382
|
+
| variant | `'filled' \| 'outline' \| 'ghost'` | — | |
|
|
2383
|
+
| shape | `'sharp' \| 'rounded' \| 'pill'` | — | |
|
|
2384
|
+
| position | `'static' \| 'sticky' \| 'fixed'` | — | |
|
|
2385
|
+
| intent | `'neutral' \| 'primary' \| 'info' \| 'success' \| 'warning' \| 'danger'` | — | |
|
|
2386
|
+
| size | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | — | |
|
|
2387
|
+
| crush | `boolean` | `false` | |
|
|
2388
|
+
| crushThreshold | `number` | `0` | |
|
|
2389
|
+
| movable | `boolean` | `false` | |
|
|
2390
|
+
| drawerSide | `'top' \| 'left' \| 'right' \| 'bottom'` | — | |
|
|
2391
|
+
|