@thebase/ui 1.1.3 → 1.1.5
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/CHANGELOG.md +37 -18
- package/README.md +26 -22
- package/bin/create-baseui-app.mjs +7 -7
- package/dist/baseui.apidoc.esm.js +949 -0
- package/dist/baseui.apidoc.min.js +950 -0
- package/dist/baseui.esm.js +31 -31
- package/dist/baseui.min.css +1 -1
- package/dist/baseui.min.js +31 -31
- package/dist/baseui.registry.json +5 -5
- package/dist/baseui.templates.xml +60 -31
- package/dist/types/apidoc.d.ts +27 -0
- package/docs/analytics.md +5 -5
- package/docs/blocks.md +5 -5
- package/docs/components/accordion.md +3 -3
- package/docs/components/alert-dialog.md +2 -2
- package/docs/components/alert.md +2 -2
- package/docs/components/apidoc.md +17 -4
- package/docs/components/aspect-ratio.md +2 -2
- package/docs/components/attachment.md +3 -3
- package/docs/components/avatar.md +5 -5
- package/docs/components/badge.md +2 -2
- package/docs/components/block-viewer.md +4 -4
- package/docs/components/breadcrumb.md +3 -3
- package/docs/components/bubble.md +2 -2
- package/docs/components/button-group.md +2 -2
- package/docs/components/button.md +2 -2
- package/docs/components/calendar.md +5 -5
- package/docs/components/card.md +2 -2
- package/docs/components/carousel.md +5 -5
- package/docs/components/chart.md +5 -5
- package/docs/components/checkbox.md +2 -2
- package/docs/components/clipboard-button.md +2 -2
- package/docs/components/collapsible.md +2 -2
- package/docs/components/combobox.md +7 -6
- package/docs/components/command.md +5 -5
- package/docs/components/context-menu.md +5 -5
- package/docs/components/data-table.md +6 -6
- package/docs/components/date-picker.md +9 -8
- package/docs/components/dialog.md +4 -4
- package/docs/components/direction.md +2 -2
- package/docs/components/drawer.md +3 -3
- package/docs/components/dropdown-menu.md +3 -3
- package/docs/components/empty.md +3 -3
- package/docs/components/field.md +23 -17
- package/docs/components/form.md +3 -3
- package/docs/components/hover-card.md +5 -8
- package/docs/components/icon.md +3 -3
- package/docs/components/input-group.md +8 -7
- package/docs/components/input-otp.md +5 -5
- package/docs/components/input.md +6 -5
- package/docs/components/item.md +2 -2
- package/docs/components/kbd.md +2 -2
- package/docs/components/label.md +2 -2
- package/docs/components/markdown.md +3 -3
- package/docs/components/marker.md +2 -2
- package/docs/components/menubar.md +2 -2
- package/docs/components/message-scroller.md +5 -5
- package/docs/components/message.md +5 -5
- package/docs/components/native-select.md +4 -4
- package/docs/components/navigation-menu.md +3 -3
- package/docs/components/pagination.md +3 -3
- package/docs/components/popover.md +7 -7
- package/docs/components/progress.md +2 -2
- package/docs/components/pwa.md +2 -2
- package/docs/components/questionnaire.md +5 -5
- package/docs/components/radio-group.md +2 -2
- package/docs/components/resizable.md +5 -5
- package/docs/components/scroll-area.md +5 -5
- package/docs/components/select.md +6 -5
- package/docs/components/separator.md +2 -2
- package/docs/components/sheet.md +3 -3
- package/docs/components/shell.md +2 -2
- package/docs/components/sidebar.md +2 -2
- package/docs/components/skeleton.md +2 -2
- package/docs/components/slider.md +2 -2
- package/docs/components/spinner.md +3 -3
- package/docs/components/switch.md +2 -2
- package/docs/components/table.md +2 -2
- package/docs/components/tabs.md +4 -4
- package/docs/components/text-editor.md +2 -2
- package/docs/components/textarea.md +11 -15
- package/docs/components/theme-button.md +4 -4
- package/docs/components/toast.md +3 -3
- package/docs/components/toggle-group.md +5 -5
- package/docs/components/toggle.md +5 -5
- package/docs/components/tooltip.md +7 -7
- package/docs/components/typography.md +3 -3
- package/docs/icons.md +7 -7
- package/docs/installation.md +14 -13
- package/docs/owl-components.md +17 -17
- package/docs/registry.md +8 -8
- package/docs/runtime-api.md +3 -3
- package/docs/theming.md +5 -5
- package/docs/usage-guide.md +26 -26
- package/package.json +9 -2
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Groups related buttons while preserving native button semantics.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Base component
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
8
|
import { ButtonGroup, ButtonGroupSeparator, ButtonGroupText } from "@thebase/ui";
|
|
@@ -88,7 +88,7 @@ import { ButtonGroup, ButtonGroupSeparator, ButtonGroupText } from "@thebase/ui"
|
|
|
88
88
|
| `ButtonGroupSeparator` | `className` | `String` | optional |
|
|
89
89
|
| `ButtonGroupText` | `className` | `String` | optional |
|
|
90
90
|
|
|
91
|
-
See [
|
|
91
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
92
92
|
|
|
93
93
|
## Static component
|
|
94
94
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Use `b-ui="button"` on a native button or link.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Base component
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
8
|
import { Button } from "@thebase/ui";
|
|
@@ -55,7 +55,7 @@ import { Button } from "@thebase/ui";
|
|
|
55
55
|
| `getRef` | `Function` | called with the rendered root element after mount, and with `null` on unmount |
|
|
56
56
|
| `onClick` | `Function` | called with the native click event |
|
|
57
57
|
|
|
58
|
-
Also accepts default slot content instead of `label`. Every pure
|
|
58
|
+
Also accepts default slot content instead of `label`. Every pure Base the Base UI component that renders a clickable control (dialog close, tab triggers, toast action, select trigger, ...) renders it through `Button`, usually with `unstyled`, so those controls share one click/disabled/`href` implementation. See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
59
59
|
|
|
60
60
|
## Static component
|
|
61
61
|
|
|
@@ -4,9 +4,9 @@ Use `b-ui="calendar"` for a CDN-ready calendar component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { Calendar } from "@thebase/ui";
|
|
@@ -26,7 +26,7 @@ import { Calendar } from "@thebase/ui";
|
|
|
26
26
|
| `Calendar` | `className` | `String` | optional |
|
|
27
27
|
| `Calendar` | `onChange` | `Function` | optional |
|
|
28
28
|
|
|
29
|
-
See [
|
|
29
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
30
30
|
|
|
31
31
|
## Static component
|
|
32
32
|
|
|
@@ -52,7 +52,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
52
52
|
|
|
53
53
|
## CSS variables
|
|
54
54
|
|
|
55
|
-
The component inherits
|
|
55
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
56
56
|
|
|
57
57
|
## Accessibility behavior
|
|
58
58
|
|
|
@@ -64,7 +64,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
64
64
|
|
|
65
65
|
## Browser support
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
68
68
|
|
|
69
69
|
## Test checklist
|
|
70
70
|
|
package/docs/components/card.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Card
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Base component
|
|
4
4
|
|
|
5
5
|
```js
|
|
6
6
|
import { Card, CardBody, CardDescription, CardFooter, CardHeader, CardTitle } from "@thebase/ui";
|
|
@@ -32,7 +32,7 @@ import { Card, CardBody, CardDescription, CardFooter, CardHeader, CardTitle } fr
|
|
|
32
32
|
</div>
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
`Card`, `CardHeader`, `CardBody`, `CardFooter`, `CardTitle`, and `CardDescription` each accept `className` (`String`, optional) and render their default slot as-is. `Card` additionally accepts `tag` (`String`, optional, default `"div"`) to render a different semantic root element, e.g. `tag="'aside'"` for complementary content. See [
|
|
35
|
+
`Card`, `CardHeader`, `CardBody`, `CardFooter`, `CardTitle`, and `CardDescription` each accept `className` (`String`, optional) and render their default slot as-is. `Card` additionally accepts `tag` (`String`, optional, default `"div"`) to render a different semantic root element, e.g. `tag="'aside'"` for complementary content. See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
36
36
|
|
|
37
37
|
## Static component
|
|
38
38
|
|
|
@@ -4,9 +4,9 @@ Use `b-ui="carousel"` for a CDN-ready carousel component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { Carousel, CarouselNext, CarouselPrevious, CarouselSlide } from "@thebase/ui";
|
|
@@ -67,7 +67,7 @@ import { Carousel, CarouselNext, CarouselPrevious, CarouselSlide } from "@thebas
|
|
|
67
67
|
| `CarouselSlide` | `index` | `Number` | required |
|
|
68
68
|
| `CarouselSlide` | `className` | `String` | optional |
|
|
69
69
|
|
|
70
|
-
See [
|
|
70
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
71
71
|
|
|
72
72
|
The whole group shares a single live `bootstrap.Carousel` instance, owned by the root `Carousel`/`b-ui="carousel"` element: the root always carries classes `carousel slide` and wraps its slides in a `.carousel-inner` container, each `CarouselSlide`/`b-carousel-slide` renders permanently as a `.carousel-item` (exactly one carrying `.active` at a time) — don't rely on node removal to detect the active slide. `CarouselPrevious`/`CarouselNext` (and the static `[b-carousel-prev]`/`[b-carousel-next]` buttons) call `.prev()`/`.next()` on that shared instance directly; Bootstrap's `wrap: true` handles wrap-around at both ends and `interval: false` keeps autoplay off.
|
|
73
73
|
|
|
@@ -102,7 +102,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
102
102
|
|
|
103
103
|
## CSS variables
|
|
104
104
|
|
|
105
|
-
The component inherits
|
|
105
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
106
106
|
|
|
107
107
|
## Accessibility behavior
|
|
108
108
|
|
|
@@ -114,7 +114,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
114
114
|
|
|
115
115
|
## Browser support
|
|
116
116
|
|
|
117
|
-
|
|
117
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
118
118
|
|
|
119
119
|
## Test checklist
|
|
120
120
|
|
package/docs/components/chart.md
CHANGED
|
@@ -4,9 +4,9 @@ Use `b-ui="chart"` for a CDN-ready chart component styled after the current shad
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files. No extra dependency is required for static charts. If you provide a `canvas` and a global `window.Chart`, the Base UI will initialize Chart.js v3 from JSON config without bundling Chart.js into the Base UI.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { Chart } from "@thebase/ui";
|
|
@@ -50,7 +50,7 @@ import { Chart } from "@thebase/ui";
|
|
|
50
50
|
| `Chart` | `variant` | `String` | optional |
|
|
51
51
|
| `Chart` | `className` | `String` | optional |
|
|
52
52
|
|
|
53
|
-
See [
|
|
53
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
54
54
|
|
|
55
55
|
## Static component
|
|
56
56
|
|
|
@@ -110,7 +110,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
110
110
|
|
|
111
111
|
## CSS variables
|
|
112
112
|
|
|
113
|
-
The component inherits
|
|
113
|
+
The component inherits the Base UI semantic tokens plus shadcn-compatible chart tokens: `--b-chart-1` through `--b-chart-5`. Area-card examples also use `--b-chart-height`, `--b-chart-grid`, `b-chart-area`, `b-chart-line`, `b-chart-axis`, `b-chart-footer`, `b-chart-trend`, and `b-chart-range`.
|
|
114
114
|
|
|
115
115
|
## Accessibility behavior
|
|
116
116
|
|
|
@@ -122,7 +122,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
122
122
|
|
|
123
123
|
## Browser support
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
126
126
|
|
|
127
127
|
## Test checklist
|
|
128
128
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Native checkbox input or label wrapper.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Base component
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
8
|
import { Checkbox } from "@thebase/ui";
|
|
@@ -22,7 +22,7 @@ import { Checkbox } from "@thebase/ui";
|
|
|
22
22
|
| `Checkbox` | `id` | `String` | optional, e.g. for `Label`'s `for` |
|
|
23
23
|
| `Checkbox` | `onChange` | `Function` | optional |
|
|
24
24
|
|
|
25
|
-
See [
|
|
25
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
26
26
|
|
|
27
27
|
## Static component
|
|
28
28
|
|
|
@@ -8,7 +8,7 @@ Use `b-ui="clipboard-button"` on a native button to copy specific data to the cl
|
|
|
8
8
|
<pre id="snippet">const x = 1;</pre>
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Base component
|
|
12
12
|
|
|
13
13
|
```js
|
|
14
14
|
import { ClipboardButton } from "@thebase/ui";
|
|
@@ -35,7 +35,7 @@ import { ClipboardButton } from "@thebase/ui";
|
|
|
35
35
|
| `onCopy` | `Function` | called with `{ value, event }` after a successful copy |
|
|
36
36
|
| `onCopyError` | `Function` | called with `{ error, event }` when both the Clipboard API and the fallback fail |
|
|
37
37
|
|
|
38
|
-
Also accepts default slot content instead of `label`. See [
|
|
38
|
+
Also accepts default slot content instead of `label`. See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
39
39
|
|
|
40
40
|
## Static component
|
|
41
41
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Use `b-ui="collapsible"` for a single disclosure region.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Base component
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
8
|
import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "@thebase/ui";
|
|
@@ -28,7 +28,7 @@ import { Collapsible, CollapsibleContent, CollapsibleTrigger } from "@thebase/ui
|
|
|
28
28
|
| `CollapsibleContent` | `className` | `String` | optional |
|
|
29
29
|
| `CollapsibleTrigger` | `className` | `String` | optional |
|
|
30
30
|
|
|
31
|
-
See [
|
|
31
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
32
32
|
|
|
33
33
|
## Static component
|
|
34
34
|
|
|
@@ -4,9 +4,9 @@ Use `b-ui="combobox"` for a CDN-ready combobox component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { Combobox } from "@thebase/ui";
|
|
@@ -20,7 +20,7 @@ import { Combobox } from "@thebase/ui";
|
|
|
20
20
|
{ value: 'nuxtjs', label: 'Nuxt.js' },
|
|
21
21
|
{ value: 'remix', label: 'Remix' },
|
|
22
22
|
{ value: 'astro', label: 'Astro' },
|
|
23
|
-
]" placeholder="'Select a framework'"/>
|
|
23
|
+
]" label="'Framework'" placeholder="'Select a framework'"/>
|
|
24
24
|
</div>
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -32,8 +32,9 @@ import { Combobox } from "@thebase/ui";
|
|
|
32
32
|
| `Combobox` | `className` | `String` | optional |
|
|
33
33
|
| `Combobox` | `id` | `String` | optional, e.g. for `Label`'s `for` |
|
|
34
34
|
| `Combobox` | `onChange` | `Function` | optional |
|
|
35
|
+
| `Combobox` | `label`, `labelBackground`, `supportingText`, `errorText`, `invalid`, `disabled` | `String` / `Boolean` | Material-style outlined field, same behaviour as [Input](/examples/blocks.html#/docs/components/input): the label floats onto the border, `errorText` replaces `supportingText`. Also inherited from a parent `Field`. |
|
|
35
36
|
|
|
36
|
-
See [
|
|
37
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
37
38
|
|
|
38
39
|
## Static component
|
|
39
40
|
|
|
@@ -59,7 +60,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
59
60
|
|
|
60
61
|
## CSS variables
|
|
61
62
|
|
|
62
|
-
The component inherits
|
|
63
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
63
64
|
|
|
64
65
|
## Accessibility behavior
|
|
65
66
|
|
|
@@ -71,7 +72,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
71
72
|
|
|
72
73
|
## Browser support
|
|
73
74
|
|
|
74
|
-
|
|
75
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
75
76
|
|
|
76
77
|
## Test checklist
|
|
77
78
|
|
|
@@ -4,9 +4,9 @@ Use `b-ui="command"` for a CDN-ready command component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { Command } from "@thebase/ui";
|
|
@@ -36,7 +36,7 @@ import { Command } from "@thebase/ui";
|
|
|
36
36
|
| `Command` | `className` | `String` | optional |
|
|
37
37
|
| `Command` | `onSelect` | `Function` | optional |
|
|
38
38
|
|
|
39
|
-
See [
|
|
39
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
40
40
|
|
|
41
41
|
## Static component
|
|
42
42
|
|
|
@@ -62,7 +62,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
62
62
|
|
|
63
63
|
## CSS variables
|
|
64
64
|
|
|
65
|
-
The component inherits
|
|
65
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
66
66
|
|
|
67
67
|
## Accessibility behavior
|
|
68
68
|
|
|
@@ -74,7 +74,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
74
74
|
|
|
75
75
|
## Browser support
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
78
78
|
|
|
79
79
|
## Test checklist
|
|
80
80
|
|
|
@@ -4,9 +4,9 @@ Use `b-ui="context-menu"` for a CDN-ready context menu component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { ContextMenu, ContextMenuContent, ContextMenuItem, ContextMenuTrigger } from "@thebase/ui";
|
|
@@ -38,7 +38,7 @@ import { ContextMenu, ContextMenuContent, ContextMenuItem, ContextMenuTrigger }
|
|
|
38
38
|
| `ContextMenuItem` | `onClick` | `Function` | optional |
|
|
39
39
|
| `ContextMenuTrigger` | `className` | `String` | optional |
|
|
40
40
|
|
|
41
|
-
See [
|
|
41
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
42
42
|
|
|
43
43
|
## Static component
|
|
44
44
|
|
|
@@ -64,7 +64,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
64
64
|
|
|
65
65
|
## CSS variables
|
|
66
66
|
|
|
67
|
-
The component inherits
|
|
67
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
68
68
|
|
|
69
69
|
## Accessibility behavior
|
|
70
70
|
|
|
@@ -76,7 +76,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
76
76
|
|
|
77
77
|
## Browser support
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
80
80
|
|
|
81
81
|
## Test checklist
|
|
82
82
|
|
|
@@ -4,9 +4,9 @@ Use `b-ui="data-table"` for a CDN-ready data table component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { DataTable } from "@thebase/ui";
|
|
@@ -62,9 +62,9 @@ The table viewport always scrolls horizontally (`overflow: auto`) once its conte
|
|
|
62
62
|
|
|
63
63
|
### Mobile kanban view
|
|
64
64
|
|
|
65
|
-
Below 640px width, the table view is replaced by a stacked one-column card ("kanban") view — each row becomes a card showing every visible column as a label/value pair, with selection and row actions preserved. This is CSS-driven (`.bu-data-table__viewport` hides, `.bu-data-table__cards` shows), so it applies to both the
|
|
65
|
+
Below 640px width, the table view is replaced by a stacked one-column card ("kanban") view — each row becomes a card showing every visible column as a label/value pair, with selection and row actions preserved. This is CSS-driven (`.bu-data-table__viewport` hides, `.bu-data-table__cards` shows), so it applies to both the Base component and the static `b-ui="data-table"` markup automatically.
|
|
66
66
|
|
|
67
|
-
See [
|
|
67
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
68
68
|
|
|
69
69
|
## Static component
|
|
70
70
|
|
|
@@ -90,7 +90,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
90
90
|
|
|
91
91
|
## CSS variables
|
|
92
92
|
|
|
93
|
-
The component inherits
|
|
93
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
94
94
|
|
|
95
95
|
## Accessibility behavior
|
|
96
96
|
|
|
@@ -150,7 +150,7 @@ Pass custom buttons into the toolbar via the `toolbarActions` slot — they rend
|
|
|
150
150
|
|
|
151
151
|
## Browser support
|
|
152
152
|
|
|
153
|
-
|
|
153
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
154
154
|
|
|
155
155
|
## Test checklist
|
|
156
156
|
|
|
@@ -4,18 +4,18 @@ Use `b-ui="date-picker"` for a CDN-ready date picker component.
|
|
|
4
4
|
|
|
5
5
|
## CDN install requirements
|
|
6
6
|
|
|
7
|
-
Load the pinned
|
|
7
|
+
Load the pinned the Base UI CSS and JavaScript files; no extra dependency is required for this component.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Base component
|
|
10
10
|
|
|
11
11
|
```js
|
|
12
12
|
import { DatePicker } from "@thebase/ui";
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
```base-ui
|
|
16
|
-
<div style="max-width: 28rem" class="w-100 d-flex flex-column gap-
|
|
17
|
-
<
|
|
18
|
-
<DatePicker/>
|
|
16
|
+
<div style="max-width: 28rem" class="w-100 d-flex flex-column gap-4">
|
|
17
|
+
<DatePicker label="'Date of birth'" supportingText="'As on your ID'"/>
|
|
18
|
+
<DatePicker label="'Start date'" errorText="'Pick a date'"/>
|
|
19
19
|
</div>
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -25,8 +25,9 @@ import { DatePicker } from "@thebase/ui";
|
|
|
25
25
|
| `DatePicker` | `disabled` | `Boolean` | optional |
|
|
26
26
|
| `DatePicker` | `className` | `String` | optional |
|
|
27
27
|
| `DatePicker` | `onChange` | `Function` | optional |
|
|
28
|
+
| `DatePicker` | `label`, `labelBackground`, `supportingText`, `errorText`, `invalid` | `String` / `Boolean` | Material-style outlined field, same behaviour as [Input](/examples/blocks.html#/docs/components/input): the label floats onto the border, `errorText` replaces `supportingText`. Also inherited from a parent `Field`. |
|
|
28
29
|
|
|
29
|
-
See [
|
|
30
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
30
31
|
|
|
31
32
|
## Static component
|
|
32
33
|
|
|
@@ -52,7 +53,7 @@ Interactive components emit documented `baseui:*` events from their root element
|
|
|
52
53
|
|
|
53
54
|
## CSS variables
|
|
54
55
|
|
|
55
|
-
The component inherits
|
|
56
|
+
The component inherits the Base UI semantic tokens such as `--b-surface`, `--b-border`, `--b-primary`, and `--b-radius`.
|
|
56
57
|
|
|
57
58
|
## Accessibility behavior
|
|
58
59
|
|
|
@@ -64,7 +65,7 @@ See `examples/index.html` for a working CDN-style page.
|
|
|
64
65
|
|
|
65
66
|
## Browser support
|
|
66
67
|
|
|
67
|
-
|
|
68
|
+
The Base UI targets modern evergreen browsers that support ES modules, CSS variables, and Bootstrap 5.3.
|
|
68
69
|
|
|
69
70
|
## Test checklist
|
|
70
71
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Dialog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Base component
|
|
4
4
|
|
|
5
5
|
```js
|
|
6
6
|
import {
|
|
@@ -31,7 +31,7 @@ import {
|
|
|
31
31
|
| `defaultOpen` | `Boolean` | initial state when uncontrolled |
|
|
32
32
|
| `onOpenChange` | `Function` | called with the new open boolean |
|
|
33
33
|
|
|
34
|
-
`DialogContent` also accepts `showCloseButton` (default `true`) to render the shadcn-style top-right close control; pass `false` to hide it. `DialogTrigger`, `DialogContent`, `DialogHeader`, `DialogFooter`, `DialogTitle`, `DialogDescription`, and `DialogClose` each accept `className` and render default slot content; they read open/close behavior from the parent `Dialog` automatically. `DialogContent` is driven by a real `bootstrap.Modal` instance bound to its own root (rendered as `.modal.fade > .modal-dialog > .modal-content`, permanently mounted rather than added/removed from the DOM) — Escape, backdrop click, the built-in close control, and `DialogClose` (both wired via `data-bs-dismiss="modal"`) all close the dialog, and the Tab focus trap plus initial-focus/focus-restore on open/close are Bootstrap's own native Modal behavior, same as the static API. See [
|
|
34
|
+
`DialogContent` also accepts `showCloseButton` (default `true`) to render the shadcn-style top-right close control; pass `false` to hide it. `DialogTrigger`, `DialogContent`, `DialogHeader`, `DialogFooter`, `DialogTitle`, `DialogDescription`, and `DialogClose` each accept `className` and render default slot content; they read open/close behavior from the parent `Dialog` automatically. `DialogContent` is driven by a real `bootstrap.Modal` instance bound to its own root (rendered as `.modal.fade > .modal-dialog > .modal-content`, permanently mounted rather than added/removed from the DOM) — Escape, backdrop click, the built-in close control, and `DialogClose` (both wired via `data-bs-dismiss="modal"`) all close the dialog, and the Tab focus trap plus initial-focus/focus-restore on open/close are Bootstrap's own native Modal behavior, same as the static API. See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
35
35
|
|
|
36
36
|
## Static component
|
|
37
37
|
|
|
@@ -65,8 +65,8 @@ import {
|
|
|
65
65
|
</div>
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
At mount,
|
|
68
|
+
At mount, the Base UI restructures this markup into Bootstrap's required shape: the `[b-ui="dialog"]` root becomes the `.modal.fade` element and `[b-dialog-panel]` is wrapped in a new `.modal-dialog` and becomes `.modal-content` — you don't need to author those wrapper levels yourself. The dialog is driven by a real `bootstrap.Modal` instance (`backdrop: true, keyboard: true, focus: true`, all Bootstrap defaults); `[b-dialog-close]` buttons get `data-bs-dismiss="modal"` at mount time instead of a manual click handler.
|
|
69
69
|
|
|
70
|
-
Events: `baseui:open`, `baseui:close` (
|
|
70
|
+
Events: `baseui:open`, `baseui:close` (the Base UI), plus the underlying `shown.bs.modal`/`hidden.bs.modal`.
|
|
71
71
|
|
|
72
72
|
Keyboard: Escape closes the dialog (Bootstrap's native `keyboard` option), as does a backdrop click. Focus moves into the panel on open and is trapped there via Tab/Shift+Tab, then returns to the trigger on close — all native `bootstrap.Modal` behavior.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Direction
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Base component
|
|
4
4
|
|
|
5
5
|
```js
|
|
6
6
|
import { Direction } from "@thebase/ui";
|
|
@@ -51,7 +51,7 @@ import { Direction } from "@thebase/ui";
|
|
|
51
51
|
| `Direction` | `dir` | `String` | optional |
|
|
52
52
|
| `Direction` | `className` | `String` | optional |
|
|
53
53
|
|
|
54
|
-
See [
|
|
54
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
55
55
|
|
|
56
56
|
## Static component
|
|
57
57
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Drawer
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Base component
|
|
4
4
|
|
|
5
5
|
```js
|
|
6
6
|
import { Drawer, DrawerClose, DrawerContent, DrawerDescription, DrawerFooter, DrawerHeader, DrawerTitle, DrawerTrigger } from "@thebase/ui";
|
|
@@ -38,7 +38,7 @@ import { Drawer, DrawerClose, DrawerContent, DrawerDescription, DrawerFooter, Dr
|
|
|
38
38
|
| `DrawerTitle` | `className` | `String` | optional |
|
|
39
39
|
| `DrawerTrigger` | `className` | `String` | optional |
|
|
40
40
|
|
|
41
|
-
`DrawerContent` is driven by a real `bootstrap.Offcanvas` instance bound to its own root (rendered as `.offcanvas.offcanvas-bottom`, permanently mounted rather than added/removed from the DOM) — Escape, backdrop click, and the Tab focus trap are Bootstrap's own native Offcanvas behavior, same as the static API; focus-restore-to-trigger on close is kept by hand (not native to Offcanvas). `DrawerClose` closes via `data-bs-dismiss="offcanvas"`. Drawer has no side variant — it always slides up from the bottom. See [
|
|
41
|
+
`DrawerContent` is driven by a real `bootstrap.Offcanvas` instance bound to its own root (rendered as `.offcanvas.offcanvas-bottom`, permanently mounted rather than added/removed from the DOM) — Escape, backdrop click, and the Tab focus trap are Bootstrap's own native Offcanvas behavior, same as the static API; focus-restore-to-trigger on close is kept by hand (not native to Offcanvas). `DrawerClose` closes via `data-bs-dismiss="offcanvas"`. Drawer has no side variant — it always slides up from the bottom. See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
42
42
|
|
|
43
43
|
## Static component
|
|
44
44
|
|
|
@@ -53,6 +53,6 @@ import { Drawer, DrawerClose, DrawerContent, DrawerDescription, DrawerFooter, Dr
|
|
|
53
53
|
|
|
54
54
|
At mount, `[b-ui="drawer"]` itself becomes the `.offcanvas.offcanvas-bottom` element (`tabindex="-1"`) driven by a real `bootstrap.Offcanvas` instance (`backdrop: true, keyboard: true, scroll: false`); `[b-drawer-panel]` stays as a plain cosmetic content box inside it. `[b-drawer-close]` buttons get `data-bs-dismiss="offcanvas"` at mount time instead of a manual click handler.
|
|
55
55
|
|
|
56
|
-
Events: `baseui:open`, `baseui:close` (
|
|
56
|
+
Events: `baseui:open`, `baseui:close` (the Base UI), plus the underlying `shown.bs.offcanvas`/`hidden.bs.offcanvas`.
|
|
57
57
|
|
|
58
58
|
Keyboard: Escape closes the drawer (Bootstrap's native `keyboard` option), as does a backdrop click on the Bootstrap-generated `.offcanvas-backdrop`. Focus is trapped inside via Tab/Shift+Tab (native `bootstrap.Offcanvas` focus trap) and returns to the trigger on close (kept by hand — not native to Offcanvas).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Displays a menu to the user, such as a set of actions or functions, triggered by a button.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Base component
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
8
|
import {
|
|
@@ -68,7 +68,7 @@ import {
|
|
|
68
68
|
| `DropdownMenuRadioItem` | `value` | `String` | optional |
|
|
69
69
|
| `DropdownMenuLabel`, `DropdownMenuShortcut`, `DropdownMenuSeparator`, `DropdownMenuGroup` | `className` | `String` | optional |
|
|
70
70
|
|
|
71
|
-
See [
|
|
71
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
72
72
|
|
|
73
73
|
## Static component
|
|
74
74
|
|
|
@@ -106,4 +106,4 @@ See [Pure Owl Components](/examples/blocks.html#/docs/guide/owl-components) for
|
|
|
106
106
|
</div>
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
-
The trigger supports click, ArrowDown, and Escape. Root open/close is driven by a real `bootstrap.Dropdown` instance on the trigger (the panel carries Bootstrap's `dropdown-menu`/`show` classes); submenus remain
|
|
109
|
+
The trigger supports click, ArrowDown, and Escape. Root open/close is driven by a real `bootstrap.Dropdown` instance on the trigger (the panel carries Bootstrap's `dropdown-menu`/`show` classes); submenus remain the Base UI's own hover/click behavior. Events: `baseui:open`, `baseui:close` (the Base UI), plus the underlying `show.bs.dropdown`/`shown.bs.dropdown`/`hide.bs.dropdown`/`hidden.bs.dropdown`.
|
package/docs/components/empty.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Use `b-ui="empty"` for an accessible empty state. The component mirrors shadcn's Base Empty composition: header, media, title, description, and content.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Base component
|
|
6
6
|
|
|
7
7
|
```js
|
|
8
8
|
import {
|
|
@@ -46,7 +46,7 @@ import {
|
|
|
46
46
|
| `EmptyDescription` | `className` | `String` | optional |
|
|
47
47
|
| `EmptyContent` | `className` | `String` | optional |
|
|
48
48
|
|
|
49
|
-
See [
|
|
49
|
+
See [Base Components](/examples/blocks.html#/docs/guide/owl-components) for how to load `@base/owl` and `dist/baseui.templates.xml`.
|
|
50
50
|
|
|
51
51
|
## Static component
|
|
52
52
|
|
|
@@ -63,4 +63,4 @@ See [Pure Owl Components](/examples/blocks.html#/docs/guide/owl-components) for
|
|
|
63
63
|
</div>
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
The Base UI sets `role="status"` by default. Use `b-att-variant="outline"` for a dashed container and `b-att-variant="background"` for a muted panel; avatar, avatar-group, input-group, and RTL states are composed by placing those components inside `b-empty-media` or `b-empty-content`.
|