@brightspace-ui/core 2.41.0 → 2.42.0

package/components/filter/README.md

@@ -254,7 +254,7 @@ A tag-list allowing the user to see (and remove) the currently applied filters.
         display: block;
         max-width: 100%;
       }
-	}
+  }
 </style>
 <div class="filter-wrapper">
   <d2l-filter-tags filter-ids="core-filter core-filter-2"></d2l-filter-tags>
@@ -300,7 +300,78 @@ A tag-list allowing the user to see (and remove) the currently applied filters.
 
 ## Filter Overflow Group [d2l-filter-overflow-group]
 
-**Coming Soon!**
+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.
+
+<!-- docs: demo live name:d2l-filter-overflow-group align:start display:block autoSize:false size:medium -->
+```html
+<script type="module">
+  import '@brightspace-ui/core/components/filter/filter.js';
+  import '@brightspace-ui/core/components/filter/filter-dimension-set.js';
+  import '@brightspace-ui/core/components/filter/filter-dimension-set-value.js';
+  import '@brightspace-ui/core/components/filter/filter-overflow-group.js';
+</script>
+<d2l-filter-overflow-group>
+  <d2l-filter>
+    <d2l-filter-dimension-set key="skill" text="Skill">
+      <d2l-filter-dimension-set-value key="communication" text="Fall"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="leadership" text="Winter"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="management" text="Spring"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="planning" text="Summer"></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+  </d2l-filter>
+  <d2l-filter>
+    <d2l-filter-dimension-set key="type" text="Type" selection-single>
+      <d2l-filter-dimension-set-value key="certificate" text="Certificate"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="degree" text="Degree"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="diploma" text="Diploma"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="course" text="Course"></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+  </d2l-filter>
+  <d2l-filter>
+    <d2l-filter-dimension-set key="course" text="Course" select-all>
+      <d2l-filter-dimension-set-value key="art" text="Art"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="astronomy" text="Astronomy" selected></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="biology" text="Biology"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="chemistry" text="Chemistry"></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+    <d2l-filter-dimension-set key="duration" text="Duration">
+      <d2l-filter-dimension-set-value key="lessthanthree" text="< 3 months"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="threetosix" text="3-6 months"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="sixtotwelve" text="6-12 months"></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+  </d2l-filter>
+  <d2l-filter>
+    <d2l-filter-dimension-set key="provider" text="Semester3">
+      <d2l-filter-dimension-set-value key="mcmaster" text="McMaster"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="powered" text="PowerED"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="guelph" text="University of Guelph"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="manitoba" text="University of Manitoba"></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+  </d2l-filter>
+  <d2l-filter>
+    <d2l-filter-dimension-set key="format" text="Format">
+      <d2l-filter-dimension-set-value key="selfpaced" text="Self-Paced"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="instructor" text="Instructor Lead" selected></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+  </d2l-filter>
+  <d2l-filter>
+    <d2l-filter-dimension-set key="language" text="Language" selection-single>
+      <d2l-filter-dimension-set-value key="english" text="English"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="french" text="French"></d2l-filter-dimension-set-value>
+      <d2l-filter-dimension-set-value key="spanish" text="Spanish"></d2l-filter-dimension-set-value>
+    </d2l-filter-dimension-set>
+  </d2l-filter>
+</d2l-filter-overflow-group>
+```
+
+<!-- docs: start hidden content -->
+### Properties
+
+| Property | Type | Description |
+|---|---|---|
+| `min-to-show` | Number | The minimum number of elements to always show. Please consult the design team when using this attribute. |
+| `max-to-show` | Number | The maximum number of elements to show |
+<!-- docs: end hidden content -->
 
 ## Filter Dimension: Date [d2l-filter-dimension-date]
 

package/components/filter/filter-overflow-group.js

@@ -1,26 +1,63 @@
-import { css, LitElement } from 'lit';
-import { OverflowGroupMixin } from '../overflow-group/overflow-group-mixin.js';
+import './filter.js';
+import { css, html, LitElement } from 'lit';
+import { OVERFLOW_CLASS, OverflowGroupMixin } from '../overflow-group/overflow-group-mixin.js';
+import { RtlMixin } from '../../mixins/rtl-mixin.js';
+
+function createFilterItem(node) {
+	const dimensionSets = node.querySelectorAll('d2l-filter-dimension-set');
+	const clones = Array.from(dimensionSets).map((set) => set.cloneNode(true));
+	return clones;
+}
 
 /**
  * A component that can be used to display a group of filters that will be put into an overflow filter when they no longer fit on the first line of their container
  * @slot - d2l-filters to be added to the container
 */
-class FilterOverflowGroup extends OverflowGroupMixin(LitElement) {
+class FilterOverflowGroup extends OverflowGroupMixin(RtlMixin(LitElement)) {
 
 	static get styles() {
 		return [super.styles, css`
 			::slotted(d2l-filter) {
 				margin-right: 0.3rem;
 			}
+			:host([dir="rtl"]) ::slotted(d2l-filter) {
+				margin-left: 0.3rem;
+				margin-right: 0;
+			}
 		`];
 	}
 
+	firstUpdated(changedProperties) {
+		super.firstUpdated(changedProperties);
+
+		this.addEventListener('d2l-filter-change', this._handleFilterChange);
+	}
+
 	convertToOverflowItem(node) {
 		const tagName = node.tagName.toLowerCase();
 		if (tagName !== 'd2l-filter') console.warn(`d2l-filter-overflow-group: ${tagName} is invalid in this group. This group should only contain d2l-filter direct child elements.`);
+		else return createFilterItem(node);
+	}
+
+	getOverflowContainer(overflowItems) {
+		return html`
+			<d2l-filter class="${OVERFLOW_CLASS}" @d2l-filter-change="${this._handleFilterChange}">
+				${overflowItems}
+			</d2l-filter>
+		`;
 	}
 
-	getOverflowContainer() {
+	_handleFilterChange(e) {
+		const target = (e.target.classList && e.target.classList.contains(OVERFLOW_CLASS)) ? this : e.target;
+		e.detail.dimensions.forEach((dimension) => {
+			const filterSet = target.querySelector(`d2l-filter-dimension-set[key=${dimension.dimensionKey}`);
+			if (!filterSet) return;
+			dimension.changes.forEach((change) => {
+				const filterSetValue = filterSet.querySelector(`d2l-filter-dimension-set-value[key=${change.valueKey}]`);
+				if (!filterSetValue) return;
+				filterSetValue.selected = change.selected;
+			});
+		});
 	}
 
 }

package/components/overflow-group/overflow-group-mixin.js

@@ -2,6 +2,7 @@ import { css, html, nothing } from 'lit';
 import { LocalizeCoreElement } from '../../helpers/localize-core-element.js';
 import { offscreenStyles } from '../offscreen/offscreen.js';
 import ResizeObserver from 'resize-observer-polyfill/dist/ResizeObserver.es.js';
+import { styleMap } from 'lit/directives/style-map.js';
 
 export const OVERFLOW_CLASS = 'd2l-overflow-container';
 export const OVERFLOW_MINI_CLASS = 'd2l-overflow-container-mini';
@@ -28,8 +29,7 @@ export const OverflowGroupMixin = superclass => class extends LocalizeCoreElemen
 	static get properties() {
 		return {
 			/**
-			 * Use predefined classes on slot elements to set min and max slotted items to show
-			 * @type {boolean}
+			 * @ignore
 			 */
 			autoShow: {
 				type: Boolean,
@@ -95,7 +95,9 @@ export const OverflowGroupMixin = superclass => class extends LocalizeCoreElemen
 		this._handleResize = this._handleResize.bind(this);
 		this._resizeObserver = new ResizeObserver((entries) => requestAnimationFrame(() => this._handleResize(entries)));
 
+		this._hasResized = false;
 		this._isObserving = false;
+		this._itemHeight = 0;
 		this._mini = this.openerType === OPENER_TYPE.ICON;
 		this._overflowContainerHidden = false;
 		this._slotItems = [];
@@ -129,8 +131,13 @@ export const OverflowGroupMixin = superclass => class extends LocalizeCoreElemen
 			}
 		});
 
+		const containerStyles = {
+			minHeight: this.autoShow ? 'none' : `${this._itemHeight}px`,
+			maxHeight: this.autoShow ? 'none' : `${this._itemHeight}px`
+		};
+
 		return html`
-			<div class="d2l-overflow-group-container">
+			<div class="d2l-overflow-group-container" style="${styleMap(containerStyles)}">
 				<slot @slotchange="${this._handleSlotChange}"></slot>
 				${overflowContainer}
 			</div>
@@ -277,12 +284,15 @@ export const OverflowGroupMixin = superclass => class extends LocalizeCoreElemen
 
 	_getItemLayouts(filteredNodes) {
 		const items = filteredNodes.map((node) => {
+			node.removeAttribute('data-is-chomped');
 			const computedStyles = window.getComputedStyle(node);
+			const itemHidden = computedStyles.display === 'none';
+			this._itemHeight = !itemHidden ? Math.max(this._itemHeight, Math.ceil(parseFloat(computedStyles.height))) : this._itemHeight;
 
 			return {
 				type: node.tagName.toLowerCase(),
 				isChomped: false,
-				isHidden: computedStyles.display === 'none',
+				isHidden: itemHidden,
 				width: Math.ceil(parseFloat(computedStyles.width) || 0)
 					+ parseInt(computedStyles.marginRight) || 0
 					+ parseInt(computedStyles.marginLeft) || 0,
@@ -316,20 +326,44 @@ export const OverflowGroupMixin = superclass => class extends LocalizeCoreElemen
 		if (!mutations || mutations.length === 0) return;
 		if (this._updateOverflowItemsRequested) return;
 
+		let isWidthModifyingMutation = false;
+		for (const mutation of mutations) {
+			if (mutation.attributeName
+				&& (mutation.attributeName === 'selected' || mutation.attributeName === 'text')
+			) {
+				isWidthModifyingMutation = true;
+				break;
+			}
+		}
+
 		this._updateOverflowItemsRequested = true;
 		setTimeout(() => {
-			this._overflowItems = this._slotItems.map(node => this.convertToOverflowItem(node));
+			this._overflowItems = this._slotItems.map((node) => this.convertToOverflowItem(node));
+
+			// when certain attributes change the corresponding item width can also change and so we need to re-get the layouts and chomp
+			if (isWidthModifyingMutation) {
+				this._itemLayouts = this._getItemLayouts(this._slotItems);
+				this._chomp();
+			}
 			this._updateOverflowItemsRequested = false;
 			this.requestUpdate();
 		}, 0);
 	}
 
-	_handleResize(entries) {
+	async _handleResize(entries) {
+		await (document.fonts ? document.fonts.ready : Promise.resolve()); // computed widths can be incorrect if we don't wait for fonts to load
 		this._availableWidth = Math.ceil(entries[0].contentRect.width);
-		this._chomp();
+
+		if (!this._hasResized) {
+			this._hasResized = true;
+			await this._handleSlotChange();
+		} else {
+			this._chomp();
+		}
 	}
 
 	_handleSlotChange() {
+		if (!this._hasResized) return;
 		requestAnimationFrame(async() => {
 			await this._getItems();
 

package/components/overflow-group/overflow-group.js

@@ -56,6 +56,7 @@ function createMenuItemSeparator() {
  * A component that can be used to display a set of buttons, links or menus that will be put into a dropdown menu when they no longer fit on the first line of their container
  * @slot - Buttons, dropdown buttons, links or other items to be added to the container
  * @attr {'default'|'icon'} [opener-type="default"] - Set the opener type to 'icon' for a `...` menu icon instead of `More actions` text
+ * @attr {boolean} auto-show - Use predefined classes on slot elements to set min and max buttons to show
 */
 class OverflowGroup extends OverflowGroupMixin(RtlMixin(LitElement)) {
 

package/custom-elements.json

@@ -3364,12 +3364,6 @@
       "path": "./components/filter/filter-overflow-group.js",
       "description": "A component that can be used to display a group of filters that will be put into an overflow filter when they no longer fit on the first line of their container",
       "attributes": [
-        {
-          "name": "auto-show",
-          "description": "Use predefined classes on slot elements to set min and max slotted items to show",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "max-to-show",
           "description": "maximum amount of slotted items to show",
@@ -3386,8 +3380,6 @@
       "properties": [
         {
           "name": "autoShow",
-          "attribute": "auto-show",
-          "description": "Use predefined classes on slot elements to set min and max slotted items to show",
           "type": "boolean",
           "default": "false"
         },
@@ -8831,12 +8823,6 @@
           "type": "'default'|'subtle'",
           "default": "\"\\\"default\\\"\""
         },
-        {
-          "name": "auto-show",
-          "description": "Use predefined classes on slot elements to set min and max slotted items to show",
-          "type": "boolean",
-          "default": "false"
-        },
         {
           "name": "max-to-show",
           "description": "maximum amount of slotted items to show",
@@ -8854,6 +8840,11 @@
           "description": "Set the opener type to 'icon' for a `...` menu icon instead of `More actions` text",
           "type": "'default'|'icon'",
           "default": "\"default\""
+        },
+        {
+          "name": "auto-show",
+          "description": "Use predefined classes on slot elements to set min and max buttons to show",
+          "type": "boolean"
         }
       ],
       "properties": [
@@ -8866,8 +8857,6 @@
         },
         {
           "name": "autoShow",
-          "attribute": "auto-show",
-          "description": "Use predefined classes on slot elements to set min and max slotted items to show",
           "type": "boolean",
           "default": "false"
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brightspace-ui/core",
-  "version": "2.41.0",
+  "version": "2.42.0",
   "description": "A collection of accessible, free, open-source web components for building Brightspace applications",
   "type": "module",
   "repository": "https://github.com/BrightspaceUI/core.git",