@unframed/cli 0.9.0 → 0.10.0

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.
@@ -5,7 +5,7 @@ description: Builds UI with Unframed web components (@unframed/core, @unframed/r
5
5
 
6
6
  # Unframed UI
7
7
 
8
- Unframed 0.9.0: accessible UI components as standard custom elements (Lit). Every tag starts with `uf-`. They work in plain HTML and every framework; React, Vue and Angular have wrapper packages for typed props, events and form bindings.
8
+ Unframed 0.10.0: accessible UI components as standard custom elements (Lit). Every tag starts with `uf-`. They work in plain HTML and every framework; React, Vue and Angular have wrapper packages for typed props, events and form bindings.
9
9
 
10
10
  ## Before writing code
11
11
 
@@ -1,4 +1,4 @@
1
- # Unframed 0.9.0 components
1
+ # Unframed 0.10.0 components
2
2
 
3
3
  ## Accordion
4
4
 
@@ -207,7 +207,7 @@ Six colors by meaning, in three appearances: `soft` (the default), `solid` and `
207
207
  |---|---|---|---|---|
208
208
  | `variant` | | `BadgeVariant` | `'neutral'` | Color, by meaning: `neutral`, `accent`, `info`, `success`, `warning` or `danger`. |
209
209
  | `appearance` | | `BadgeAppearance` | `'soft'` | `soft` (tinted background), `solid` (bold background) or `outline` (border only). |
210
- | `size` | | `BadgeSize` | `'md'` | Size: `sm` or `md`. |
210
+ | `size` | | `BadgeSize` | `'md'` | Size: `sm`, `md` or `lg`. |
211
211
  | `dot` | | `boolean` | `false` | Shows a status dot before the text. |
212
212
 
213
213
  #### Slots
@@ -434,11 +434,11 @@ Every section is optional; empty ones take no space.
434
434
  </uf-card>
435
435
  ```
436
436
 
437
- ### Variants and orientation
437
+ ### Appearance and orientation
438
438
 
439
439
  ```html
440
- <uf-card variant="elevated">…</uf-card>
441
- <uf-card variant="filled">…</uf-card>
440
+ <uf-card appearance="elevated">…</uf-card>
441
+ <uf-card appearance="filled">…</uf-card>
442
442
  <uf-card orientation="horizontal">
443
443
  <img slot="media" src="/cover.png" alt="" />
444
444
  Media beside the content.
@@ -451,7 +451,7 @@ Every section is optional; empty ones take no space.
451
451
 
452
452
  | Attribute | Property | Type | Default | Description |
453
453
  |---|---|---|---|---|
454
- | `variant` | | `CardVariant` | `'outline'` | `outline` (a border), `elevated` (a shadow, or an accent glow in dark mode) or `filled` (a tinted background). |
454
+ | `appearance` | | `CardAppearance` | `'outline'` | `outline` (a border), `elevated` (a shadow, or an accent glow in dark mode) or `filled` (a tinted background). |
455
455
  | `orientation` | | `CardOrientation` | `'vertical'` | `vertical`, or `horizontal` to put the media beside the content. |
456
456
 
457
457
  #### Slots
@@ -526,6 +526,7 @@ Tags: `<uf-checkbox>`, `<uf-checkbox-group>`. Import: `import '@unframed/core/ch
526
526
  | `hint` | | `string \| undefined` | | Help text below the label. |
527
527
  | `checked` | `defaultChecked` | `boolean` | `false` | Initial state, restored on form reset. Set with the `checked` attribute. |
528
528
  | `value` | | `string` | `'on'` | Value submitted with the form when checked. |
529
+ | `size` | | `FieldSize` | `'md'` | Size of the control and its label: `sm`, `md` or `lg`. |
529
530
  | `name` | | `string` | `''` | Name submitted with the form. |
530
531
  | `disabled` | | `boolean` | `false` | Disables the control. |
531
532
  | `required` | | `boolean` | `false` | Makes the control required for form submission. |
@@ -599,12 +600,6 @@ Tags: `<uf-checkbox>`, `<uf-checkbox-group>`. Import: `import '@unframed/core/ch
599
600
  |---|---|---|
600
601
  | `value` | `string[]` | The values of the checked checkboxes (other than "select all"). |
601
602
 
602
- #### Methods
603
-
604
- | Method | Description |
605
- |---|---|
606
- | `sync()` | Updates "select all" to match the other checkboxes. Called automatically on user changes; call it after changing `checked` on a checkbox from code. |
607
-
608
603
  #### Events
609
604
 
610
605
  | Event | Type | Description |
@@ -732,6 +727,9 @@ Type to filter, arrow keys to move, Enter to pick.
732
727
  | Property | Description |
733
728
  |---|---|
734
729
  | `--uf-combobox-max-height` | Maximum height of the list before it scrolls. |
730
+ | `--uf-field-bg` | Background of the box. |
731
+ | `--uf-field-border-color` | Border color of the box. |
732
+ | `--uf-field-radius` | Corner radius of the box. |
735
733
 
736
734
  ## Date picker
737
735
 
@@ -1442,6 +1440,7 @@ Without `multiple`, a new pick replaces the file. `required` makes the form ask
1442
1440
  | `accept` | | `string \| undefined` | | Accepted files, as in a native file input: extensions (`.pdf`), MIME types (`image/png`) or wildcards (`image/*`), comma-separated. |
1443
1441
  | `multiple` | | `boolean` | `false` | Lets users choose more than one file. |
1444
1442
  | `max-size` | `maxSize` | `number \| undefined` | | Largest accepted file, in bytes, e.g. `5000000` for 5 MB. |
1443
+ | `size` | | `FieldSize` | `'md'` | Size of the drop zone: `sm`, `md` or `lg`. |
1445
1444
  | `name` | | `string` | `''` | Name submitted with the form. |
1446
1445
  | `disabled` | | `boolean` | `false` | Disables the control. |
1447
1446
  | `required` | | `boolean` | `false` | Makes the control required for form submission. |
@@ -1703,7 +1702,7 @@ Long ranges collapse around the current page; the number of buttons stays the sa
1703
1702
  | `pages` | | `number` | `1` | How many pages there are. |
1704
1703
  | `siblings` | | `number` | `1` | How many pages to show on each side of the current one. |
1705
1704
  | `label` | | `string \| undefined` | | Accessible name of the navigation, e.g. "Search results pages". Defaults to "Pagination", or its translation. |
1706
- | `size` | | `PaginationSize` | `'md'` | Size: `sm` or `md`. |
1705
+ | `size` | | `PaginationSize` | `'md'` | Size: `sm`, `md` or `lg`. |
1707
1706
 
1708
1707
  #### Events
1709
1708
 
@@ -1832,7 +1831,7 @@ Leave out `value` when the length of the work is not known.
1832
1831
  | `label` | | `string \| undefined` | | Visible label, also the bar's accessible name. Without one, it's named "Progress". |
1833
1832
  | `show-value` | `showValue` | `boolean` | `false` | Shows the percentage next to the label. |
1834
1833
  | `variant` | | `ProgressVariant` | `'accent'` | Color, by meaning: `accent`, `success`, `warning` or `danger`. |
1835
- | `size` | | `ProgressSize` | `'md'` | Height of the bar: `sm` or `md`. |
1834
+ | `size` | | `ProgressSize` | `'md'` | Height of the bar: `sm`, `md` or `lg`. |
1836
1835
 
1837
1836
  #### Slots
1838
1837
 
@@ -1889,6 +1888,7 @@ Arrow keys move the selection; only the selected radio is in the tab order.
1889
1888
  | `label` | | `string \| undefined` | | Visible group label. |
1890
1889
  | `hint` | | `string \| undefined` | | Help text below the options. |
1891
1890
  | `orientation` | | `'vertical' \| 'horizontal'` | `'vertical'` | Lays the options out in a column or a row. |
1891
+ | `size` | | `FieldSize` | `'md'` | Size of the radios and their labels: `sm`, `md` or `lg`. |
1892
1892
  | `name` | | `string` | `''` | Name submitted with the form. |
1893
1893
  | `disabled` | | `boolean` | `false` | Disables the control. |
1894
1894
  | `required` | | `boolean` | `false` | Makes the control required for form submission. |
@@ -1965,7 +1965,7 @@ Arrow keys move the selection; only the selected radio is in the tab order.
1965
1965
  | Property | Description |
1966
1966
  |---|---|
1967
1967
  | `--uf-radio-size` | Size of the circle. |
1968
- | `--uf-radio-checked-color` | Color of the circle when checked. |
1968
+ | `--uf-radio-checked-bg` | Color of the circle when checked. |
1969
1969
 
1970
1970
  ## Select
1971
1971
 
@@ -2100,6 +2100,7 @@ A native range input underneath: arrow keys, Page Up/Down, Home and End, touch,
2100
2100
  | `label` | | `string \| undefined` | | Visible label, also the slider's accessible name. |
2101
2101
  | `hint` | | `string \| undefined` | | Help text below the slider. |
2102
2102
  | `show-value` | `showValue` | `boolean` | `false` | Shows the current value next to the label. |
2103
+ | `size` | | `FieldSize` | `'md'` | Size of the track and handle: `sm`, `md` or `lg`. |
2103
2104
  | `name` | | `string` | `''` | Name submitted with the form. |
2104
2105
  | `disabled` | | `boolean` | `false` | Disables the control. |
2105
2106
  | `required` | | `boolean` | `false` | Makes the control required for form submission. |
@@ -2153,7 +2154,7 @@ A native range input underneath: arrow keys, Page Up/Down, Home and End, touch,
2153
2154
  |---|---|
2154
2155
  | `--uf-slider-track-height` | Height of the track. |
2155
2156
  | `--uf-slider-track-color` | Color of the track's empty part. |
2156
- | `--uf-slider-fill-color` | Color of the track up to the handle. |
2157
+ | `--uf-slider-indicator-color` | Color of the track up to the handle. |
2157
2158
  | `--uf-slider-thumb-size` | Diameter of the handle. |
2158
2159
 
2159
2160
  ## Spinner
@@ -2230,6 +2231,7 @@ Tags: `<uf-switch>`. Import: `import '@unframed/core/switch';` (or `npx @unframe
2230
2231
  | `hint` | | `string \| undefined` | | Help text below the label. |
2231
2232
  | `checked` | `defaultChecked` | `boolean` | `false` | Initial state, restored on form reset. Set with the `checked` attribute. |
2232
2233
  | `value` | | `string` | `'on'` | Value submitted with the form when checked. |
2234
+ | `size` | | `FieldSize` | `'md'` | Size of the control and its label: `sm`, `md` or `lg`. |
2233
2235
  | `name` | | `string` | `''` | Name submitted with the form. |
2234
2236
  | `disabled` | | `boolean` | `false` | Disables the control. |
2235
2237
  | `required` | | `boolean` | `false` | Makes the control required for form submission. |
@@ -2421,7 +2423,7 @@ Tags: `<uf-tabs>`, `<uf-tab>`, `<uf-tab-panel>`. Import: `import '@unframed/core
2421
2423
 
2422
2424
  | Attribute | Property | Type | Default | Description |
2423
2425
  |---|---|---|---|---|
2424
- | `active` | | `string` | `''` | Name of the selected panel. Defaults to the first enabled tab. |
2426
+ | `value` | | `string` | `''` | Name of the selected panel. Defaults to the first enabled tab. |
2425
2427
  | `activation` | | `'auto' \| 'manual'` | `'auto'` | `auto` selects a tab as soon as it gets focus; `manual` waits for Enter or Space. |
2426
2428
  | `orientation` | | `'horizontal' \| 'vertical'` | `'horizontal'` | Lays the tab list out horizontally or vertically. |
2427
2429
  | `label` | | `string \| undefined` | | Accessible name for the tab list. |
@@ -2672,6 +2674,13 @@ Tags: `<uf-tooltip>`. Import: `import '@unframed/core/tooltip';` (or `npx @unfra
2672
2674
  | `show()` | Shows the tooltip, unless it's disabled. |
2673
2675
  | `hide()` | Hides the tooltip. |
2674
2676
 
2677
+ #### Events
2678
+
2679
+ | Event | Type | Description |
2680
+ |---|---|---|
2681
+ | `uf-show` | `Event` | The tooltip opened. |
2682
+ | `uf-hide` | `Event` | The tooltip closed. |
2683
+
2675
2684
  #### Slots
2676
2685
 
2677
2686
  | Slot | Description |
@@ -1,4 +1,4 @@
1
- # Using Unframed 0.9.0 in each framework
1
+ # Using Unframed 0.10.0 in each framework
2
2
 
3
3
  ## HTML & JavaScript
4
4
 
@@ -68,8 +68,8 @@ dialog.addEventListener('uf-hide', () => toast('Welcome aboard!', { variant: 'su
68
68
  <!doctype html>
69
69
  <html lang="en">
70
70
  <head>
71
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@unframed/tokens@0.9/dist/tokens.css" />
72
- <script type="module" src="https://cdn.jsdelivr.net/npm/@unframed/core@0.9/+esm"></script>
71
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@unframed/tokens@0.10/dist/tokens.css" />
72
+ <script type="module" src="https://cdn.jsdelivr.net/npm/@unframed/core@0.10/+esm"></script>
73
73
  </head>
74
74
  <body>
75
75
  <uf-button variant="primary">It works</uf-button>