@brightspace-ui/labs 2.26.0 → 2.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/package.json CHANGED
@@ -111,5 +111,5 @@
111
111
  "resize-observer-polyfill": "^1",
112
112
  "webvtt-parser": "^2.1.2"
113
113
  },
114
- "version": "2.26.0"
114
+ "version": "2.27.0"
115
115
  }
@@ -1,16 +1,26 @@
1
- # d2l-labs-attribute-picker
1
+ # Attribute Picker
2
2
 
3
- The `d2l-labs-attribute-picker` component is an autocompleting dropdown to choose one or more new or pre-existing attributes inline.
3
+ This component is an autocompleting dropdown to choose one or more new or pre-existing attributes inline.
4
4
 
5
- ## Usage
5
+ ## Attribute Picker [d2l-labs-attribute-picker]
6
6
 
7
+ <!-- docs: demo code align:flex-start autoSize:false size:medium -->
7
8
  ```html
8
9
  <script type="module">
9
- import '@brightspace-ui/labs/components/attribute-picker.js';
10
+ import '@brightspace-ui/labs/components/attribute-picker.js';
10
11
  </script>
11
- <d2l-labs-attribute-picker></d2l-labs-attribute-picker>
12
+ <d2l-labs-attribute-picker
13
+ label="attributes"
14
+ invalid-tooltip-text="You're missing something"
15
+ required
16
+ allow-freeform
17
+ limit="5"
18
+ assignable-attributes='[{"name":"one","value":1},{"name":"two","value":2},{"name":"three","value":3},{"name":"four","value":4},{"name":"five","value":5},{"name":"six","value":6},{"name":"seven","value":7}]'
19
+ ></d2l-labs-attribute-picker>
12
20
  ```
13
21
 
22
+ <!-- docs: start hidden content -->
23
+
14
24
  **Properties:**
15
25
 
16
26
  | Property | Type | Description |
@@ -31,3 +41,5 @@ The `d2l-labs-attribute-picker` component is an autocompleting dropdown to choos
31
41
  - `limit`: the limit that was hit
32
42
  - `d2l-labs-attribute-picker-text-changed`: dispatched when text is entered into the text input. Event `detail` include:
33
43
  - `text`: the current value of the text input
44
+
45
+ <!-- docs: end hidden content -->
@@ -1,18 +1,23 @@
1
- # d2l-labs-checkbox-drawer
1
+ # Checkbox Drawer
2
2
 
3
- The `d2l-labs-checkbox-drawer` element can be used to get a checkbox with a description. When checked, drawer contents are revealed underneath.
3
+ The checkbox drawer can be used to get a checkbox with a description. When checked, drawer contents are revealed underneath.
4
4
 
5
- ## Usage
5
+ ## Checkbox Drawer [d2l-labs-checkbox-drawer]
6
6
 
7
+ <!-- docs: demo code align:flex-start autoSize:false size:small -->
7
8
  ```html
8
9
  <script type="module">
9
- import '@brightspace-ui/labs/components/checkbox-drawer.js';
10
+ import '@brightspace-ui/labs/components/checkbox-drawer.js';
10
11
  </script>
11
- <d2l-labs-checkbox-drawer>
12
- <p>My drawer content.</p>
12
+ <d2l-labs-checkbox-drawer
13
+ label="Checkbox drawer label."
14
+ description="Checkbox drawer description. Check the box to see the drawer message.">
15
+ Hello there! Uncheck the box to hide me.
13
16
  </d2l-labs-checkbox-drawer>
14
17
  ```
15
18
 
19
+ <!-- docs: start hidden content -->
20
+
16
21
  **Properties:**
17
22
 
18
23
  | Property | Type | Description |
@@ -27,3 +32,5 @@ The `d2l-labs-checkbox-drawer` element can be used to get a checkbox with a desc
27
32
  - `d2l-labs-checkbox-drawer-checked-change`: dispatched when checkbox's state changes.
28
33
  - `d2l-labs-checkbox-drawer-expand`: dispatched when the drawer starts to expand. As per the [expand collapse component](https://github.com/BrightspaceUI/core/tree/master/components/expand-collapse), the `detail` contains an `expandComplete` promise that can be waited on to determine when the content has finished expanding.
29
34
  - `d2l-labs-checkbox-drawer-collapse`: dispatched when the drawer starts to collapse. As per the [expand collapse component](https://github.com/BrightspaceUI/core/tree/master/components/expand-collapse), the `detail` contains a `collapseComplete` promise that can be waited on to determine when the content has finished collapsing.
35
+
36
+ <!-- docs: end hidden content -->