@brightspace-ui/core 1.197.2 → 1.199.0

package/components/dropdown/README.md

@@ -117,6 +117,7 @@ If the dropdown is initially empty when it's opened, the dropdown pointer will n
 | `disabled` | Boolean, default: `false` | Disables the dropdown opener |
 | `no-auto-open` | Boolean, default: `false` | Prevents the dropdown from opening automatically on click or on key press |
 | `primary` | Boolean, default: `false` | Optionally render button as primary button |
+| `open-on-hover` | Boolean, default: `false` | Optionally open dropdown on click or hover action |
 <!-- docs: end hidden content -->
 
 ## Opener: Button Subtle [d2l-dropdown-button-subtle]
@@ -160,6 +161,7 @@ If the dropdown is initially empty when it's opened, the dropdown pointer will n
 | `description` | String | A description to be added to the inner `button` opener for accessibility |
 | `disabled` | Boolean, default: `false` | Disables the dropdown opener |
 | `no-auto-open` | Boolean, default: `false` | Prevents the dropdown from automatically on click or on key press |
+| `open-on-hover` | Boolean, default: `false` | Optionally open dropdown on click or hover action |
 <!-- docs: end hidden content -->
 
 ### Accessibility Properties
@@ -209,6 +211,7 @@ To make your `d2l-dropdown-button-subtle` accessible, use the following properti
 |---|---|---|
 | `disabled` | Boolean, default: `false` | Disables the dropdown opener |
 | `no-auto-open` | Boolean, default: `false` | Prevents the dropdown from opening automatically on click or on key press |
+| `open-on-hover` | Boolean, default: `false` | Optionally open dropdown on click or hover action |
 | `text` | String | Used as `aria-label` for the button |
 | `translucent` | Boolean, default: `false` | Attribute for busy/rich backgrounds |
 | `visible-on-ancestor` | Boolean, default: `false` | See [visible-on-ancestor-mixin](../../mixins/visible-on-ancestor-mixin.md) for more details on configuring that behavior |
@@ -261,6 +264,7 @@ To make your usage of `d2l-dropdown-context-menu` accessible, use the following
 |---|---|---|
 | `disabled` | Boolean, default: `false` | Disables the dropdown opener |
 | `no-auto-open` | Boolean, default: `false` | Prevents the dropdown from opening automatically on click or key press |
+| `open-on-hover` | Boolean, default: `false` | Optionally open dropdown on click or hover action |
 | `text` | String | Used as `aria-label` for the button |
 | `translucent` | Boolean, default: `false` | Attribute for busy/rich backgrounds |
 | `visible-on-ancestor` | Boolean, default: `false` | See [visible-on-ancestor-mixin](../../mixins/visible-on-ancestor-mixin.md) for more details on configuring that behavior |

package/components/dropdown/demo/dropdown-button.html

@@ -65,6 +65,36 @@
 			</template>
 		</d2l-demo-snippet>
 
+		<h2>Dropdown Button Opener (open-on-hover Option)</h2>
+		<d2l-demo-snippet>
+			<template>
+				<d2l-dropdown-button text="Open!" open-on-hover>
+					<d2l-dropdown-content mobile-tray="right">
+						<div slot="header">
+							<h3>Scrolling is Fun</h3>
+						</div>
+						<a href="https://youtu.be/9ze87zQFSak">Google</a>
+						<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+							magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+							commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat
+							nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit
+							anim id est laborum.Vestibulum vel sem non orci pretium fringilla sed eget augue. Vestibulum malesuada tortor
+							vitae odio elementum eleifend. Quisque ligula quam, ornare id malesuada ut, malesuada eleifend sem. Nulla porta
+							in arcu quis gravida. Duis ac sagittis felis, in condimentum libero. In dolor risus, semper vel iaculis vitae,
+							pellentesque efficitur lorem. Nunc a lacus malesuada, rhoncus risus aliquam, sodales nulla. Sed in varius elit.
+							Duis sagittis, turpis ut vehicula elementum, velit mi tincidunt turpis, sit amet sagittis quam urna ut justo.
+							Nunc interdum urna augue, ac pretium dui pulvinar eu. Proin vehicula placerat est, sed venenatis purus viverra
+							eget. Suspendisse imperdiet nulla eget velit sodales, sit amet tempus metus dignissim. Sed ac luctus leo, a
+							ornare nisl. Proin non sapien eu orci gravida aliquam. Praesent placerat auctor lacus sit amet faucibus.
+							Suspendisse sit amet dui sed turpis vestibulum dignissim.</p>
+						<div slot="footer">
+							<a href="http://www.desire2learn.com">D2L</a>
+						</div>
+					</d2l-dropdown-content>
+				</d2l-dropdown-button>
+			</template>
+		</d2l-demo-snippet>
+
 	</d2l-demo-page>
 
 </body>

package/components/dropdown/dropdown-content-styles.js

@@ -172,6 +172,19 @@ export const dropdownContentStyles = css`
 		text-align: right;
 	}
 
+	:host(.d2l-dropdown-content-fading) {
+		opacity: 0;
+		/* matches DropdownOpenerMixin _closeTimerStart function */
+		transition: opacity 0.4s ease-out 0.3s;
+	}
+
+	@media (prefers-reduced-motion: reduce) {
+		:host(.d2l-dropdown-content-fading) {
+			opacity: 1;
+			transition: none;
+		}
+	}
+
 	@media (prefers-reduced-motion: reduce) {
 		:host([opened]), :host([opened-above]) {
 			animation: none !important;

package/components/dropdown/dropdown-opener-mixin.js

@@ -1,3 +1,6 @@
+import { getUniqueId } from '../../helpers/uniqueId.js';
+import { isComposedAncestor } from '../../helpers/dom.js';
+
 export const DropdownOpenerMixin = superclass => class extends superclass {
 
 	static get properties() {
@@ -27,6 +30,19 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 				reflect: true,
 				attribute: 'no-auto-open'
 			},
+
+			/**
+			 * Optionally open dropdown on click or hover action
+			 * @type {boolean}
+			 */
+			openOnHover: {
+				type: Boolean,
+				attribute: 'open-on-hover'
+			},
+			_isHovering: { type: Boolean },
+			_isOpen: { type: Boolean },
+			_isOpenedViaClick: { type: Boolean },
+			_isFading: { type: Boolean }
 		};
 	}
 
@@ -34,36 +50,46 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 		super();
 		this.dropdownOpener = true;
 		this.noAutoOpen = false;
+		this.openOnHover = false;
 		this.disabled = false;
 
-		this.__onKeyPress = this.__onKeyPress.bind(this);
-		this.__onMouseUp = this.__onMouseUp.bind(this);
+		// hover option
+		this._dismissTimerId = getUniqueId();
+		this._isOpen = false;
+		this._isOpenedViaClick = false;
+		this._isHovering = false;
+		this._isFading = false;
+
+		this._onOutsideClick = this._onOutsideClick.bind(this);
+		this._contentRendered = null;
+		this._openerRendered = null;
 	}
 
 	connectedCallback() {
 		super.connectedCallback();
 
-		requestAnimationFrame(() => {
-			const opener = this.getOpenerElement();
-			const content = this.__getContentElement();
-			if (!opener) {
-				return;
-			}
-			opener.setAttribute('aria-haspopup', 'true');
-			opener.addEventListener('keypress', this.__onKeyPress);
-			opener.addEventListener('mouseup', this.__onMouseUp);
-			opener.setAttribute('aria-expanded', (content && content.opened || false).toString());
-		});
+		// listeners
+		this.addEventListener('keypress', this.__onKeypress);
+		this.addEventListener('mouseup', this.__onMouseUp);
+		this.addEventListener('mouseenter', this.__onMouseEnter);
+		this.addEventListener('mouseleave', this.__onMouseLeave);
+
+		if (this.openOnHover) {
+			document.body.addEventListener('mouseup', this._onOutsideClick);
+		}
 	}
 
 	disconnectedCallback() {
 		super.disconnectedCallback();
-		const opener = this.getOpenerElement();
-		if (!opener) {
-			return;
+
+		this.removeEventListener('keypress', this.__onKeypress);
+		this.removeEventListener('mouseup', this.__onMouseUp);
+		this.removeEventListener('mouseenter', this.__onMouseEnter);
+		this.removeEventListener('mouseleave', this.__onMouseLeave);
+
+		if (this.openOnHover) {
+			document.body.removeEventListener('mouseup', this._onOutsideClick);
 		}
-		opener.removeEventListener('keypress', this.__onKeyPress);
-		opener.removeEventListener('mouseup', this.__onMouseUp);
 	}
 
 	firstUpdated(changedProperties) {
@@ -71,6 +97,38 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 
 		this.addEventListener('d2l-dropdown-open', this.__onOpened);
 		this.addEventListener('d2l-dropdown-close', this.__onClosed);
+
+		const opener = this.getOpenerElement();
+		const content = this.__getContentElement();
+		if (!opener) {
+			return;
+		}
+		opener.setAttribute('aria-haspopup', 'true');
+		opener.setAttribute('aria-expanded', (content && content.opened || false).toString());
+	}
+
+	updated(changedProperties) {
+		super.updated(changedProperties);
+		if (!this.openOnHover || !changedProperties.has('_isFading')) return;
+
+		if (this._isFading) {
+			this.__getContentElement()?.classList.add('d2l-dropdown-content-fading');
+		} else {
+			this.__getContentElement()?.classList.remove('d2l-dropdown-content-fading');
+		}
+	}
+
+	/* used by open-on-hover option */
+	async closeDropdown(fadeOut) {
+		this._isOpen = false;
+		this._isHovering = false;
+		this._isOpenedViaClick = false;
+		if (fadeOut) {
+			this._closeTimerStart();
+			return;
+		}
+		const dropdownContent = this.__getContentElement();
+		await dropdownContent.close();
 	}
 
 	focus() {
@@ -89,6 +147,15 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 		return this;
 	}
 
+	/* used by open-on-hover option */
+	async openDropdown(applyFocus) {
+		this._isOpen = true;
+		const dropdownContent = this.__getContentElement();
+		if (!dropdownContent) return;
+		await dropdownContent.open(applyFocus);
+		await dropdownContent.updateComplete;
+	}
+
 	toggleOpen(applyFocus) {
 		if (this.disabled) {
 			return;
@@ -99,6 +166,7 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 			return;
 		}
 		content.toggleOpen(applyFocus);
+		this._isOpen = !this._isOpen;
 	}
 
 	__getContentElement() {
@@ -113,17 +181,62 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 		}
 		opener.setAttribute('aria-expanded', 'false');
 		opener.removeAttribute('active');
+		this._isOpen = false;
+		this._isOpenedViaClick = false;
 	}
 
-	__onKeyPress(e) {
-		if (e.keyCode !== 13 && e.keyCode !== 32) return;
-		if (this.noAutoOpen) return;
-		this.toggleOpen(true);
+	__onDropdownMouseUp() {
+		this._isOpen = true;
+		this._isFading = false;
+		this._isHovering = false;
+		this._isOpenedViaClick = true;
+		this._closeTimerStop();
 	}
 
-	__onMouseUp() {
-		if (this.noAutoOpen) return;
-		this.toggleOpen(false);
+	__onKeypress(e) {
+		if (e.srcElement === this || isComposedAncestor(this.getOpenerElement(), e.srcElement)) {
+			if (e.keyCode !== 13 && e.keyCode !== 32) return;
+			if (this.noAutoOpen) return;
+			if (!this.openOnHover) {
+				this.toggleOpen(true);
+			} else {
+				this._closeTimerStop();
+				e.preventDefault();
+				this._isOpenedViaClick = true;
+				this.openDropdown(true);
+			}
+		}
+	}
+
+	async __onMouseEnter() {
+		if (!this.openOnHover) return;
+		// do not respond to hover events on mobile screens
+		const dropdownContent = this.__getContentElement();
+		if (dropdownContent._useMobileStyling) return;
+		clearTimeout(this._dismissTimerId);
+		if (!this._isOpen) await this.openDropdown(false);
+		this._closeTimerStop();
+		if (!this._isOpenedViaClick) this._isHovering = true;
+	}
+
+	async __onMouseLeave() {
+		if (!this.openOnHover) return;
+		// do not respond to hover events on mobile screens
+		const dropdownContent = this.__getContentElement();
+		if (dropdownContent._useMobileStyling) return;
+		this._isHovering = false;
+		if (this._isOpenedViaClick) return;
+		//Wait before closing so we don't lose hover when we jump from opener to card
+		clearTimeout(this._dismissTimerId);
+		await this.closeDropdown(true);
+	}
+
+	__onMouseUp(e) {
+		if (e.srcElement === this || isComposedAncestor(this.getOpenerElement(), e.srcElement)) {
+			this.__onOpenerMouseUp(e);
+		} else if (this.openOnHover && isComposedAncestor(this.__getContentElement(), e.srcElement)) {
+			this.__onDropdownMouseUp();
+		}
 	}
 
 	__onOpened() {
@@ -133,6 +246,53 @@ export const DropdownOpenerMixin = superclass => class extends superclass {
 		}
 		opener.setAttribute('aria-expanded', 'true');
 		opener.setAttribute('active', 'true');
+		this._isFading = false;
+	}
+
+	__onOpenerMouseUp(e) {
+		if (this.noAutoOpen) return;
+		if (this.openOnHover) {
+			// prevent propogation to window and triggering _onOutsideClick
+			e?.stopPropagation();
+			this._closeTimerStop();
+			if (this._isOpen && !this._isHovering) {
+				this.closeDropdown();
+			} else {
+				this._isOpenedViaClick = true;
+				this._isHovering = false;
+				this.openDropdown(true);
+			}
+		} else this.toggleOpen(false);
 	}
 
+	/* used by open-on-hover option */
+	_closeTimerStart() {
+		if (this._isOpen) return;
+		clearTimeout(this._setTimeoutId);
+		this._isFading = true;
+		this._setTimeoutId = setTimeout(() => {
+			this.closeDropdown(false);
+			this._isFading = false;
+		// matches dropdownContentStyles CSS
+		}, 700);
+	}
+
+	/* used by open-on-hover option */
+	_closeTimerStop() {
+		clearTimeout(this._setTimeoutId);
+		this._isFading = false;
+	}
+
+	/* used by open-on-hover option */
+	_onOutsideClick(e) {
+		if (!this._isOpen) return;
+		const isWithinDropdown = isComposedAncestor(this.__getContentElement(), e.composedPath()[0]);
+		const isWithinOpener = isComposedAncestor(this.getOpenerElement(), e.composedPath()[0]);
+		const isBackdropClick = isWithinDropdown
+			&& this.__getContentElement()._useMobileStyling
+			&& e.composedPath().find(node => node.nodeName === 'D2L-BACKDROP');
+		if (!isWithinOpener && (!isWithinDropdown || isBackdropClick)) {
+			this.closeDropdown();
+		}
+	}
 };

package/components/filter/README.md

@@ -1,9 +1,12 @@
 # Filtering
 
-**NOTE: This component is a work-in-progress and not ready for consumer use yet.**
-
 Filter components are often used in conjuction with [tables](../../components/table) and allow users to select a subset of the presented data based on a set of parameters. Filter dimensions provide methods for entering parameters for a wide range of data types.
 
+<!-- docs: start hidden content -->
+Filter with multiple dimensions:
+![Filter with multiple dimensions](./screenshots/filter-multi-dim.png?raw=true)
+<!-- docs: end hidden content -->
+
 <!-- docs: demo align:start autoSize:false size:large -->
 ```html
 <script type="module">
@@ -47,10 +50,6 @@ Filter components are often used in conjuction with [tables](../../components/ta
 
 The `d2l-filter` component allows a user to filter on one or more dimensions of data from a single dropdown.
 
-<!-- docs: start hidden content -->
-<!-- ![Filter](./screenshots/filter.png?raw=true) -->
-<!-- docs: end hidden content -->
-
 <!-- docs: demo live name:d2l-filter autoSize:false align:start size:large -->
 ```html
 <script type="module">
@@ -96,6 +95,11 @@ The `d2l-filter` component allows a user to filter on one or more dimensions of
 ### Single Vs Multi Dimensional
 A filter can be a single dimension (like picking from a list of courses) or offer multiple dimensions (filter by role, or department, or something else). Single-dimension filters can be used side-by-side to promote filters that are more commonly used, while tucking less-used filters into a multi-dimensional filter.
 
+<!-- docs: start hidden content -->
+Filter with a single dimension:
+![Filters with single dimension](./screenshots/filter.png?raw=true)
+<!-- docs: end hidden content -->
+
 <!-- docs: demo code autoSize:false align:start size:large -->
 ```html
 <script type="module">
@@ -173,6 +177,11 @@ The filter will announce changes to filter selections, search results, and when
 
 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](#filter-dimension%3A-set-value-%5Bd2l-filter-dimension-set-value%5D), this will give you a selectable list of filter values.
 
+<!-- docs: start hidden content -->
+Set dimension on mobile:
+![Set dimension on mobile](./screenshots/filter-mobile.png?raw=true)
+<!-- docs: end hidden content -->
+
 <!-- docs: demo live name:d2l-filter-dimension-set align:start autoSize:false size:large -->
 ```html
 <script type="module">

package/components/html-block/html-block.js

@@ -135,6 +135,14 @@ class HtmlBlock extends LitElement {
 		`];
 	}
 
+	connectedCallback() {
+		super.connectedCallback();
+		if (!this._templateObserver) return;
+
+		const template = this.querySelector('template');
+		if (template) this._templateObserver.observe(template.content, { attributes: true, childList: true, subtree: true });
+	}
+
 	disconnectedCallback() {
 		super.disconnectedCallback();
 		if (this._templateObserver) this._templateObserver.disconnect();

package/components/inputs/docs/input-date-time.md

@@ -14,7 +14,7 @@ size:xlarge
 </script>
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {
@@ -63,7 +63,7 @@ size:xlarge
 <!-- docs: start hidden content -->
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {
@@ -131,7 +131,7 @@ size:xlarge
 <!-- docs: start hidden content -->
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {
@@ -205,7 +205,7 @@ size:large
 <!-- docs: start hidden content -->
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {
@@ -273,7 +273,7 @@ size:large
 <!-- docs: start hidden content -->
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {
@@ -343,7 +343,7 @@ size:xlarge
 <!-- docs: start hidden content -->
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {
@@ -412,7 +412,7 @@ size:xlarge
 <!-- docs: start hidden content -->
 <script>
   window.addEventListener('load', function () {
-    const demoElem = document.querySelector('#demo-element');
+    var demoElem = document.querySelector('#demo-element');
     if (!demoElem.hasAttribute('data-first-load')) return;
 
     setTimeout(function() {

package/custom-elements.json

@@ -1686,6 +1686,12 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "description": "Disables the dropdown opener",
@@ -1718,6 +1724,13 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "openOnHover",
+          "attribute": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "attribute": "disabled",
@@ -1755,6 +1768,12 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "description": "Disables the dropdown opener",
@@ -1788,6 +1807,13 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "openOnHover",
+          "attribute": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "attribute": "disabled",
@@ -2087,6 +2113,12 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "description": "Disables the dropdown opener",
@@ -2120,6 +2152,13 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "openOnHover",
+          "attribute": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "attribute": "disabled",
@@ -2424,6 +2463,12 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "description": "Disables the dropdown opener",
@@ -2457,6 +2502,13 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "openOnHover",
+          "attribute": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "attribute": "disabled",
@@ -2750,6 +2802,12 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "description": "Disables the dropdown opener",
@@ -2770,6 +2828,13 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "openOnHover",
+          "attribute": "open-on-hover",
+          "description": "Optionally open dropdown on click or hover action",
+          "type": "boolean",
+          "default": "false"
+        },
         {
           "name": "disabled",
           "attribute": "disabled",

package/package.json

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