@colletdev/docs 0.2.11 → 0.2.13
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 +77 -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:**
|
|
@@ -948,6 +948,48 @@ File selection with drag-and-drop zone, preview, and validation.
|
|
|
948
948
|
|
|
949
949
|
---
|
|
950
950
|
|
|
951
|
+
### Flavour
|
|
952
|
+
|
|
953
|
+
Flavour component.
|
|
954
|
+
|
|
955
|
+
**Tag:** `<cx-flavour>` | **Form:** no
|
|
956
|
+
|
|
957
|
+
#### Import
|
|
958
|
+
|
|
959
|
+
| Framework | Import |
|
|
960
|
+
|-----------|--------|
|
|
961
|
+
| React | `import { Flavour } from '@colletdev/react'` |
|
|
962
|
+
| Vue | `import { Flavour } from '@colletdev/vue'` |
|
|
963
|
+
| Svelte | `import Flavour from '@colletdev/svelte/flavour.svelte'` |
|
|
964
|
+
| Angular | `import { CxFlavour } from '@colletdev/angular'` |
|
|
965
|
+
|
|
966
|
+
#### Props
|
|
967
|
+
|
|
968
|
+
| Prop | Type | Default | Description |
|
|
969
|
+
|------|------|---------|-------------|
|
|
970
|
+
| id | `string` | — | |
|
|
971
|
+
| preset | `'matte' \| 'aurora' \| 'gloss' \| 'grain' \| 'paper' \| 'linen' \| 'neon' \| 'blueprint' \| 'film'` | — | |
|
|
972
|
+
| gradient | `GradientConfig \| string` | — | |
|
|
973
|
+
| noise | `NoiseConfig \| string` | — | |
|
|
974
|
+
| texture | `TextureConfig \| string` | — | |
|
|
975
|
+
| overlay | `OverlayConfig \| string` | — | |
|
|
976
|
+
| vignette | `VignetteConfig \| string` | — | |
|
|
977
|
+
| opacity | `number` | `0` | |
|
|
978
|
+
| radius | `'none' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| '2xl' \| 'full'` | — | |
|
|
979
|
+
| animate | `boolean` | `false` | |
|
|
980
|
+
|
|
981
|
+
#### Structured Types
|
|
982
|
+
|
|
983
|
+
Import from `@colletdev/core/types`:
|
|
984
|
+
|
|
985
|
+
- `GradientConfig`
|
|
986
|
+
- `NoiseConfig`
|
|
987
|
+
- `OverlayConfig`
|
|
988
|
+
- `TextureConfig`
|
|
989
|
+
- `VignetteConfig`
|
|
990
|
+
|
|
991
|
+
---
|
|
992
|
+
|
|
951
993
|
### Listbox
|
|
952
994
|
|
|
953
995
|
Keyboard-navigable list of selectable options (single or multi).
|
|
@@ -2301,3 +2343,37 @@ Hover/focus-triggered informational overlay anchored to a trigger.
|
|
|
2301
2343
|
| openDelay | `number` | `0` | |
|
|
2302
2344
|
| closeDelay | `number` | `0` | |
|
|
2303
2345
|
|
|
2346
|
+
---
|
|
2347
|
+
|
|
2348
|
+
### TopBar
|
|
2349
|
+
|
|
2350
|
+
TopBar component.
|
|
2351
|
+
|
|
2352
|
+
**Tag:** `<cx-top-bar>` | **Form:** no | **Slots:** leading, content, trailing
|
|
2353
|
+
|
|
2354
|
+
#### Import
|
|
2355
|
+
|
|
2356
|
+
| Framework | Import |
|
|
2357
|
+
|-----------|--------|
|
|
2358
|
+
| React | `import { TopBar } from '@colletdev/react'` |
|
|
2359
|
+
| Vue | `import { TopBar } from '@colletdev/vue'` |
|
|
2360
|
+
| Svelte | `import TopBar from '@colletdev/svelte/top-bar.svelte'` |
|
|
2361
|
+
| Angular | `import { CxTopBar } from '@colletdev/angular'` |
|
|
2362
|
+
|
|
2363
|
+
#### Props
|
|
2364
|
+
|
|
2365
|
+
| Prop | Type | Default | Description |
|
|
2366
|
+
|------|------|---------|-------------|
|
|
2367
|
+
| id | `string` | — | |
|
|
2368
|
+
| label | `string` | — | |
|
|
2369
|
+
| mobileContent | `string` | — | |
|
|
2370
|
+
| variant | `'filled' \| 'outline' \| 'ghost'` | — | |
|
|
2371
|
+
| shape | `'sharp' \| 'rounded' \| 'pill'` | — | |
|
|
2372
|
+
| position | `'static' \| 'sticky' \| 'fixed'` | — | |
|
|
2373
|
+
| intent | `'neutral' \| 'primary' \| 'info' \| 'success' \| 'warning' \| 'danger'` | — | |
|
|
2374
|
+
| size | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | — | |
|
|
2375
|
+
| crush | `boolean` | `false` | |
|
|
2376
|
+
| crushThreshold | `number` | `0` | |
|
|
2377
|
+
| movable | `boolean` | `false` | |
|
|
2378
|
+
| drawerSide | `'top' \| 'left' \| 'right' \| 'bottom'` | — | |
|
|
2379
|
+
|