@brightspace-ui/core 3.26.1 → 3.27.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.
- package/components/alert/README.md +2 -2
- package/components/backdrop/README.md +1 -1
- package/components/breadcrumbs/README.md +3 -3
- package/components/button/README.md +4 -4
- package/components/calendar/README.md +1 -1
- package/components/card/README.md +4 -4
- package/components/collapsible-panel/README.md +3 -3
- package/components/count-badge/README.md +2 -2
- package/components/dialog/README.md +3 -3
- package/components/dropdown/README.md +8 -8
- package/components/empty-state/README.md +4 -4
- package/components/expand-collapse/README.md +1 -1
- package/components/filter/README.md +8 -8
- package/components/focus-trap/README.md +1 -1
- package/components/html-block/README.md +2 -2
- package/components/link/README.md +1 -1
- package/components/list/README.md +5 -5
- package/components/loading-spinner/README.md +1 -1
- package/components/menu/README.md +6 -6
- package/components/meter/README.md +3 -3
- package/components/more-less/README.md +1 -1
- package/components/object-property-list/README.md +4 -4
- package/components/offscreen/README.md +1 -1
- package/components/overflow-group/README.md +1 -1
- package/components/scroll-wrapper/README.md +1 -1
- package/components/selection/README.md +8 -8
- package/components/status-indicator/README.md +1 -1
- package/components/switch/README.md +2 -2
- package/components/table/README.md +3 -3
- package/components/tabs/README.md +2 -2
- package/components/tag-list/README.md +2 -2
- package/components/tooltip/README.md +8 -8
- package/package.json +1 -1
- package/templates/primary-secondary/README.md +1 -1
@@ -64,7 +64,7 @@ The `d2l-alert` component can be used to communicate important information relat
|
|
64
64
|
<!-- docs: end donts -->
|
65
65
|
<!-- docs: end best practices -->
|
66
66
|
|
67
|
-
<!-- docs: demo code properties name:d2l-alert autoSize:false -->
|
67
|
+
<!-- docs: demo code properties name:d2l-alert sandboxTitle:'Inline Alert' autoSize:false -->
|
68
68
|
```html
|
69
69
|
<script type="module">
|
70
70
|
import '@brightspace-ui/core/components/alert/alert.js';
|
@@ -110,7 +110,7 @@ a pop-up at the bottom of the screen that automatically dismisses itself by defa
|
|
110
110
|
<!-- docs: end best practices -->
|
111
111
|
|
112
112
|
|
113
|
-
<!-- docs: demo code properties name:d2l-alert-toast autoSize:false -->
|
113
|
+
<!-- docs: demo code properties name:d2l-alert-toast sandboxTitle:'Toast Alert' autoSize:false -->
|
114
114
|
```html
|
115
115
|
<script type="module">
|
116
116
|
import '@brightspace-ui/core/components/alert/alert-toast.js';
|
@@ -4,7 +4,7 @@ The `d2l-backdrop` element is a web component to display a semi-transparent back
|
|
4
4
|
|
5
5
|
## Backdrop [d2l-backdrop]
|
6
6
|
|
7
|
-
<!-- docs: demo code properties name:d2l-backdrop size:small -->
|
7
|
+
<!-- docs: demo code properties name:d2l-backdrop sandboxTitle:'Backdrop' size:small -->
|
8
8
|
```html
|
9
9
|
<script type="module">
|
10
10
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -81,7 +81,7 @@ Alternately, add the `compact` attribute to only display the last breadcrumb. Th
|
|
81
81
|
|
82
82
|
## Breadcrumbs [d2l-breadcrumbs]
|
83
83
|
|
84
|
-
<!-- docs: demo code properties name:d2l-breadcrumbs display:block -->
|
84
|
+
<!-- docs: demo code properties name:d2l-breadcrumbs sandboxTitle:'Breadcrumbs' display:block -->
|
85
85
|
```html
|
86
86
|
<script type="module">
|
87
87
|
import '@brightspace-ui/core/components/breadcrumbs/breadcrumbs.js';
|
@@ -103,7 +103,7 @@ Alternately, add the `compact` attribute to only display the last breadcrumb. Th
|
|
103
103
|
|
104
104
|
## Breadcrumb (child) [d2l-breadcrumb]
|
105
105
|
|
106
|
-
<!-- docs: demo code properties name:d2l-breadcrumb display:block -->
|
106
|
+
<!-- docs: demo code properties name:d2l-breadcrumb sandboxTitle:'Breadcrumb' display:block -->
|
107
107
|
```html
|
108
108
|
<script type="module">
|
109
109
|
import '@brightspace-ui/core/components/breadcrumbs/breadcrumbs.js';
|
@@ -136,7 +136,7 @@ To make your usage of `d2l-breadcrumb` (child) accessible, use the following att
|
|
136
136
|
|
137
137
|
Only include the current page in the breadcrumb if your page or view does not have a visible heading. You will notice that some older pages or tools in Brightspace still display the current page as the last breadcrumb despite having a visible page heading, but this is now a legacy pattern.
|
138
138
|
|
139
|
-
<!-- docs: demo code properties name:d2l-breadcrumb-current-page display:block -->
|
139
|
+
<!-- docs: demo code properties name:d2l-breadcrumb-current-page sandboxTitle:'Current Page Breadcrumb' display:block -->
|
140
140
|
```html
|
141
141
|
<script type="module">
|
142
142
|
import '@brightspace-ui/core/components/breadcrumbs/breadcrumb-current-page.js';
|
@@ -34,7 +34,7 @@ A Button is used to communicate and perform an action.
|
|
34
34
|
|
35
35
|
The `d2l-button` element can be used just like the native button element, but also supports the `primary` attribute for denoting the primary button.
|
36
36
|
|
37
|
-
<!-- docs: demo code properties name:d2l-button -->
|
37
|
+
<!-- docs: demo code properties name:d2l-button sandboxTitle:'Button' -->
|
38
38
|
```html
|
39
39
|
<script type="module">
|
40
40
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -59,7 +59,7 @@ The `d2l-button-subtle` element can be used just like the native `button`, but f
|
|
59
59
|
|
60
60
|
**Note:** It is strongly recommended to use `text` and `icon` as opposed to putting content in the `slot` to ensure that the recommended subtle button style is maintained.
|
61
61
|
|
62
|
-
<!-- docs: demo code properties name:d2l-button-subtle -->
|
62
|
+
<!-- docs: demo code properties name:d2l-button-subtle sandboxTitle:'Subtle Button' -->
|
63
63
|
```html
|
64
64
|
<script type="module">
|
65
65
|
import '@brightspace-ui/core/components/button/button-subtle.js';
|
@@ -103,7 +103,7 @@ The `d2l-button-subtle` element can be used just like the native `button`, but f
|
|
103
103
|
|
104
104
|
The `d2l-button-icon` element can be used just like the native `button`, for instances where only an icon is displayed.
|
105
105
|
|
106
|
-
<!-- docs: demo code properties name:d2l-button-icon -->
|
106
|
+
<!-- docs: demo code properties name:d2l-button-icon sandboxTitle:'Icon Button' -->
|
107
107
|
```html
|
108
108
|
<script type="module">
|
109
109
|
import '@brightspace-ui/core/components/button/button-icon.js';
|
@@ -147,7 +147,7 @@ The `d2l-button-icon` element can be used just like the native `button`, for ins
|
|
147
147
|
|
148
148
|
The `d2l-button-add` is for quickly adding new items at a specific location, such as when adding items to a curated list. Since the Add button is meant to be subtle, it should always be used in combination with more obvious methods to add items (like a menu or primary button).
|
149
149
|
|
150
|
-
<!-- docs: demo code properties name:d2l-button-add display:block autoSize:false size:xsmall -->
|
150
|
+
<!-- docs: demo code properties name:d2l-button-add sandboxTitle:'Add Button' display:block autoSize:false size:xsmall -->
|
151
151
|
```html
|
152
152
|
<script type="module">
|
153
153
|
import '@brightspace-ui/core/components/button/button-add.js';
|
@@ -4,7 +4,7 @@ The `d2l-calendar` component can be used to display a responsively sized calenda
|
|
4
4
|
|
5
5
|
## Calendar [d2l-calendar]
|
6
6
|
|
7
|
-
<!-- docs: demo code properties name:d2l-calendar display:block -->
|
7
|
+
<!-- docs: demo code properties name:d2l-calendar sandboxTitle:'Calendar' display:block -->
|
8
8
|
```html
|
9
9
|
<script type="module">
|
10
10
|
import '@brightspace-ui/core/components/calendar/calendar.js';
|
@@ -121,7 +121,7 @@ Cards are composed of 3 sections. Each card will have a content section but is n
|
|
121
121
|
|
122
122
|
The `d2l-card` element is a container that provides specific layout using several slots such as `content`, `header`, `footer`, `badge`, and `actions`. It can also be configured as a link for navigation.
|
123
123
|
|
124
|
-
<!-- docs: demo code properties name:d2l-card size:large -->
|
124
|
+
<!-- docs: demo code properties name:d2l-card sandboxTitle:'Card' size:large -->
|
125
125
|
```html
|
126
126
|
<script type="module">
|
127
127
|
import '@brightspace-ui/core/components/card/card.js';
|
@@ -183,7 +183,7 @@ See the [anchor element docs](https://developer.mozilla.org/en-US/docs/Web/HTML/
|
|
183
183
|
|
184
184
|
The `d2l-card-content-title` element is a helper for providing layout/style for a title within the `content` slot.
|
185
185
|
|
186
|
-
<!-- docs: demo code properties name:d2l-card-content-title size:large -->
|
186
|
+
<!-- docs: demo code properties name:d2l-card-content-title sandboxTitle:'Card Content - Title' size:large -->
|
187
187
|
```html
|
188
188
|
<script type="module">
|
189
189
|
import '@brightspace-ui/core/components/card/card.js';
|
@@ -212,7 +212,7 @@ The `d2l-card-content-title` element is a helper for providing layout/style for
|
|
212
212
|
|
213
213
|
The `d2l-card-content-meta` element is a helper for providing layout/style for a meta data within the `content` slot.
|
214
214
|
|
215
|
-
<!-- docs: demo code properties name:d2l-card-content-meta size:large -->
|
215
|
+
<!-- docs: demo code properties name:d2l-card-content-meta sandboxTitle:'Card Content - Meta' size:large -->
|
216
216
|
```html
|
217
217
|
<script type="module">
|
218
218
|
import '@brightspace-ui/core/components/card/card.js';
|
@@ -248,7 +248,7 @@ The `d2l-card-content-meta` element is a helper for providing layout/style for a
|
|
248
248
|
|
249
249
|
The `d2l-card-footer-link` element is an icon link that can be placed in the `footer` slot.
|
250
250
|
|
251
|
-
<!-- docs: demo code properties name:d2l-card-footer-link size:large -->
|
251
|
+
<!-- docs: demo code properties name:d2l-card-footer-link sandboxTitle:'Card Content - Link' size:large -->
|
252
252
|
```html
|
253
253
|
<script type="module">
|
254
254
|
import '@brightspace-ui/core/components/card/card.js';
|
@@ -90,7 +90,7 @@ The collapsible panel is a container that can show or hide additional content. I
|
|
90
90
|
|
91
91
|
The `d2l-collapsible-panel` element is a container that provides specific layout slots such as `before`, `header`, `summary`, `actions`, and a default slot for the expanded content.
|
92
92
|
|
93
|
-
<!-- docs: demo code properties name:d2l-collapsible-panel -->
|
93
|
+
<!-- docs: demo code properties name:d2l-collapsible-panel sandboxTitle:'Collapsible Panel' -->
|
94
94
|
```html
|
95
95
|
<script type="module">
|
96
96
|
import '@brightspace-ui/core/components/collapsible-panel/collapsible-panel.js';
|
@@ -208,7 +208,7 @@ Use an inline collapsible panel to progressively disclose sections of a complex
|
|
208
208
|
## Summary Items [d2l-collapsible-panel-summary-item]
|
209
209
|
An optional summary can help the user understand what’s inside the collapsible panel without having to expand it. This can be helpful if the user needs more than the heading to explain what’s inside.
|
210
210
|
|
211
|
-
<!-- docs: demo properties name:d2l-collapsible-panel-summary-item -->
|
211
|
+
<!-- docs: demo properties name:d2l-collapsible-panel-summary-item sandboxTitle:'Collapsible Panel - Summary Item' -->
|
212
212
|
```html
|
213
213
|
<script type="module">
|
214
214
|
import '@brightspace-ui/core/components/collapsible-panel/collapsible-panel.js';
|
@@ -361,7 +361,7 @@ Collapsible panels have two optional slots, `header` and `actions` that can be u
|
|
361
361
|
|
362
362
|
Use the `d2l-collapsible-panel-group` component to automatically handle spacing and layout for multiple panels.
|
363
363
|
|
364
|
-
<!-- docs: demo code properties name:d2l-collapsible-panel-group -->
|
364
|
+
<!-- docs: demo code properties name:d2l-collapsible-panel-group sandboxTitle:'Collapsible Panel Group' -->
|
365
365
|
```html
|
366
366
|
<script type="module">
|
367
367
|
import '@brightspace-ui/core/components/collapsible-panel/collapsible-panel.js';
|
@@ -17,7 +17,7 @@ Badges can be used to provide additional contextual information to users in rega
|
|
17
17
|
|
18
18
|
The `d2l-count-badge` element is a web component to display a number count, depending on your use case different styling options are available.
|
19
19
|
|
20
|
-
<!-- docs: demo code properties name:d2l-count-badge -->
|
20
|
+
<!-- docs: demo code properties name:d2l-count-badge sandboxTitle:'Count Badge' -->
|
21
21
|
```html
|
22
22
|
<script type="module">
|
23
23
|
import '@brightspace-ui/core/components/count-badge/count-badge.js';
|
@@ -54,7 +54,7 @@ The `d2l-count-badge` element is a web component to display a number count, depe
|
|
54
54
|
|
55
55
|
The `d2l-count-badge-icon` element is a web component to display a number count, either in a `"notification"` or `"count"` style with an icon.
|
56
56
|
|
57
|
-
<!-- docs: demo code properties name:d2l-count-badge-icon -->
|
57
|
+
<!-- docs: demo code properties name:d2l-count-badge-icon sandboxTitle:'Count Badge Icon' -->
|
58
58
|
```html
|
59
59
|
<script type="module">
|
60
60
|
import '@brightspace-ui/core/components/count-badge/count-badge-icon.js';
|
@@ -44,7 +44,7 @@ The `d2l-dialog` element is a generic dialog that provides a slot for arbitrary
|
|
44
44
|
<!-- docs: end donts -->
|
45
45
|
<!-- docs: end best practices -->
|
46
46
|
|
47
|
-
<!-- docs: demo code properties name:d2l-dialog autoSize:false display:block size:large -->
|
47
|
+
<!-- docs: demo code properties name:d2l-dialog sandboxTitle:'Dialog' autoSize:false display:block size:large -->
|
48
48
|
```html
|
49
49
|
<script type="module">
|
50
50
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -155,7 +155,7 @@ The `d2l-dialog-confirm` element is a simple confirmation dialog for prompting t
|
|
155
155
|
<!-- docs: end donts -->
|
156
156
|
<!-- docs: end best practices -->
|
157
157
|
|
158
|
-
<!-- docs: demo code properties name:d2l-dialog-confirm autoSize:false display:block size:large -->
|
158
|
+
<!-- docs: demo code properties name:d2l-dialog-confirm sandboxTitle:'Confirmation Dialog' autoSize:false display:block size:large -->
|
159
159
|
```html
|
160
160
|
<script type="module">
|
161
161
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -208,7 +208,7 @@ document.querySelector('#open').addEventListener('click', () => {
|
|
208
208
|
|
209
209
|
The `d2l-dialog-fullscreen` element is a fullscreen variant of the generic `d2l-dialog`. It provides a slot for arbitrary content, and a `footer` slot for workflow buttons. Apply the `data-dialog-action` attribute to workflow buttons to automatically close the dialog with the action value.
|
210
210
|
|
211
|
-
<!-- docs: demo code properties name:d2l-dialog-fullscreen autoSize:false display:block size:large -->
|
211
|
+
<!-- docs: demo code properties name:d2l-dialog-fullscreen sandboxTitle:'Fullscreen Dialog' autoSize:false display:block size:large -->
|
212
212
|
```html
|
213
213
|
<script type="module">
|
214
214
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -17,7 +17,7 @@ A Dropdown is a button that opens a floating container to offer menu items or ot
|
|
17
17
|
|
18
18
|
`d2l-dropdown` is a generic opener for dropdown content (`d2l-dropdown-content`, `d2l-dropdown-menu` or `d2l-dropdown-tabs`) enabling alternate opener implementation using existing elements/components. Provide and indicate your own opener element with the class attribute value `d2l-dropdown-opener`. Wire-up is automatic.
|
19
19
|
|
20
|
-
<!-- docs: demo code properties name:d2l-dropdown align:flex-start autoOpen:true autoSize:false size:medium -->
|
20
|
+
<!-- docs: demo code properties name:d2l-dropdown sandboxTitle:'Dropdown' align:flex-start autoOpen:true autoSize:false size:medium -->
|
21
21
|
```html
|
22
22
|
<script type="module">
|
23
23
|
import '@brightspace-ui/core/components/dropdown/dropdown.js';
|
@@ -58,7 +58,7 @@ If the dropdown is initially empty when it's opened, the dropdown pointer will n
|
|
58
58
|
## Opener: Dropdown Button [d2l-dropdown-button]
|
59
59
|
`d2l-dropdown-button` is a `d2l-button` opener for dropdown content (`d2l-dropdown-content`, `d2l-dropdown-menu` or `d2l-dropdown-tabs`).
|
60
60
|
|
61
|
-
<!-- docs: demo code properties name:d2l-dropdown-button align:flex-start autoOpen:true autoSize:false size:medium -->
|
61
|
+
<!-- docs: demo code properties name:d2l-dropdown-button sandboxTitle:'Dropdown Button' align:flex-start autoOpen:true autoSize:false size:medium -->
|
62
62
|
```html
|
63
63
|
<script type="module">
|
64
64
|
import '@brightspace-ui/core/components/dropdown/dropdown-button.js';
|
@@ -86,7 +86,7 @@ If the dropdown is initially empty when it's opened, the dropdown pointer will n
|
|
86
86
|
## Opener: Button Subtle [d2l-dropdown-button-subtle]
|
87
87
|
`d2l-dropdown-button-subtle` is a `d2l-button-subtle` opener for dropdown content (`d2l-dropdown-content`, `d2l-dropdown-menu` or `d2l-dropdown-tabs`).
|
88
88
|
|
89
|
-
<!-- docs: demo code properties name:d2l-dropdown-button-subtle align:flex-start autoOpen:true autoSize:false size:medium -->
|
89
|
+
<!-- docs: demo code properties name:d2l-dropdown-button-subtle sandboxTitle:'Dropdown with Subtle Button Opener' align:flex-start autoOpen:true autoSize:false size:medium -->
|
90
90
|
```html
|
91
91
|
<script type="module">
|
92
92
|
import '@brightspace-ui/core/components/dropdown/dropdown-button-subtle.js';
|
@@ -123,7 +123,7 @@ To make your `d2l-dropdown-button-subtle` accessible, use the following properti
|
|
123
123
|
## Opener: Context Menu [d2l-dropdown-context-menu]
|
124
124
|
`d2l-dropdown-context-menu` is a simple/minimal opener for dropdown content (`d2l-dropdown-content`, `d2l-dropdown-menu` or `d2l-dropdown-tabs`).
|
125
125
|
|
126
|
-
<!-- docs: demo code properties name:d2l-dropdown-context-menu align:flex-start autoOpen:true autoSize:false size:medium -->
|
126
|
+
<!-- docs: demo code properties name:d2l-dropdown-context-menu sandboxTitle:'Dropdown with Context Menu Opener' align:flex-start autoOpen:true autoSize:false size:medium -->
|
127
127
|
```html
|
128
128
|
<script type="module">
|
129
129
|
import '@brightspace-ui/core/components/dropdown/dropdown-context-menu.js';
|
@@ -160,7 +160,7 @@ To make your usage of `d2l-dropdown-context-menu` accessible, use the following
|
|
160
160
|
## Opener: More [d2l-dropdown-more]
|
161
161
|
`d2l-dropdown-more` is a simple/minimal opener for dropdown content (`d2l-dropdown-content`, `d2l-dropdown-menu` or `d2l-dropdown-tabs`).
|
162
162
|
|
163
|
-
<!-- docs: demo code properties name:d2l-dropdown-more align:flex-start autoOpen:true autoSize:false size:medium -->
|
163
|
+
<!-- docs: demo code properties name:d2l-dropdown-more sandboxTitle:'Dropdown with More Opener' align:flex-start autoOpen:true autoSize:false size:medium -->
|
164
164
|
```html
|
165
165
|
<script type="module">
|
166
166
|
import '@brightspace-ui/core/components/dropdown/dropdown-more.js';
|
@@ -197,7 +197,7 @@ To make your usage of `d2l-dropdown-more` accessible, use the following property
|
|
197
197
|
## Content: Container [d2l-dropdown-content]
|
198
198
|
`d2l-dropdown-content` is a generic container for dropdown content. It provides behavior such as sizing, positioning, and managing focus gain/loss.
|
199
199
|
|
200
|
-
<!-- docs: demo code properties name:d2l-dropdown-content align:flex-start autoSize:false autoOpen:true size:medium -->
|
200
|
+
<!-- docs: demo code properties name:d2l-dropdown-content sandboxTitle:'Dropdown Content - Container' align:flex-start autoSize:false autoOpen:true size:medium -->
|
201
201
|
```html
|
202
202
|
<script type="module">
|
203
203
|
import '@brightspace-ui/core/components/dropdown/dropdown-button.js';
|
@@ -255,7 +255,7 @@ To make your usage of `d2l-dropdown-more` accessible, use the following property
|
|
255
255
|
## Content: Menu [d2l-dropdown-menu]
|
256
256
|
`d2l-dropdown-menu` is a container for a [d2l-menu](https://github.com/BrightspaceUI/core/tree/main/components/menu) component. It provides additional support on top of `d2l-dropdown-content` for closing the menu when menu items are selected, resetting to the root of nested menus when reopening and automatic resizing when the menu resizes.
|
257
257
|
|
258
|
-
<!-- docs: demo code properties name:d2l-dropdown-menu align:flex-start autoSize:false size:medium -->
|
258
|
+
<!-- docs: demo code properties name:d2l-dropdown-menu sandboxTitle:'Dropdown Content - Menu' align:flex-start autoSize:false size:medium -->
|
259
259
|
```html
|
260
260
|
<script type="module">
|
261
261
|
import '@brightspace-ui/core/components/dropdown/dropdown-button.js';
|
@@ -294,7 +294,7 @@ To make your usage of `d2l-dropdown-more` accessible, use the following property
|
|
294
294
|
## Content: Tabs [d2l-dropdown-tabs]
|
295
295
|
`d2l-dropdown-tabs` is a container for a [d2l-tabs](https://github.com/BrightspaceUI/core/tree/main/components/tabs) component. It provides additional support on top of `d2l-dropdown-content` for automatic resizing when the tab changes.
|
296
296
|
|
297
|
-
<!-- docs: demo code properties name:d2l-dropdown-tabs autoOpen:true autoSize:false align:flex-start size:large -->
|
297
|
+
<!-- docs: demo code properties name:d2l-dropdown-tabs sandboxTitle:'Dropdown Content - Tab' autoOpen:true autoSize:false align:flex-start size:large -->
|
298
298
|
```html
|
299
299
|
<script type="module">
|
300
300
|
import '@brightspace-ui/core/components/dropdown/dropdown-button.js';
|
@@ -49,7 +49,7 @@ Empty state components are used to convey that there is no data available to be
|
|
49
49
|
|
50
50
|
The `d2l-empty-state-simple` component is an empty state component that displays a description. An [empty state action component](#d2l-empty-state-action-button) can be placed inside of the default slot to add an optional action.
|
51
51
|
|
52
|
-
<!-- docs: demo code properties name:d2l-empty-state-simple -->
|
52
|
+
<!-- docs: demo code properties name:d2l-empty-state-simple sandboxTitle:'Empty State - Simple' -->
|
53
53
|
```html
|
54
54
|
<script type="module">
|
55
55
|
import '@brightspace-ui/core/components/empty-state/empty-state-simple.js';
|
@@ -64,7 +64,7 @@ The `d2l-empty-state-illustrated` component is an empty state component that dis
|
|
64
64
|
|
65
65
|
The `illustration-name` property can be set to use one of the preset illustrations or a custom SVG illustration can be added in the `illustration` slot. The catalogue of preset empty state illustrations can be found [here](#preset-empty-state-illustrations).
|
66
66
|
|
67
|
-
<!-- docs: demo code properties name:d2l-empty-state-illustrated -->
|
67
|
+
<!-- docs: demo code properties name:d2l-empty-state-illustrated sandboxTitle:'Empty State - Illustrated' -->
|
68
68
|
```html
|
69
69
|
<script type="module">
|
70
70
|
import '@brightspace-ui/core/components/empty-state/empty-state-illustrated.js';
|
@@ -90,7 +90,7 @@ To add the button, place a `d2l-empty-state-action-button` component inside of t
|
|
90
90
|
|
91
91
|
The `primary` attribute can be set to render a primary button in place of the default subtle button. Note that the `primary` attribute is only valid when placed within `empty-state-illustrated` components and will have no effect on `empty-state-simple`.
|
92
92
|
|
93
|
-
<!-- docs: demo code properties name:d2l-empty-state-action-button -->
|
93
|
+
<!-- docs: demo code properties name:d2l-empty-state-action-button sandboxTitle:'Empty State Action - Button' -->
|
94
94
|
```html
|
95
95
|
<script type="module">
|
96
96
|
import '@brightspace-ui/core/components/empty-state/empty-state-action-button.js';
|
@@ -123,7 +123,7 @@ Use a `d2l-empty-state-action-link` to add a link that provides users with an ea
|
|
123
123
|
|
124
124
|
To add the link, place a `d2l-empty-state-action-link` component inside of the default slot of `empty-state-simple` or `empty-state-illustrated`. Only a single action can be placed within an empty state component.
|
125
125
|
|
126
|
-
<!-- docs: demo code properties name:d2l-empty-state-action-link -->
|
126
|
+
<!-- docs: demo code properties name:d2l-empty-state-action-link sandboxTitle:'Empty State Action - Link' -->
|
127
127
|
```html
|
128
128
|
<script type="module">
|
129
129
|
import '@brightspace-ui/core/components/empty-state/empty-state-action-link.js';
|
@@ -4,7 +4,7 @@ The `d2l-expand-collapse-content` element can be used to create expandable and c
|
|
4
4
|
|
5
5
|
## Expand Collapse Content [d2l-expand-collapse-content]
|
6
6
|
|
7
|
-
<!-- docs: demo code properties name:d2l-expand-collapse-content autoSize:false display:block size:small -->
|
7
|
+
<!-- docs: demo code properties name:d2l-expand-collapse-content sandboxTitle:'Expand Collapse Content' autoSize:false display:block size:small -->
|
8
8
|
```html
|
9
9
|
<script type="module">
|
10
10
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -33,7 +33,7 @@ Filter components are often used in conjuction with [tables](../../components/ta
|
|
33
33
|
|
34
34
|
The `d2l-filter` component allows a user to filter on one or more dimensions of data from a single dropdown.
|
35
35
|
|
36
|
-
<!-- docs: demo code properties name:d2l-filter align:start autoOpen:true autoSize:false size:large -->
|
36
|
+
<!-- docs: demo code properties name:d2l-filter sandboxTitle:'Filter' align:start autoOpen:true autoSize:false size:large -->
|
37
37
|
```html
|
38
38
|
<script type="module">
|
39
39
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -164,7 +164,7 @@ The filter will announce changes to filter selections, search results, and when
|
|
164
164
|
|
165
165
|
The `d2l-filter-dimension-set` component is the main dimension type that will work for most use cases. Used alongside the [d2l-filter-dimension-set-value](#d2l-filter-dimension-set-value), this will give you a selectable list of filter values.
|
166
166
|
|
167
|
-
<!-- docs: demo code properties name:d2l-filter-dimension-set align:start autoOpen:true autoSize:false size:large -->
|
167
|
+
<!-- docs: demo code properties name:d2l-filter-dimension-set sandboxTitle:'Filter Dimension Set' align:start autoOpen:true autoSize:false size:large -->
|
168
168
|
```html
|
169
169
|
<script type="module">
|
170
170
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -206,7 +206,7 @@ The `d2l-filter-dimension-set` component is the main dimension type that will wo
|
|
206
206
|
|
207
207
|
This component is built to be used alongside the [d2l-filter-dimension-set](#d2l-filter-dimension-set) component. It will give you a selectable list of filter values.
|
208
208
|
|
209
|
-
<!-- docs: demo code properties name:d2l-filter-dimension-set-value align:start autoOpen:true autoSize:false size:large -->
|
209
|
+
<!-- docs: demo code properties name:d2l-filter-dimension-set-value sandboxTitle:'Filter Dimension Set Value' align:start autoOpen:true autoSize:false size:large -->
|
210
210
|
```html
|
211
211
|
<script type="module">
|
212
212
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -237,7 +237,7 @@ This component is built to be used alongside the [d2l-filter-dimension-set](#d2l
|
|
237
237
|
|
238
238
|
This component is built to be used alongside the [d2l-filter-dimension-set](#d2l-filter-dimension-set) component. It will give you a selectable filter value based on the `range` defined on the component, which is to be one of a set of pre-defined range options. Selection triggers the `d2l-filter-change` event, with `start-value` and `end-value` (in UTC) being included in the changes for the `selected` item.
|
239
239
|
|
240
|
-
<!-- docs: demo code properties name:d2l-filter-dimension-set-date-text-value align:start autoOpen:true autoSize:false size:large -->
|
240
|
+
<!-- docs: demo code properties name:d2l-filter-dimension-set-date-text-value sandboxTitle:'Filter Dimension Set Value - Preset Date Range' align:start autoOpen:true autoSize:false size:large -->
|
241
241
|
```html
|
242
242
|
<script type="module">
|
243
243
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -301,7 +301,7 @@ The `getUTCDateTimeRange(rangeType, diff)` helper function can be used to get th
|
|
301
301
|
|
302
302
|
This component is built to be used alongside the [d2l-filter-dimension-set](#d2l-filter-dimension-set) component. It will give you a selectable filter value which expands to allow the user to select a date range using either the `d2l-input-date-time-range` or `d2l-input-date-range` component (depending on the `type` of the component). Selection triggers the `d2l-filter-change` event, with `start-value` and `end-value` (in UTC) being included in the changes for the `selected` item.
|
303
303
|
|
304
|
-
<!-- docs: demo code properties name:d2l-filter-dimension-set-date-time-range-value align:start autoOpen:true autoSize:false size:xlarge -->
|
304
|
+
<!-- docs: demo code properties name:d2l-filter-dimension-set-date-time-range-value sandboxTitle:'Filter Dimension Set Value - Date-Time Range' align:start autoOpen:true autoSize:false size:xlarge -->
|
305
305
|
```html
|
306
306
|
<script type="module">
|
307
307
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -398,7 +398,7 @@ Note that when using multiple filter dimensions, the counts should be updated wh
|
|
398
398
|
|
399
399
|
The `d2l-filter-dimension-set-empty-state` component allows you to customize the empty state components that are rendered in [d2l-filter-dimension-set](#d2l-filter-dimension-set). When placed in the `d2l-filter-dimension-set` empty state slots, it will replace the component's default empty state. This component can be placed in either the `set-empty-state` or the `search-empty-state` slots.
|
400
400
|
|
401
|
-
<!-- docs: demo code properties name:d2l-filter-dimension-set-empty-state align:start autoOpen:true autoSize:false size:large -->
|
401
|
+
<!-- docs: demo code properties name:d2l-filter-dimension-set-empty-state sandboxTitle:'Filter Dimension Set Empty State' align:start autoOpen:true autoSize:false size:large -->
|
402
402
|
```html
|
403
403
|
<script type="module">
|
404
404
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -434,7 +434,7 @@ The `d2l-filter-dimension-set-empty-state` component allows you to customize the
|
|
434
434
|
|
435
435
|
A tag-list allowing the user to see (and remove) the currently applied filters. Works with the `d2l-filter`. It supports hooking up to multiple filters.
|
436
436
|
|
437
|
-
<!-- docs: demo code properties name:d2l-filter-tags align:start display:block autoSize:false size:medium -->
|
437
|
+
<!-- docs: demo code properties name:d2l-filter-tags sandboxTitle:'Filter Tags' align:start display:block autoSize:false size:medium -->
|
438
438
|
```html
|
439
439
|
<script type="module">
|
440
440
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -505,7 +505,7 @@ A tag-list allowing the user to see (and remove) the currently applied filters.
|
|
505
505
|
|
506
506
|
The `d2l-filter-overflow-group` is a container for multiple filters that handles overflow on smaller screens. Overflowing filters are displayed in a single filter.
|
507
507
|
|
508
|
-
<!-- docs: demo code properties name:d2l-filter-overflow-group align:start display:block autoSize:false size:medium -->
|
508
|
+
<!-- docs: demo code properties name:d2l-filter-overflow-group sandboxTitle:'Filter Overflow Group' align:start display:block autoSize:false size:medium -->
|
509
509
|
```html
|
510
510
|
<script type="module">
|
511
511
|
import '@brightspace-ui/core/components/filter/filter.js';
|
@@ -6,7 +6,7 @@ This component assists with managing user focus within your web application.
|
|
6
6
|
|
7
7
|
The `d2l-focus-trap` is a generic container that will trap user focus from leaving. Focus will cycle to the first or last focusable elements when tabbing forwards or backwards respectively. It will also capture focus from the document when actively trapping.
|
8
8
|
|
9
|
-
<!-- docs: demo code properties name:d2l-focus-trap -->
|
9
|
+
<!-- docs: demo code properties name:d2l-focus-trap sandboxTitle:'Focus Trap' -->
|
10
10
|
```html
|
11
11
|
<script type="module">
|
12
12
|
import '@brightspace-ui/core/components/button/button.js';
|
@@ -8,7 +8,7 @@ The `d2l-html-block` element is a web component for displaying user-authored HTM
|
|
8
8
|
|
9
9
|
Pass the user-authored HTML into the `html` attribute of the `d2l-html-block` and the component will stamp the content into its local DOM where styles will be applied, and math typeset.
|
10
10
|
|
11
|
-
<!-- docs: demo code properties name:d2l-html-block autoSize:false size:small -->
|
11
|
+
<!-- docs: demo code properties name:d2l-html-block sandboxTitle:'HTML Block' autoSize:false size:small -->
|
12
12
|
```html
|
13
13
|
<script type="module">
|
14
14
|
import '@brightspace-ui/core/components/html-block/html-block.js';
|
@@ -118,4 +118,4 @@ const elem = await fixture(
|
|
118
118
|
html`<d2l-html-block html="..."></d2l-html-block>`,
|
119
119
|
{ mathjax: { renderLatex: true } }
|
120
120
|
);
|
121
|
-
```
|
121
|
+
```
|
@@ -34,7 +34,7 @@ Same size as the standard link, but bolder.
|
|
34
34
|
|
35
35
|
Import and use the `<d2l-link>` web component instead of the native `<a>` element:
|
36
36
|
|
37
|
-
<!-- docs: demo code properties name:d2l-link -->
|
37
|
+
<!-- docs: demo code properties name:d2l-link sandboxTitle:'Link' -->
|
38
38
|
```html
|
39
39
|
<script type="module">
|
40
40
|
import '@brightspace-ui/core/components/link/link.js';
|
@@ -102,7 +102,7 @@ When using `d2l-list`, the `grid` attribute will enable the table-like keyboard
|
|
102
102
|
|
103
103
|
The `d2l-list` is the container to create a styled list of items using `d2l-list-item` or `d2l-list-item-button`. It provides the appropriate `list` semantics as well as options for displaying separators, breakpoints for responsiveness, etc.
|
104
104
|
|
105
|
-
<!-- docs: demo code properties name:d2l-list display:block autoSize:false size:medium -->
|
105
|
+
<!-- docs: demo code properties name:d2l-list sandboxTitle:'List' display:block autoSize:false size:medium -->
|
106
106
|
```html
|
107
107
|
<script type="module">
|
108
108
|
import '@brightspace-ui/core/components/list/list.js';
|
@@ -440,7 +440,7 @@ If an item is draggable, the `drag-handle-text` attribute should be used to prov
|
|
440
440
|
|
441
441
|
The `d2l-list-controls` component can be placed in the `d2l-list`'s `controls` slot to provide a select-all checkbox, summary, a slot for `d2l-selection-action`s, and overflow-group behaviour.
|
442
442
|
|
443
|
-
<!-- docs: demo code properties name:d2l-list-controls display:block autoSize:false size:small -->
|
443
|
+
<!-- docs: demo code properties name:d2l-list-controls sandboxTitle:'List Controls' display:block autoSize:false size:small -->
|
444
444
|
```html
|
445
445
|
<script type="module">
|
446
446
|
import '@brightspace-ui/core/components/list/list.js';
|
@@ -492,7 +492,7 @@ The `d2l-list-controls` component can be placed in the `d2l-list`'s `controls` s
|
|
492
492
|
|
493
493
|
The `d2l-list-item` provides the appropriate `listitem` semantics for children within a list. It also provides some basic layout, a navigation link for the primary action, and selection.
|
494
494
|
|
495
|
-
<!-- docs: demo code properties name:d2l-list-item autoSize:false size:small -->
|
495
|
+
<!-- docs: demo code properties name:d2l-list-item sandboxTitle:'List Item' autoSize:false size:small -->
|
496
496
|
```html
|
497
497
|
<script type="module">
|
498
498
|
import '@brightspace-ui/core/components/button/button-icon.js';
|
@@ -554,7 +554,7 @@ The `d2l-list-item` provides the appropriate `listitem` semantics for children w
|
|
554
554
|
|
555
555
|
The `d2l-list-item-button` provides the same functionality as `d2l-list-item` except with button semantics for its primary action.
|
556
556
|
|
557
|
-
<!-- docs: demo code properties name:d2l-list-item-button display:block -->
|
557
|
+
<!-- docs: demo code properties name:d2l-list-item-button sandboxTitle:'List Item Button' display:block -->
|
558
558
|
```html
|
559
559
|
<script type="module">
|
560
560
|
import '@brightspace-ui/core/components/list/list.js';
|
@@ -640,7 +640,7 @@ Where the parameters correspond to the slots of `d2l-list-item`:
|
|
640
640
|
|
641
641
|
The `d2l-list-item-content` provides additional consistent layout for primary and secondary text in item content. It may be used with or without the `illustration` and `action` slots mentioned above.
|
642
642
|
|
643
|
-
<!-- docs: demo code properties name:d2l-list-item-content display:block -->
|
643
|
+
<!-- docs: demo code properties name:d2l-list-item-content sandboxTitle:'List Item Content' display:block -->
|
644
644
|
```html
|
645
645
|
<script type="module">
|
646
646
|
import '@brightspace-ui/core/components/list/list.js';
|
@@ -28,7 +28,7 @@ A loading spinner indicates that something is happening and we don't know how lo
|
|
28
28
|
|
29
29
|
## Loading Spinner [d2l-loading-spinner]
|
30
30
|
|
31
|
-
<!-- docs: demo code properties name:d2l-loading-spinner -->
|
31
|
+
<!-- docs: demo code properties name:d2l-loading-spinner sandboxTitle:'Loading Spinner' -->
|
32
32
|
```html
|
33
33
|
<script type="module">
|
34
34
|
import '@brightspace-ui/core/components/loading-spinner/loading-spinner.js';
|
@@ -27,7 +27,7 @@ A basic menu can be defined using `d2l-menu` and a combination of menu items (e.
|
|
27
27
|
|
28
28
|
**Note:** `d2l-menu` renders without an outer border since it's typically used in a context where a containing element defines a border (ex. `d2l-dropdown-menu` or side nav).
|
29
29
|
|
30
|
-
<!-- docs: demo code properties name:d2l-menu -->
|
30
|
+
<!-- docs: demo code properties name:d2l-menu sandboxTitle:'Menu' -->
|
31
31
|
```html
|
32
32
|
<script type="module">
|
33
33
|
import '@brightspace-ui/core/components/menu/menu.js';
|
@@ -64,7 +64,7 @@ To make your usage of `d2l-menu` accessible, use the following property:
|
|
64
64
|
|
65
65
|
The `d2l-menu-item` component is used with JS handlers and can be wired-up to the `d2l-menu-item-select` event.
|
66
66
|
|
67
|
-
<!-- docs: demo code properties name:d2l-menu-item -->
|
67
|
+
<!-- docs: demo code properties name:d2l-menu-item sandboxTitle:'Menu Item' -->
|
68
68
|
```html
|
69
69
|
<script type="module">
|
70
70
|
import '@brightspace-ui/core/components/menu/menu.js';
|
@@ -116,7 +116,7 @@ To make your usage of `d2l-menu-item` accessible, use the following property:
|
|
116
116
|
|
117
117
|
This `d2l-menu-item-link` is used for navigating. It gives users the ability to right-click and open in a new tab.
|
118
118
|
|
119
|
-
<!-- docs: demo code properties name:d2l-menu-item-link -->
|
119
|
+
<!-- docs: demo code properties name:d2l-menu-item-link sandboxTitle:'Menu Item Link' -->
|
120
120
|
```html
|
121
121
|
<script type="module">
|
122
122
|
import '@brightspace-ui/core/components/menu/menu.js';
|
@@ -156,7 +156,7 @@ To make your usage of `d2l-menu-item-link` accessible, use the following propert
|
|
156
156
|
|
157
157
|
The `d2l-menu-item-checkbox` component is used for selection. It can be wired-up to the `d2l-menu-item-change` event. Multiple checkboxes can be selected at once.
|
158
158
|
|
159
|
-
<!-- docs: demo code properties name:d2l-menu-item-checkbox -->
|
159
|
+
<!-- docs: demo code properties name:d2l-menu-item-checkbox sandboxTitle:'Menu Item Checkbox' -->
|
160
160
|
```html
|
161
161
|
<script type="module">
|
162
162
|
import '@brightspace-ui/core/components/menu/menu.js';
|
@@ -206,7 +206,7 @@ To make your usage of `d2l-menu-item-checkbox` accessible, use the following pro
|
|
206
206
|
|
207
207
|
The `d2l-menu-item-radio` component is used for selection. It can be wired-up to the `d2l-menu-item-change` event. Only one radio item in a given `<d2l-menu>` may be selected at once (i.e., selecting one option will deselect the other selected `d2l-menu-item-radio` item).
|
208
208
|
|
209
|
-
<!-- docs: demo code properties name:d2l-menu-item-radio -->
|
209
|
+
<!-- docs: demo code properties name:d2l-menu-item-radio sandboxTitle:'Menu Item Radio' -->
|
210
210
|
```html
|
211
211
|
<script type="module">
|
212
212
|
import '@brightspace-ui/core/components/menu/menu.js';
|
@@ -256,7 +256,7 @@ To make your usage of `d2l-menu-item-radio` accessible, use the following proper
|
|
256
256
|
|
257
257
|
The `d2l-menu-item-separator` component can be used to semantically separate menu items.
|
258
258
|
|
259
|
-
<!-- docs: demo code properties name:d2l-menu-item-separator -->
|
259
|
+
<!-- docs: demo code properties name:d2l-menu-item-separator sandboxTitle:'Menu Item Separator' -->
|
260
260
|
```html
|
261
261
|
<script type="module">
|
262
262
|
import '@brightspace-ui/core/components/menu/menu.js';
|
@@ -36,7 +36,7 @@ Meters are a visually engaging way to communicate progress or measurements.
|
|
36
36
|
|
37
37
|
Linear meters show a horizontal progress bar.
|
38
38
|
|
39
|
-
<!-- docs: demo code properties name:d2l-meter-linear -->
|
39
|
+
<!-- docs: demo code properties name:d2l-meter-linear sandboxTitle:'Linear Meter' -->
|
40
40
|
```html
|
41
41
|
<script type="module">
|
42
42
|
import '@brightspace-ui/core/components/meter/meter-linear.js';
|
@@ -68,7 +68,7 @@ Linear meters show a horizontal progress bar.
|
|
68
68
|
|
69
69
|
Radial meters appear as a half circle. They have more visual weight than a linear meter and should only be used when the data is central to the user's task.
|
70
70
|
|
71
|
-
<!-- docs: demo code properties name:d2l-meter-radial size:medium -->
|
71
|
+
<!-- docs: demo code properties name:d2l-meter-radial sandboxTitle:'Radial Meter' size:medium -->
|
72
72
|
```html
|
73
73
|
<script type="module">
|
74
74
|
import '@brightspace-ui/core/components/meter/meter-radial.js';
|
@@ -92,7 +92,7 @@ Radial meters appear as a half circle. They have more visual weight than a line
|
|
92
92
|
|
93
93
|
Circle meters display data in a compact circle format, so they're useful when horizontal space is at a premium.
|
94
94
|
|
95
|
-
<!-- docs: demo code properties name:d2l-meter-circle -->
|
95
|
+
<!-- docs: demo code properties name:d2l-meter-circle sandboxTitle:'Circular Meter' -->
|
96
96
|
```html
|
97
97
|
<script type="module">
|
98
98
|
import '@brightspace-ui/core/components/meter/meter-circle.js';
|
@@ -4,7 +4,7 @@ The `d2l-more-less` element can be used to minimize the display of long content,
|
|
4
4
|
|
5
5
|
## More-Less [d2l-more-less]
|
6
6
|
|
7
|
-
<!-- docs: demo code properties name:d2l-more-less -->
|
7
|
+
<!-- docs: demo code properties name:d2l-more-less sandboxTitle:'More-Less' -->
|
8
8
|
```html
|
9
9
|
<script type="module">
|
10
10
|
import '@brightspace-ui/core/components/more-less/more-less.js';
|
@@ -36,7 +36,7 @@ Object property lists are simple dot-separated lists of text, displayed sequenti
|
|
36
36
|
|
37
37
|
An object property list can be defined using `d2l-object-property-list` and a combination of items (e.g., `d2l-object-property-list-item`, `d2l-object-property-list-item-link`).
|
38
38
|
|
39
|
-
<!-- docs: demo code properties name:d2l-object-property-list -->
|
39
|
+
<!-- docs: demo code properties name:d2l-object-property-list sandboxTitle:'Object Property List' -->
|
40
40
|
```html
|
41
41
|
<script type="module">
|
42
42
|
import '@brightspace-ui/core/components/object-property-list/object-property-list.js';
|
@@ -79,7 +79,7 @@ The object property list is designed to wrap in an inline manner if the items ar
|
|
79
79
|
|
80
80
|
The `d2l-object-property-list-item` component is the basic type of item for an object property list, displaying text and an optional leading icon.
|
81
81
|
|
82
|
-
<!-- docs: demo code properties name:d2l-object-property-list-item -->
|
82
|
+
<!-- docs: demo code properties name:d2l-object-property-list-item sandboxTitle:'Object Property List Item' -->
|
83
83
|
```html
|
84
84
|
<script type="module">
|
85
85
|
import '@brightspace-ui/core/components/object-property-list/object-property-list.js';
|
@@ -105,7 +105,7 @@ The `d2l-object-property-list-item` component is the basic type of item for an o
|
|
105
105
|
|
106
106
|
The `d2l-object-property-list-item-link` component is a link item for the object property list. It displays text as a hyperlink, with an optional leading icon.
|
107
107
|
|
108
|
-
<!-- docs: demo code properties name:d2l-object-property-list-item-link -->
|
108
|
+
<!-- docs: demo code properties name:d2l-object-property-list-item-link sandboxTitle:'Object Property List Link Item' -->
|
109
109
|
```html
|
110
110
|
<script type="module">
|
111
111
|
import '@brightspace-ui/core/components/object-property-list/object-property-list.js';
|
@@ -134,7 +134,7 @@ The `d2l-object-property-list-item-link` component is a link item for the object
|
|
134
134
|
|
135
135
|
Object property lists can optionally contain a single `d2l-status-indicator` inserted into the `status` slot.
|
136
136
|
|
137
|
-
<!-- docs: demo code properties name:d2l-status-indicator -->
|
137
|
+
<!-- docs: demo code properties name:d2l-status-indicator sandboxTitle:'Status Indicator' -->
|
138
138
|
```html
|
139
139
|
<script type="module">
|
140
140
|
import '@brightspace-ui/core/components/object-property-list/object-property-list.js';
|
@@ -6,7 +6,7 @@ Positioning content off-screen is a valuable accessibility technique that allows
|
|
6
6
|
|
7
7
|
Import the `<d2l-offscreen>` web component and place your content within the default slot to position it off-screen. The content will be hidden in the UI but still discoverable by screen reader users.
|
8
8
|
|
9
|
-
<!-- docs: demo code properties name:d2l-offscreen -->
|
9
|
+
<!-- docs: demo code properties name:d2l-offscreen sandboxTitle:'Offscreen Component' -->
|
10
10
|
```html
|
11
11
|
<!-- docs: start hidden content -->
|
12
12
|
<style>
|
@@ -30,7 +30,7 @@ The `d2l-overflow-group` element can be used to add responsiveness to a set of b
|
|
30
30
|
## Overflow Group [d2l-overflow-group]
|
31
31
|
Items added to this container element will no longer wrap onto a second line when the container becomes too small, but will be added to a dropdown menu with configurable styling.
|
32
32
|
|
33
|
-
<!-- docs: demo code properties name:d2l-overflow-group autoSize:false display:block size:medium -->
|
33
|
+
<!-- docs: demo code properties name:d2l-overflow-group sandboxTitle:'Overflow Group' autoSize:false display:block size:medium -->
|
34
34
|
```html
|
35
35
|
<script type="module">
|
36
36
|
import '@brightspace-ui/core/components/overflow-group/overflow-group.js';
|
@@ -5,7 +5,7 @@ Scroll containers can be used to control how content acts when overflowing its c
|
|
5
5
|
|
6
6
|
The `d2l-scroll-wrapper` element can be used to wrap content which may overflow its horizontal boundaries, providing left/right scroll buttons.
|
7
7
|
|
8
|
-
<!-- docs: demo code properties name:d2l-scroll-wrapper -->
|
8
|
+
<!-- docs: demo code properties name:d2l-scroll-wrapper sandboxTitle:'Scroll Wrapper' -->
|
9
9
|
```html
|
10
10
|
<script type="module">
|
11
11
|
import '@brightspace-ui/core/components/scroll-wrapper/scroll-wrapper.js';
|
@@ -12,7 +12,7 @@ The `SelectionMixin` enables the creation of custom selection control components
|
|
12
12
|
|
13
13
|
The `SelectionMixin` defines the `selection-single` attribute that consumers can specify for single selection behaviour.
|
14
14
|
|
15
|
-
<!-- docs: demo code properties name:d2l-demo-selection display:block -->
|
15
|
+
<!-- docs: demo code properties name:d2l-demo-selection sandboxTitle:'Selection Mixin' display:block -->
|
16
16
|
```html
|
17
17
|
<script type="module">
|
18
18
|
import { css, html, LitElement } from 'lit';
|
@@ -107,7 +107,7 @@ Define a custom web component that extends the `SelectionMixin`. The selection c
|
|
107
107
|
|
108
108
|
The `d2l-selection-action` is an optional component that provides a button for actions associated with the [selection control](#selectionmixin) (ex. bulk actions). The `requires-selection` attribute may be specified to indicate that the button should be non-interactive if nothing is selected.
|
109
109
|
|
110
|
-
<!-- docs: demo code properties name:d2l-selection-action -->
|
110
|
+
<!-- docs: demo code properties name:d2l-selection-action sandboxTitle:'Selection Action' -->
|
111
111
|
```html
|
112
112
|
<script type="module">
|
113
113
|
import '@brightspace-ui/core/components/selection/selection-action.js';
|
@@ -136,7 +136,7 @@ The `d2l-selection-action` is an optional component that provides a button for a
|
|
136
136
|
|
137
137
|
The `d2l-selection-action-dropdown` is an optional component that provides a button opener for dropdown content associated with the [selection control](#selectionmixin) (ex. bulk actions). The `requires-selection` attribute may be specified to indicate that the opener should be non-interactive if nothing is selected.
|
138
138
|
|
139
|
-
<!-- docs: demo code properties name:d2l-selection-action-dropdown align:baseline -->
|
139
|
+
<!-- docs: demo code properties name:d2l-selection-action-dropdown sandboxTitle:'Selection Action Dropdown' align:baseline -->
|
140
140
|
```html
|
141
141
|
<script type="module">
|
142
142
|
import '@brightspace-ui/core/components/dropdown/dropdown-menu.js';
|
@@ -166,7 +166,7 @@ The `d2l-selection-action-dropdown` is an optional component that provides a but
|
|
166
166
|
|
167
167
|
The `d2l-selection-action-menu-item` is an optional component that is a menu item for actions associated with the [selection control](#selectionmixin) (ex. bulk actions). The `requires-selection` attribute may be specified to indicate that the menu item should be non-interactive if nothing is selected. This component enables the app to define an opener that is enabled regardless of the selection state, while having a menu containing one or more menu items that `requires-selection`.
|
168
168
|
|
169
|
-
<!-- docs: demo code properties name:d2l-selection-action-menu-item autoSize:false size:medium align:baseline -->
|
169
|
+
<!-- docs: demo code properties name:d2l-selection-action-menu-item sandboxTitle:'Selection Action Menu Item' autoSize:false size:medium align:baseline -->
|
170
170
|
```html
|
171
171
|
<script type="module">
|
172
172
|
import '@brightspace-ui/core/components/dropdown/dropdown-button-subtle.js';
|
@@ -208,7 +208,7 @@ If `d2l-selection-input` is placed within a selection control that specifies `se
|
|
208
208
|
|
209
209
|
Note: `d2l-list-item` already provides a selection input for selectable list items.
|
210
210
|
|
211
|
-
<!-- docs: demo code properties name:d2l-selection-input display:block -->
|
211
|
+
<!-- docs: demo code properties name:d2l-selection-input sandboxTitle:'Selection Input' display:block -->
|
212
212
|
```html
|
213
213
|
<script type="module">
|
214
214
|
import '@brightspace-ui/core/components/selection/selection-input.js';
|
@@ -266,7 +266,7 @@ The `d2l-selection-select-all` is an optional component that provides a checkbox
|
|
266
266
|
|
267
267
|
The `d2l-selection-select-all` component may be placed inside the selection control, or in the same DOM scope with the `selection-for` attribute set to the id of that component. In the example below, setting `selection-for` to `other-list` demonstrates the ability to use `d2l-selection-select-all` from outside of the selection control component.
|
268
268
|
|
269
|
-
<!-- docs: demo code properties name:d2l-selection-select-all display:block -->
|
269
|
+
<!-- docs: demo code properties name:d2l-selection-select-all sandboxTitle:'Selection Select All' display:block -->
|
270
270
|
```html
|
271
271
|
<script type="module">
|
272
272
|
import '@brightspace-ui/core/components/selection/selection-action.js';
|
@@ -351,7 +351,7 @@ The `d2l-selection-summary` is an optional component that shows a simple count o
|
|
351
351
|
|
352
352
|
The `d2l-selection-summary` component may be placed inside the selection control, or in the same DOM scope with the `selection-for` attribute set to the id of that component. In the example below, setting `selection-for` to `other-list` demonstrates the ability to use `d2l-selection-summary` from outside of the selection control component.
|
353
353
|
|
354
|
-
<!-- docs: demo code properties name:d2l-selection-summary display:block -->
|
354
|
+
<!-- docs: demo code properties name:d2l-selection-summary sandboxTitle:'Selection Summary' display:block -->
|
355
355
|
```html
|
356
356
|
<script type="module">
|
357
357
|
import '@brightspace-ui/core/components/selection/selection-action.js';
|
@@ -436,7 +436,7 @@ The `d2l-selection-controls` provides a standardized wrapper to display selectio
|
|
436
436
|
|
437
437
|
When using lists, use the list-specific `d2l-list-controls` instead, which extends this component's behaviour.
|
438
438
|
|
439
|
-
<!-- docs: demo code properties name:d2l-selection-controls display:block autoSize:false size:small -->
|
439
|
+
<!-- docs: demo code properties name:d2l-selection-controls sandboxTitle:'Selection Controls' display:block autoSize:false size:small -->
|
440
440
|
```html
|
441
441
|
<script type="module">
|
442
442
|
import '@brightspace-ui/core/components/selection/selection-action.js';
|
@@ -58,7 +58,7 @@ Status Indicators are used to communicate the status of an item. They are non-in
|
|
58
58
|
|
59
59
|
## Status Indicator [d2l-status-indicator]
|
60
60
|
|
61
|
-
<!-- docs: demo code properties name:d2l-status-indicator -->
|
61
|
+
<!-- docs: demo code properties name:d2l-status-indicator sandboxTitle:'Status Indicator' -->
|
62
62
|
```html
|
63
63
|
<script type="module">
|
64
64
|
import '@brightspace-ui/core/components/status-indicator/status-indicator.js';
|
@@ -30,7 +30,7 @@ A switch is used to toggle between two states, on and off, just like a light swi
|
|
30
30
|
## Switch [d2l-switch]
|
31
31
|
The `d2l-switch` element is a generic switch with on/off semantics.
|
32
32
|
|
33
|
-
<!-- docs: demo code properties name:d2l-switch autoSize:false size:small -->
|
33
|
+
<!-- docs: demo code properties name:d2l-switch sandboxTitle:'Switch' autoSize:false size:small -->
|
34
34
|
```html
|
35
35
|
<script type="module">
|
36
36
|
import '@brightspace-ui/core/components/switch/switch.js';
|
@@ -58,7 +58,7 @@ The d2l-switch-visibility component is a special variant for toggling the visibi
|
|
58
58
|
|
59
59
|
See also [Visibility Switch with Conditions](https://daylight.d2l.dev/components/switch/#visibility-switch-with-conditions).
|
60
60
|
|
61
|
-
<!-- docs: demo code properties name:d2l-switch-visibility autoSize:false size:small -->
|
61
|
+
<!-- docs: demo code properties name:d2l-switch-visibility sandboxTitle:'Visibility Switch' autoSize:false size:small -->
|
62
62
|
```html
|
63
63
|
<script type="module">
|
64
64
|
import '@brightspace-ui/core/components/switch/switch-visibility.js';
|
@@ -45,7 +45,7 @@ If the viewport is very narrow — for example, on a mobile device — it may be
|
|
45
45
|
|
46
46
|
The `d2l-table-wrapper` element can be combined with table styles to apply default/light styling, row selection styles, overflow scrolling and sticky headers to native `<table>` elements within your Lit components.
|
47
47
|
|
48
|
-
<!-- docs: demo code properties name:d2l-table-wrapper display:block -->
|
48
|
+
<!-- docs: demo code properties name:d2l-table-wrapper sandboxTitle:'Table Wrapper' display:block -->
|
49
49
|
```html
|
50
50
|
<script type="module">
|
51
51
|
import { html, LitElement } from 'lit';
|
@@ -244,7 +244,7 @@ Note that the example below hides much of the implementation. See the code in [M
|
|
244
244
|
|
245
245
|
This is a radio menu item to be used within the `d2l-table-col-sort-button` component for a [multi-faceted sort](#multi-faceted-sort-button).
|
246
246
|
|
247
|
-
<!-- docs: demo code properties autoSize:false align:start name:d2l-table-col-sort-button-item -->
|
247
|
+
<!-- docs: demo code properties autoSize:false align:start name:d2l-table-col-sort-button-item sandboxTitle:'Table Sortable Column Button - Slotted Item' -->
|
248
248
|
```html
|
249
249
|
<script type="module">
|
250
250
|
import '@brightspace-ui/core/components/table/table-col-sort-button.js';
|
@@ -434,7 +434,7 @@ Load-More paging functionality can be implemented in tables by placing a `d2l-pa
|
|
434
434
|
|
435
435
|
The `d2l-table-controls` component can be placed in the `d2l-table-wrapper`'s `controls` slot to provide a selection summary, a slot for `d2l-selection-action`s, and overflow-group behaviour.
|
436
436
|
|
437
|
-
<!-- docs: demo code properties name:d2l-table-controls display:block -->
|
437
|
+
<!-- docs: demo code properties name:d2l-table-controls sandboxTitle:'Table Controls' display:block -->
|
438
438
|
```html
|
439
439
|
<script type="module">
|
440
440
|
import '@brightspace-ui/core/components/selection/selection-action.js';
|
@@ -39,7 +39,7 @@ Tabs are used to present related information in mutually exclusive panels, allow
|
|
39
39
|
|
40
40
|
The `d2l-tabs` element is a web component for tabbed content. It provides the `d2l-tab-panel` component for the content, renders tabs responsively, and provides virtual scrolling for large tab lists.
|
41
41
|
|
42
|
-
<!-- docs: demo code properties name:d2l-tabs display:block -->
|
42
|
+
<!-- docs: demo code properties name:d2l-tabs sandboxTitle:'Tab' display:block -->
|
43
43
|
```html
|
44
44
|
<script type="module">
|
45
45
|
import '@brightspace-ui/core/components/tabs/tabs.js';
|
@@ -69,7 +69,7 @@ The `d2l-tabs` element is a web component for tabbed content. It provides the `d
|
|
69
69
|
## Tab Panels [d2l-tab-panel]
|
70
70
|
Selecting a tab in the tab bar causes the relevant tab panel to be displayed. Tab panels can contain text, form controls, rich media, or just about anything else. There is an optional “slot” available for related controls such as a Settings button.
|
71
71
|
|
72
|
-
<!-- docs: demo code properties name:d2l-tab-panel display:block -->
|
72
|
+
<!-- docs: demo code properties name:d2l-tab-panel sandboxTitle:'Tab Panels' display:block -->
|
73
73
|
```html
|
74
74
|
<script type="module">
|
75
75
|
import '@brightspace-ui/core/components/tabs/tabs.js';
|
@@ -30,7 +30,7 @@ The `d2l-tag-list` element can take a combination of any type of `d2l-tag-list-i
|
|
30
30
|
|
31
31
|
The corresponding `*-clear` event must be listened to for whatever component (`d2l-tag-list` or `d2l-tag-list-item`) has `clearable` on it and that listener must handle individual `d2l-tag-list-item` deletion as well as potentially focus behavior (see individual event descriptions).
|
32
32
|
|
33
|
-
<!-- docs: demo code properties name:d2l-tag-list autoSize:false display:block size:small -->
|
33
|
+
<!-- docs: demo code properties name:d2l-tag-list sandboxTitle:'Tag List' autoSize:false display:block size:small -->
|
34
34
|
```html
|
35
35
|
<script type="module">
|
36
36
|
import '@brightspace-ui/core/components/tag-list/tag-list.js';
|
@@ -60,7 +60,7 @@ The corresponding `*-clear` event must be listened to for whatever component (`d
|
|
60
60
|
## Tag List Item [d2l-tag-list-item]
|
61
61
|
The `d2l-tag-list-item` provides the appropriate semantics and styling for children within a tag list. Tag List items do not work outside of a Tag List and should not be used on their own.
|
62
62
|
|
63
|
-
<!-- docs: demo code properties name:d2l-tag-list-item autoSize:false display:block size:small -->
|
63
|
+
<!-- docs: demo code properties name:d2l-tag-list-item sandboxTitle:'Tag List Item' autoSize:false display:block size:small -->
|
64
64
|
```html
|
65
65
|
<script type="module">
|
66
66
|
import '@brightspace-ui/core/components/tag-list/tag-list.js';
|
@@ -74,13 +74,13 @@ The `d2l-tooltip` component is used to display additional information when users
|
|
74
74
|
<!-- docs: end donts -->
|
75
75
|
<!-- docs: end best practices -->
|
76
76
|
|
77
|
-
<!-- docs: demo code properties name:d2l-tooltip autoSize:false size:small -->
|
77
|
+
<!-- docs: demo code properties name:d2l-tooltip sandboxTitle:'Tooltip' autoSize:false size:small -->
|
78
78
|
```html
|
79
79
|
<script type="module">
|
80
80
|
import '@brightspace-ui/core/components/inputs/input-text.js';
|
81
81
|
import '@brightspace-ui/core/components/tooltip/tooltip.js';
|
82
82
|
</script>
|
83
|
-
<!-- docs: start hidden content -->
|
83
|
+
<!-- docs: start hidden content -->
|
84
84
|
<script>
|
85
85
|
window.addEventListener('load', function () {
|
86
86
|
setTimeout(function() {
|
@@ -141,7 +141,7 @@ In the following example to constrain the tooltip to the dashed boundary we can
|
|
141
141
|
import '@brightspace-ui/core/components/button/button.js';
|
142
142
|
import '@brightspace-ui/core/components/tooltip/tooltip.js';
|
143
143
|
</script>
|
144
|
-
<!-- docs: start hidden content -->
|
144
|
+
<!-- docs: start hidden content -->
|
145
145
|
<script>
|
146
146
|
window.addEventListener('load', function () {
|
147
147
|
setTimeout(function() {
|
@@ -193,12 +193,12 @@ The `d2l-tooltip-help` component is used to display additional information when
|
|
193
193
|
<!-- docs: end donts -->
|
194
194
|
<!-- docs: end best practices -->
|
195
195
|
|
196
|
-
<!-- docs: demo code properties name:d2l-tooltip-help autoSize:false size:medium -->
|
196
|
+
<!-- docs: demo code properties name:d2l-tooltip-help sandboxTitle:'Help Tooltip' autoSize:false size:medium -->
|
197
197
|
```html
|
198
198
|
<script type="module">
|
199
199
|
import '@brightspace-ui/core/components/tooltip/tooltip-help.js';
|
200
200
|
</script>
|
201
|
-
<!-- docs: start hidden content -->
|
201
|
+
<!-- docs: start hidden content -->
|
202
202
|
<script>
|
203
203
|
window.addEventListener('load', function () {
|
204
204
|
setTimeout(function() {
|
@@ -227,10 +227,10 @@ The `d2l-tooltip-help` component is used to display additional information when
|
|
227
227
|
|
228
228
|
### Using in a Sentence or Paragraph
|
229
229
|
|
230
|
-
When placing a help tooltip next to other text as part of a sentence or a paragraph, use `inherit-font-style` to align its style with the adjacent text
|
230
|
+
When placing a help tooltip next to other text as part of a sentence or a paragraph, use `inherit-font-style` to align its style with the adjacent text
|
231
231
|
(see the demo example above).
|
232
232
|
|
233
|
-
Note that the help tooltip does not support being used *within* a language term, due to challenges with translation.
|
234
|
-
Instead, your opener text will need to be a separate language term appearing before or after the other text and making sense on its own.
|
233
|
+
Note that the help tooltip does not support being used *within* a language term, due to challenges with translation.
|
234
|
+
Instead, your opener text will need to be a separate language term appearing before or after the other text and making sense on its own.
|
235
235
|
|
236
236
|
See also the [Visibility Switch](https://daylight.d2l.dev/components/switch/#d2l-switch-visibility) for an example use case.
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@brightspace-ui/core",
|
3
|
-
"version": "3.
|
3
|
+
"version": "3.27.0",
|
4
4
|
"description": "A collection of accessible, free, open-source web components for building Brightspace applications",
|
5
5
|
"type": "module",
|
6
6
|
"repository": "https://github.com/BrightspaceUI/core.git",
|
@@ -16,7 +16,7 @@ If no nodes are assigned to the `footer` slot, the footer is hidden.
|
|
16
16
|
|
17
17
|
Note: this template automatically includes `<header>`, `<main>`, `<aside>` and `<footer>` elements, so there's no need to include them inside the various slots.
|
18
18
|
|
19
|
-
<!-- docs: demo code properties name:d2l-template-primary-secondary autoSize:false size:large -->
|
19
|
+
<!-- docs: demo code properties name:d2l-template-primary-secondary sandboxTitle:'Templates - Primary-Secondary' autoSize:false size:large -->
|
20
20
|
```html
|
21
21
|
<script type="module">
|
22
22
|
import '@brightspace-ui/core/templates/primary-secondary/primary-secondary.js';
|