@brightspace-ui/core 3.66.2 → 3.68.0

package/components/button/button-toggle.js

@@ -2,6 +2,7 @@ import { css, html, LitElement } from 'lit';
 
 /**
  * A button container component for button toggles.
+ * @fires d2l-button-toggle-before-change - Dispatched before pressed state is updated. Can be canceled to allow the consumer to handle toggling pressed state. This is useful if something needs to happen prior to the pressed state being toggled.
  */
 class ButtonToggle extends LitElement {
 
@@ -79,9 +80,16 @@ class ButtonToggle extends LitElement {
 	}
 
 	async _handleClick(pressed) {
-		this.pressed = pressed;
-		await this.updateComplete;
-		this.focus();
+		const beforeToggleEvent = new CustomEvent('d2l-button-toggle-before-change', {
+			detail: {
+				update: (newPressed) => this._updatePressedState(newPressed)
+			},
+			cancelable: true
+		});
+		this.dispatchEvent(beforeToggleEvent);
+		if (beforeToggleEvent.defaultPrevented) return;
+
+		this._updatePressedState(pressed);
 	}
 
 	_handleNotPressedClick() {
@@ -92,6 +100,12 @@ class ButtonToggle extends LitElement {
 		this._handleClick(false);
 	}
 
+	async _updatePressedState(newPressed) {
+		this.pressed = newPressed;
+		await this.updateComplete;
+		this.focus();
+	}
+
 }
 
 customElements.define('d2l-button-toggle', ButtonToggle);

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

@@ -54,6 +54,26 @@
 				</template>
 			</d2l-demo-snippet>
 
+			<h2>Toggle Button (with consumer specifying when to toggle)</h2>
+
+			<d2l-demo-snippet>
+				<template>
+					<d2l-button-toggle id="toggle-button-icon-promise-delay">
+						<d2l-button-icon slot="not-pressed" icon="tier1:pin-hollow" text="Unpinned, click to pin."></d2l-button-icon>
+						<d2l-button-icon slot="pressed" icon="tier1:pin-filled" text="Pinned, click to unpin."></d2l-button-icon>
+					</d2l-button-toggle>
+					<script>
+						document.querySelector('#toggle-button-icon-promise-delay').addEventListener('d2l-button-toggle-before-change', e => {
+							e.preventDefault();
+							setTimeout(() => {
+								e.detail.update(!e.target.pressed);
+							}, 2000);
+						});
+						document.querySelector('#toggle-button-icon-promise-delay').addEventListener('d2l-button-toggle-change', e => console.log(e));
+					</script>
+				</template>
+			</d2l-demo-snippet>
+
 		</d2l-demo-page>
 
 	</body>

package/components/more-less/README.md

@@ -26,3 +26,7 @@ The `d2l-more-less` element can be used to minimize the display of long content,
 | `height` | String, default: `'4em'` | Maximum height of the content when in "less" mode. The `d2l-more-less` element itself will take up additional vertical space for the fading effect as well as the more/less button itself. |
 | `inactive` | Boolean | Whether the component is active or inactive |
 <!-- docs: end hidden content -->
+
+## Accessibility
+
+The implementation of the `d2l-more-less` component follows the [W3C Disclosure (Show/Hide) Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/disclosure/). It is worth noting that the content that is visually hidden is not actually hidden from screen reader users since those users can interrupt the screen reader if they do not want to continue listening to the content.

package/custom-elements.json

@@ -739,6 +739,10 @@
         }
       ],
       "events": [
+        {
+          "name": "d2l-button-toggle-before-change",
+          "description": "Dispatched before pressed state is updated. Can be canceled to allow the consumer to handle toggling pressed state. This is useful if something needs to happen prior to the pressed state being toggled."
+        },
         {
           "name": "d2l-button-toggle-change",
           "description": "Dispatched when the pressed state changes"

package/package.json

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