@brightspace-ui/core 2.29.2 → 2.29.3
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/filter/README.md +19 -2
- package/package.json +1 -1
|
@@ -161,7 +161,7 @@ The filter will announce changes to filter selections, search results, and when
|
|
|
161
161
|
|
|
162
162
|
## Filter Dimension: Set [d2l-filter-dimension-set]
|
|
163
163
|
|
|
164
|
-
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](#
|
|
164
|
+
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.
|
|
165
165
|
|
|
166
166
|
<!-- docs: demo live name:d2l-filter-dimension-set align:start autoOpen:true autoSize:false size:large -->
|
|
167
167
|
```html
|
|
@@ -198,8 +198,24 @@ The `d2l-filter-dimension-set` component is the main dimension type that will wo
|
|
|
198
198
|
<!-- docs: end hidden content -->
|
|
199
199
|
|
|
200
200
|
## Filter Dimension: Set Value [d2l-filter-dimension-set-value]
|
|
201
|
-
This component is built to be used alongside the [d2l-filter-dimension-set](#filter-dimension%3A-set-%5Bd2l-filter-dimension-set%5D) component, this will give you a selectable list of filter values.
|
|
202
201
|
|
|
202
|
+
This component is built to be used alongside the [d2l-filter-dimension-set](#d2l-filter-dimension-set) component, this will give you a selectable list of filter values.
|
|
203
|
+
|
|
204
|
+
<!-- docs: demo live name:d2l-filter-dimension-set-value align:start autoOpen:true autoSize:false size:large -->
|
|
205
|
+
```html
|
|
206
|
+
<script type="module">
|
|
207
|
+
import '@brightspace-ui/core/components/filter/filter.js';
|
|
208
|
+
import '@brightspace-ui/core/components/filter/filter-dimension-set.js';
|
|
209
|
+
import '@brightspace-ui/core/components/filter/filter-dimension-set-value.js';
|
|
210
|
+
</script>
|
|
211
|
+
<d2l-filter>
|
|
212
|
+
<d2l-filter-dimension-set key="course" text="Course" >
|
|
213
|
+
<d2l-filter-dimension-set-value key="art" text="Art" selected></d2l-filter-dimension-set-value>
|
|
214
|
+
<d2l-filter-dimension-set-value key="biology" text="Biology"></d2l-filter-dimension-set-value>
|
|
215
|
+
</d2l-filter-dimension-set>
|
|
216
|
+
</d2l-filter>
|
|
217
|
+
```
|
|
218
|
+
<!-- docs: start hidden content -->
|
|
203
219
|
### Properties
|
|
204
220
|
|
|
205
221
|
| Property | Type | Description |
|
|
@@ -208,6 +224,7 @@ This component is built to be used alongside the [d2l-filter-dimension-set](#fil
|
|
|
208
224
|
| `key` | String, required | Unique identifier within a dimension for the value |
|
|
209
225
|
| `text` | String, required | Text for the value in the list |
|
|
210
226
|
| `selected` | Boolean, default: `false` | Whether the value in the filter is selected or not |
|
|
227
|
+
<!-- docs: end hidden content -->
|
|
211
228
|
|
|
212
229
|
## Tags for Applied Filters [d2l-filter-tags]
|
|
213
230
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brightspace-ui/core",
|
|
3
|
-
"version": "2.29.
|
|
3
|
+
"version": "2.29.3",
|
|
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",
|