@brightspace-ui/core 2.42.1 → 2.43.2

package/components/switch/README.md

@@ -63,6 +63,8 @@ To make your usage of `d2l-switch` accessible, use the following property:
 
 The `d2l-switch-visibility` element is a variant of the generic switch configured with special icons and default text for toggling "visibility".
 
+It consists of 3 states: On ("Visible"), Off ("Hidden"), and On with Conditions ("Visible. Conditions must be met.").
+
 <!-- docs: demo live name:d2l-switch-visibility autoSize:false size:small -->
 ```html
 <script type="module">
@@ -76,12 +78,36 @@ The `d2l-switch-visibility` element is a variant of the generic switch configure
 
 | Property | Type | Description |
 |---|---|---|
-| `text`| String, required | Accessible text for the switch; defaults to "Visibility" |
 | `disabled` | Boolean | Disabled the switch |
-| `on` | Boolean | Whether the switch is "on" or "off" |
+| `on` | Boolean | Whether the switch is "on" or "off". If content is passed into the switch slot, the switch will be "on with conditions". |
 | `text-position` | String | Valid values are: `start`, `end` (default), and `hidden` |
 
 ### Events
 
 - `change`: dispatched when the `on` property is updated
+
+### Slots
+
+- Optional default slot content - Content that will be displayed within the "conditions" opener tooltip when the switch is on.
+  
 <!-- docs: end hidden content -->
+
+### Visibility Switch with Conditions
+It may be helpful to have visibility be dependent on additional conditions being met outside of the Visibility Switch.
+
+Additional information can be added to the label by passing it into the `d2l-switch-visibility` element.
+
+<!-- docs: demo code autoSize:false size:large -->
+```html
+<script type="module">
+  import '@brightspace-ui/core/components/switch/switch-visibility.js';
+</script>
+<d2l-switch-visibility on>
+  These are some conditions that must be met for the activity to be visible.
+  <ul>
+    <li> Condition 1 </li>
+    <li> Condition 2 </li>
+    <li> Condition 3 </li>
+  </ul>
+</d2l-switch-visibility>
+```

package/components/switch/demo/switch.html

@@ -53,6 +53,21 @@
 				</template>
 			</d2l-demo-snippet>
 
+			<h2>Visibility (with conditions)</h2>
+
+			<d2l-demo-snippet>
+				<template>
+					<d2l-switch-visibility>
+						These are some conditions that must be met for the activity to be visible.
+						<ul>
+							<li> Condition 1 </li>
+							<li> Condition 2 </li>
+							<li> Condition 3 </li>
+						</ul>
+					</d2l-switch-visibility>
+				</template>
+			</d2l-demo-snippet>
+
 		</d2l-demo-page>
 	</body>
 </html>

package/components/switch/switch-mixin.js

@@ -1,5 +1,6 @@
 import '../colors/colors.js';
 import { css, html } from 'lit';
+import { classMap } from 'lit/directives/class-map.js';
 import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { FocusVisiblePolyfillMixin } from '../../mixins/focus-visible-polyfill-mixin.js';
 import { getUniqueId } from '../../helpers/uniqueId.js';
@@ -21,8 +22,7 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 			 */
 			on: { type: Boolean, reflect: true },
 			/**
-			 * REQUIRED: The text that is displayed for the switch label.
-			 * @type {string}
+			 * @ignore - Need to add documentation in each component that uses this mixin.
 			 */
 			text: { type: String, reflect: true },
 			/**
@@ -30,7 +30,8 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 			 * @type {'start'|'end'|'hidden'}
 			 * @default end
 			 */
-			textPosition: { type: String, attribute: 'text-position', reflect: true }
+			textPosition: { type: String, attribute: 'text-position', reflect: true },
+			_hovering: { state: true }
 		};
 	}
 
@@ -49,7 +50,7 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 				border: 2px solid transparent;
 				border-radius: 1rem;
 				box-sizing: border-box;
-				cursor: pointer;
+				cursor: default;
 				display: inline-block;
 				font-size: 0;
 				line-height: 0;
@@ -60,10 +61,6 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 			.d2l-switch-container.focus-visible {
 				border-color: var(--d2l-color-celestine);
 			}
-			.d2l-switch-container:hover > .d2l-switch-inner {
-				border-color: var(--d2l-color-celestine);
-				box-shadow: 0 0 0 1px var(--d2l-color-celestine) inset;
-			}
 			:host([disabled]) .d2l-switch-container {
 				cursor: default;
 				opacity: 0.5;
@@ -147,9 +144,17 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 				transform: scale(0.35);
 			}
 			.d2l-switch-text {
+				cursor: default;
 				font-size: 0.8rem;
 				font-weight: 400;
 			}
+			:host([text-position="hidden"]) .d2l-switch-text {
+				display: none;
+			}
+			.d2l-switch-inner:hover, .switch-hover {
+				border-color: var(--d2l-color-celestine);
+				box-shadow: 0 0 0 1px var(--d2l-color-celestine) inset;
+			}
 			@media (prefers-reduced-motion: reduce) {
 				.d2l-switch-toggle,
 				.d2l-switch-icon-on,
@@ -167,6 +172,7 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 		this.on = false;
 		this.textPosition = 'end';
 		this._textId = getUniqueId();
+		this._hovering = false;
 	}
 
 	static get focusElementSelector() {
@@ -182,11 +188,17 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 
 	render() {
 		const tabindex = (!this.disabled ? '0' : undefined);
-		const text = html`<span id="${this._textId}" class="d2l-switch-text">${this.text}</span>`;
+		const innerSwitchClasses = {
+			'switch-hover': this._hovering,
+			'd2l-switch-inner': true
+		};
+		const switchLabel = html`<span id="${this._textId}" class="d2l-switch-text">${this._labelContent}</span>`;
 		const textPosition = (this.textPosition === 'start' || this.textPosition === 'hidden'
 			? this.textPosition : 'end');
+
+		// Note: we render the switchLabel in the case of textPosition === 'hidden' so that any slot handlers can pick up on content being passed in
 		return html`
-			${textPosition === 'start' ? text : ''}
+			${textPosition === 'start' ? switchLabel : ''}
 			<div
 				aria-checked="${this.on ? 'true' : 'false'}"
 				aria-label="${ifDefined(textPosition === 'hidden' ? this.text : undefined)}"
@@ -197,16 +209,25 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 				@keyup="${this._handleKeyUp}"
 				role="switch"
 				tabindex="${ifDefined(tabindex)}">
-				<div class="d2l-switch-inner">
+				<div class="${classMap(innerSwitchClasses)}">
 					<div class="d2l-switch-toggle"><div></div></div>
 					<div class="d2l-switch-icon-on">${this.onIcon}</div>
 					<div class="d2l-switch-icon-off">${this.offIcon}</div>
 				</div>
 			</div>
-			${textPosition === 'end' ? text : ''}
+			${textPosition === 'end' || textPosition === 'hidden' ? switchLabel : ''}
 		`;
 	}
 
+	get _labelContent() {
+		return html`<span 
+						@click='${this._handleClick}' 
+						@mouseenter='${this._handleSwitchHover}' 
+						@mouseleave='${this._handleSwitchHoverLeave}'>
+						${this.text}
+					</span>`;
+	}
+
 	_handleClick() {
 		this._toggleState();
 	}
@@ -221,6 +242,14 @@ export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(Focus
 		if (e.keyCode === 32) this._toggleState();
 	}
 
+	_handleSwitchHover() {
+		this._hovering = true;
+	}
+
+	_handleSwitchHoverLeave() {
+		this._hovering = false;
+	}
+
 	_toggleState() {
 		if (this.disabled) return;
 		this.on = !this.on;

package/components/switch/switch-visibility.js

@@ -1,19 +1,53 @@
 import '../icons/icon.js';
-import { html, LitElement } from 'lit';
+import '../tooltip/tooltip-help.js';
+import { css, html, LitElement } from 'lit';
+import { classMap } from 'lit/directives/class-map.js';
 import { LocalizeCoreElement } from '../../helpers/localize-core-element.js';
 import { SwitchMixin } from './switch-mixin.js';
 
 /**
  * A variant of the generic switch configured with special icons and default text for toggling "visibility".
+ * @slot - Optional content that will be displayed within the "conditions" opener tooltip when the switch is on.
  */
 class VisibilitySwitch extends LocalizeCoreElement(SwitchMixin(LitElement)) {
 
-	/**
-	 * The text that is displayed for the switch label.
-	 * @default "Visibility"
-	 */
+	static get properties() {
+		return {
+			_hasConditions: { state: true }
+		};
+	}
+
+	static get styles() {
+		return [super.styles, css`
+			d2l-tooltip-help {
+				display: none;
+			}
+			d2l-tooltip-help.switch-visibility-conditions-show {
+				display: inline;
+			}
+		`];
+	}
+
+	constructor() {
+		super();
+		this._hasConditions = false;
+	}
+
 	get text() {
-		return (this._text ? this._text : this.localize('components.switch.visibility'));
+		if (this._text) return this._text;
+
+		if (this.on && this._hasConditions && this.textPosition === 'hidden') {
+			return `${this.localize('components.switch.visibleWithPeriod')} ${this.localize('components.switch.conditions')}`;
+		}
+		else if (this.on && this._hasConditions) {
+			return this.localize('components.switch.visibleWithPeriod');
+		}
+		else if (this.on) {
+			return this.localize('components.switch.visible');
+		}
+		else {
+			return this.localize('components.switch.hidden');
+		}
 	}
 
 	set text(val) {
@@ -32,6 +66,30 @@ class VisibilitySwitch extends LocalizeCoreElement(SwitchMixin(LitElement)) {
 		return html`<d2l-icon icon="tier1:visibility-show"></d2l-icon>`;
 	}
 
+	get _labelContent() {
+		if (this._text) return super._labelContent;
+
+		const tooltipHelpClasses = {
+			'switch-visibility-conditions-show': this.on && this._hasConditions,
+			'd2l-switch-text': true
+		};
+
+		const conditions = html`
+			<d2l-tooltip-help 
+				class="${classMap(tooltipHelpClasses)}" 
+				id="conditions-help" 
+				inherit-font-style
+				text="${this.localize('components.switch.conditions')}">
+				<slot @slotchange="${this._handleConditionsSlotChange}"></slot>
+			</d2l-tooltip-help>
+			`;
+
+		return html`${super._labelContent}${conditions}`;
+	}
+
+	_handleConditionsSlotChange(e) {
+		this._hasConditions = e.target.assignedNodes({ flatten: true }).length > 0;
+	}
 }
 
 customElements.define('d2l-switch-visibility', VisibilitySwitch);

package/components/switch/switch.js

@@ -6,6 +6,7 @@ import { SwitchMixin } from './switch-mixin.js';
 
 /**
  * A generic switch with on/off semantics.
+ * @attr {string} text - REQUIRED: The text that is displayed for the switch label.
  */
 class Switch extends SwitchMixin(LitElement) {
 

package/components/tooltip/tooltip.js

@@ -466,11 +466,14 @@ class Tooltip extends RtlMixin(LitElement) {
 			}
 		}
 
+		// Note: role="text" is a workaround for Safari. Otherwise, list-item content is not announced with VoiceOver
 		return html`
 			<div class="d2l-tooltip-container">
 				<div class="d2l-tooltip-position" style=${styleMap(tooltipPositionStyle)}>
 					<div class="d2l-body-small d2l-tooltip-content">
-						<slot></slot>
+						<div role="text">
+							<slot></slot>
+						</div>
 					</div>
 				</div>
 				<div class="d2l-tooltip-pointer">

package/custom-elements.json

@@ -3813,7 +3813,7 @@
         {
           "name": "inline",
           "description": "Whether to display the HTML in inline mode",
-          "type": "boolean",
+          "type": "Boolean",
           "default": "false"
         },
         {
@@ -3835,7 +3835,7 @@
           "name": "inline",
           "attribute": "inline",
           "description": "Whether to display the HTML in inline mode",
-          "type": "boolean",
+          "type": "Boolean",
           "default": "false"
         },
         {
@@ -9851,12 +9851,6 @@
       "path": "./components/switch/switch-visibility.js",
       "description": "A variant of the generic switch configured with special icons and default text for toggling \"visibility\".",
       "attributes": [
-        {
-          "name": "text",
-          "description": "The text that is displayed for the switch label.",
-          "type": "string",
-          "default": "\"\\\"Visibility\\\"\""
-        },
         {
           "name": "disabled",
           "description": "Disables the switch from being toggled.",
@@ -9877,6 +9871,9 @@
         }
       ],
       "properties": [
+        {
+          "name": "text"
+        },
         {
           "name": "offIcon",
           "type": "TemplateResult<1>"
@@ -9885,13 +9882,6 @@
           "name": "onIcon",
           "type": "TemplateResult<1>"
         },
-        {
-          "name": "text",
-          "attribute": "text",
-          "description": "The text that is displayed for the switch label.",
-          "type": "string",
-          "default": "\"\\\"Visibility\\\"\""
-        },
         {
           "name": "disabled",
           "attribute": "disabled",
@@ -9924,6 +9914,12 @@
           "name": "change",
           "description": "Dispatched when the `on` property is updated"
         }
+      ],
+      "slots": [
+        {
+          "name": "",
+          "description": "Optional content that will be displayed within the \"conditions\" opener tooltip when the switch is on."
+        }
       ]
     },
     {
@@ -9931,11 +9927,6 @@
       "path": "./components/switch/switch.js",
       "description": "A generic switch with on/off semantics.",
       "attributes": [
-        {
-          "name": "text",
-          "description": "REQUIRED: The text that is displayed for the switch label.",
-          "type": "string"
-        },
         {
           "name": "disabled",
           "description": "Disables the switch from being toggled.",
@@ -9953,6 +9944,11 @@
           "description": "Determines where text should be positioned relative to the switch.",
           "type": "'start'|'end'|'hidden'",
           "default": "\"end\""
+        },
+        {
+          "name": "text",
+          "description": "REQUIRED: The text that is displayed for the switch label.",
+          "type": "string"
         }
       ],
       "properties": [
@@ -9964,12 +9960,6 @@
           "name": "onIcon",
           "type": "TemplateResult<1>"
         },
-        {
-          "name": "text",
-          "attribute": "text",
-          "description": "REQUIRED: The text that is displayed for the switch label.",
-          "type": "string"
-        },
         {
           "name": "disabled",
           "attribute": "disabled",