@brightspace-ui/core 1.235.1 → 1.236.0

package/components/link/link.js

@@ -1,6 +1,7 @@
 import '../colors/colors.js';
 import { css, html, LitElement } from 'lit-element/lit-element.js';
 import { classMap } from 'lit-html/directives/class-map.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { ifDefined } from 'lit-html/directives/if-defined.js';
 
 export const linkStyles = css`
@@ -41,7 +42,7 @@ export const linkStyles = css`
  * This component can be used just like the native anchor tag.
  * @slot - The content (e.g., text) that when selected causes navigation
  */
-class Link extends LitElement {
+class Link extends FocusMixin(LitElement) {
 
 	static get properties() {
 		return {
@@ -96,6 +97,8 @@ class Link extends LitElement {
 		];
 	}
 
+	static focusElementSelector = '.d2l-link';
+
 	constructor() {
 		super();
 		this.download = false;
@@ -117,9 +120,5 @@ class Link extends LitElement {
 				target="${ifDefined(this.target)}"><slot></slot></a>`;
 	}
 
-	focus() {
-		const link = this.shadowRoot && this.shadowRoot.querySelector('.d2l-link');
-		if (link) link.focus();
-	}
 }
 customElements.define('d2l-link', Link);

package/components/list/list-item-mixin.js

@@ -193,6 +193,7 @@ export const ListItemMixin = superclass => class extends LocalizeCoreElement(Lis
 			.d2l-list-item-actions-container {
 				padding: 0.55rem 0;
 			}
+
 			::slotted([slot="actions"]),
 			.d2l-list-item-actions * {
 				display: grid;
@@ -202,6 +203,16 @@ export const ListItemMixin = superclass => class extends LocalizeCoreElement(Lis
 				margin: 0.15rem 0;
 			}
 
+			.d2l-list-item-content-extend-separators ::slotted([slot="actions"]),
+			.d2l-list-item-content-extend-separators .d2l-list-item-actions * {
+				margin-right: 0.9rem;
+			}
+			:host([dir="rtl"]) .d2l-list-item-content-extend-separators ::slotted([slot="actions"]),
+			:host([dir="rtl"]) .d2l-list-item-content-extend-separators .d2l-list-item-actions * {
+				margin-left: 0.9rem;
+				margin-right: 0;
+			}
+
 			[data-breakpoint="1"] ::slotted([slot="illustration"]),
 			[data-breakpoint="1"] .d2l-list-item-illustration * {
 				margin-right: 1rem;

package/components/selection/selection-action-dropdown.js

@@ -2,6 +2,7 @@ import '../button/button-subtle.js';
 import { html, LitElement } from 'lit-element/lit-element.js';
 import { DropdownOpenerMixin } from '../dropdown/dropdown-opener-mixin.js';
 import { dropdownOpenerStyles } from '../dropdown/dropdown-opener-styles.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { ifDefined } from 'lit-html/directives/if-defined.js';
 import { LocalizeCoreElement } from '../../lang/localize-core-element.js';
 import { SelectionActionMixin } from './selection-action-mixin.js';
@@ -11,7 +12,7 @@ import { SelectionActionMixin } from './selection-action-mixin.js';
  * @slot - Dropdown content (e.g., "d2l-dropdown-content", "d2l-dropdown-menu" or "d2l-dropdown-tabs")
  * @fires d2l-selection-observer-subscribe - Internal event
  */
-class ActionDropdown extends LocalizeCoreElement(SelectionActionMixin(DropdownOpenerMixin(LitElement))) {
+class ActionDropdown extends FocusMixin(LocalizeCoreElement(SelectionActionMixin(DropdownOpenerMixin(LitElement)))) {
 
 	static get properties() {
 		return {
@@ -27,6 +28,8 @@ class ActionDropdown extends LocalizeCoreElement(SelectionActionMixin(DropdownOp
 		return dropdownOpenerStyles;
 	}
 
+	static focusElementSelector = 'd2l-button-subtle';
+
 	render() {
 		return html`
 			<d2l-button-subtle
@@ -39,11 +42,6 @@ class ActionDropdown extends LocalizeCoreElement(SelectionActionMixin(DropdownOp
 		`;
 	}
 
-	focus() {
-		const elem = this.shadowRoot && this.shadowRoot.querySelector('d2l-button-subtle');
-		if (elem) elem.focus();
-	}
-
 	/**
 	 * Gets the opener element with class "d2l-dropdown-opener" (required by dropdown-opener-mixin).
 	 * @return {HTMLElement}

package/components/selection/selection-action.js

@@ -1,6 +1,7 @@
 import '../button/button-subtle.js';
 import { css, html, LitElement } from 'lit-element/lit-element.js';
 import { ButtonMixin } from '../button/button-mixin.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { ifDefined } from 'lit-html/directives/if-defined.js';
 import { LocalizeCoreElement } from '../../lang/localize-core-element.js';
 import { SelectionActionMixin } from './selection-action-mixin.js';
@@ -11,7 +12,7 @@ import { SelectionInfo } from './selection-mixin.js';
  * @fires d2l-selection-action-click - Dispatched when the user clicks the action button. The `SelectionInfo` is provided as the event `detail`. If `requires-selection` was specified then the event will only be dispatched if items are selected.
  * @fires d2l-selection-observer-subscribe - Internal event
  */
-class Action extends LocalizeCoreElement(SelectionActionMixin(ButtonMixin(LitElement))) {
+class Action extends FocusMixin(LocalizeCoreElement(SelectionActionMixin(ButtonMixin(LitElement)))) {
 
 	static get properties() {
 		return {
@@ -39,6 +40,8 @@ class Action extends LocalizeCoreElement(SelectionActionMixin(ButtonMixin(LitEle
 		`;
 	}
 
+	static focusElementSelector = 'd2l-button-subtle';
+
 	connectedCallback() {
 		super.connectedCallback();
 		this.addEventListener('d2l-button-ghost-click', this._handleActionClick);
@@ -61,11 +64,6 @@ class Action extends LocalizeCoreElement(SelectionActionMixin(ButtonMixin(LitEle
 		`;
 	}
 
-	focus() {
-		const elem = this.shadowRoot && this.shadowRoot.querySelector('d2l-button-subtle');
-		if (elem) elem.focus();
-	}
-
 	_handleActionClick(e) {
 		e.stopPropagation();
 

package/components/selection/selection-select-all-pages.js

@@ -1,5 +1,6 @@
 import '../button/button-subtle.js';
 import { css, html, LitElement } from 'lit-element/lit-element.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { LocalizeCoreElement } from '../../lang/localize-core-element.js';
 import { SelectionInfo } from './selection-mixin.js';
 import { SelectionObserverMixin } from './selection-observer-mixin.js';
@@ -8,7 +9,7 @@ import { SelectionObserverMixin } from './selection-observer-mixin.js';
  * A subtle button that selects all items for all pages.
  * @fires d2l-selection-observer-subscribe - Internal event
  */
-class SelectAllPages extends LocalizeCoreElement(SelectionObserverMixin(LitElement)) {
+class SelectAllPages extends FocusMixin(LocalizeCoreElement(SelectionObserverMixin(LitElement))) {
 
 	static get styles() {
 		return css`
@@ -21,6 +22,8 @@ class SelectAllPages extends LocalizeCoreElement(SelectionObserverMixin(LitEleme
 		`;
 	}
 
+	static focusElementSelector = 'd2l-button-subtle';
+
 	render() {
 		if (!this._provider) return;
 		if (!this._provider.itemCount) return;
@@ -34,11 +37,6 @@ class SelectAllPages extends LocalizeCoreElement(SelectionObserverMixin(LitEleme
 			</d2l-button-subtle>`;
 	}
 
-	focus() {
-		const elem = this.shadowRoot && this.shadowRoot.querySelector('d2l-button-subtle');
-		if (elem) elem.focus();
-	}
-
 	_handleClick() {
 		if (this._provider) this._provider.setSelectionForAll(true, true);
 	}

package/components/selection/selection-select-all.js

@@ -1,5 +1,6 @@
 import '../inputs/input-checkbox.js';
 import { css, html, LitElement } from 'lit-element/lit-element.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { ifDefined } from 'lit-html/directives/if-defined.js';
 import { LocalizeCoreElement } from '../../lang/localize-core-element.js';
 import { SelectionInfo } from './selection-mixin.js';
@@ -9,7 +10,7 @@ import { SelectionObserverMixin } from './selection-observer-mixin.js';
  * A checkbox that provides select-all behavior for selection components such as tables and lists.
  * @fires d2l-selection-observer-subscribe - Internal event
  */
-class SelectAll extends LocalizeCoreElement(SelectionObserverMixin(LitElement)) {
+class SelectAll extends FocusMixin(LocalizeCoreElement(SelectionObserverMixin(LitElement))) {
 
 	static get properties() {
 		return {
@@ -33,6 +34,8 @@ class SelectAll extends LocalizeCoreElement(SelectionObserverMixin(LitElement))
 		`;
 	}
 
+	static focusElementSelector = 'd2l-input-checkbox';
+
 	constructor() {
 		super();
 		this.disabled = false;
@@ -56,11 +59,6 @@ class SelectAll extends LocalizeCoreElement(SelectionObserverMixin(LitElement))
 		`;
 	}
 
-	focus() {
-		const elem = this.shadowRoot && this.shadowRoot.querySelector('d2l-input-checkbox');
-		if (elem) elem.focus();
-	}
-
 	_handleCheckboxChange(e) {
 		if (this._provider) this._provider.setSelectionForAll(e.target.checked, false);
 	}

package/components/switch/README.md

@@ -32,7 +32,7 @@ The `d2l-switch` element is a generic switch with on/off semantics.
 ![Switch](./screenshots/switch.png?raw=true)
 <!-- docs: end hidden content -->
 
-<!-- docs: demo live name:d2l-switch -->
+<!-- docs: demo live name:d2l-switch autoSize:false size:small -->
 ```html
 <script type="module">
   import '@brightspace-ui/core/components/switch/switch.js';
@@ -71,7 +71,7 @@ The `d2l-switch-visibility` element is a variant of the generic switch configure
 ![Visibility Switch](./screenshots/switch-visibility.png?raw=true)
 <!-- docs: end hidden content -->
 
-<!-- docs: demo live name:d2l-switch-visibility -->
+<!-- docs: demo live name:d2l-switch-visibility autoSize:false size:small -->
 ```html
 <script type="module">
   import '@brightspace-ui/core/components/switch/switch-visibility.js';

package/components/switch/switch-mixin.js

@@ -1,12 +1,13 @@
 import '../colors/colors.js';
 import '../tooltip/tooltip.js';
 import { css, html } from 'lit-element/lit-element.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 import { FocusVisiblePolyfillMixin } from '../../mixins/focus-visible-polyfill-mixin.js';
 import { getUniqueId } from '../../helpers/uniqueId.js';
 import { ifDefined } from 'lit-html/directives/if-defined.js';
 import { RtlMixin } from '../../mixins/rtl-mixin.js';
 
-export const SwitchMixin = superclass => class extends RtlMixin(FocusVisiblePolyfillMixin(superclass)) {
+export const SwitchMixin = superclass => class extends FocusMixin(RtlMixin(FocusVisiblePolyfillMixin(superclass))) {
 
 	static get properties() {
 		return {
@@ -165,6 +166,8 @@ export const SwitchMixin = superclass => class extends RtlMixin(FocusVisiblePoly
 		`;
 	}
 
+	static focusElementSelector = '.d2l-switch-container';
+
 	constructor() {
 		super();
 		this.disabled = false;
@@ -212,11 +215,6 @@ export const SwitchMixin = superclass => class extends RtlMixin(FocusVisiblePoly
 		`;
 	}
 
-	focus() {
-		const elem = this.shadowRoot && this.shadowRoot.querySelector('.d2l-switch-container');
-		if (elem) elem.focus();
-	}
-
 	_handleClick() {
 		this._toggleState();
 	}

package/components/table/table-col-sort-button.js

@@ -1,11 +1,12 @@
 import '../icons/icon.js';
 import { css, html, LitElement } from 'lit-element/lit-element.js';
+import { FocusMixin } from '../../mixins/focus-mixin.js';
 
 /**
  * Button for sorting a table column in ascending/descending order.
  * @slot - Text of the sort button
  */
-export class TableColSortButton extends LitElement {
+export class TableColSortButton extends FocusMixin(LitElement) {
 
 	static get properties() {
 		return {
@@ -57,6 +58,8 @@ export class TableColSortButton extends LitElement {
 		`;
 	}
 
+	static focusElementSelector = 'button';
+
 	constructor() {
 		super();
 		this.nosort = false;
@@ -70,11 +73,6 @@ export class TableColSortButton extends LitElement {
 		return html`<button type="button"><slot></slot>${iconView}</button>`;
 	}
 
-	focus() {
-		const button = this.shadowRoot && this.shadowRoot.querySelector('button');
-		if (button) button.focus();
-	}
-
 }
 
 customElements.define('d2l-table-col-sort-button', TableColSortButton);

package/custom-elements.json

@@ -408,6 +408,11 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"button\""
+        },
         {
           "name": "visibleOnAncestor",
           "type": "boolean",
@@ -502,6 +507,11 @@
           "description": "Disables the button",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"button\""
         }
       ],
       "slots": [
@@ -565,6 +575,11 @@
           "description": "Disables the button",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"button\""
         }
       ],
       "slots": [
@@ -979,6 +994,11 @@
           "description": "Subtle aesthetic on non-white backgrounds",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"a\""
         }
       ],
       "slots": [
@@ -3137,6 +3157,11 @@
           "description": "Indicates if the filter is open",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-dropdown-button-subtle\""
         }
       ],
       "events": [
@@ -3179,6 +3204,11 @@
           "description": "Whether the component should trap user focus.",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\".d2l-focus-trap-start\""
         }
       ],
       "events": [
@@ -3759,6 +3789,11 @@
           "type": "string",
           "default": "\"on\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"input.d2l-input-checkbox\""
+        },
         {
           "name": "skeleton",
           "attribute": "skeleton",
@@ -3983,6 +4018,11 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-date\""
+        },
         {
           "name": "skeleton",
           "attribute": "skeleton",
@@ -4280,6 +4320,11 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-date-time\""
+        },
         {
           "name": "skeleton",
           "attribute": "skeleton",
@@ -4450,6 +4495,11 @@
           "type": "string",
           "default": "\"startOfDay\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-date\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -4616,6 +4666,11 @@
           "type": "string",
           "default": "\"\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-text\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -4955,6 +5010,11 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-text\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -5153,6 +5213,11 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-number\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -5290,6 +5355,11 @@
           "description": "Value of the input",
           "type": "string",
           "default": "\"\""
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-text\""
         }
       ],
       "events": [
@@ -5629,6 +5699,11 @@
           "type": "'text'|'email'|'number'|'password'|'search'|'tel'|'url'",
           "default": "\"text\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\".d2l-input\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -5868,6 +5943,11 @@
           "type": "string",
           "default": "\"\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"textarea\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -6117,6 +6197,11 @@
           "type": "'five'|'ten'|'fifteen'|'twenty'|'thirty'|'sixty'",
           "default": "\"thirty\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-time\""
+        },
         {
           "name": "skeleton",
           "attribute": "skeleton",
@@ -6277,6 +6362,11 @@
           "type": "'five'|'ten'|'fifteen'|'twenty'|'thirty'|'sixty'",
           "default": "\"thirty\""
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\".d2l-input\""
+        },
         {
           "name": "labelledBy",
           "attribute": "labelled-by",
@@ -6393,6 +6483,11 @@
           "description": "Whether to apply the \"small\" link style",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\".d2l-link\""
         }
       ],
       "slots": [
@@ -8518,6 +8613,11 @@
           "description": "REQUIRED: Text for the dropdown opener button",
           "type": "string"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-button-subtle\""
+        },
         {
           "name": "requiresSelection",
           "attribute": "requires-selection",
@@ -8751,6 +8851,11 @@
           "description": "Disables the button",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-button-subtle\""
         }
       ],
       "events": [
@@ -8870,6 +8975,11 @@
         }
       ],
       "properties": [
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-button-subtle\""
+        },
         {
           "name": "selectionFor",
           "attribute": "selection-for",
@@ -8912,6 +9022,11 @@
           "type": "boolean",
           "default": "false"
         },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"d2l-input-checkbox\""
+        },
         {
           "name": "selectionFor",
           "attribute": "selection-for",
@@ -9334,6 +9449,11 @@
           "description": "Determines where text should be positioned relative to the switch.",
           "type": "'start'|'end'|'hidden'",
           "default": "\"end\""
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\".d2l-switch-container\""
         }
       ],
       "events": [
@@ -9423,6 +9543,11 @@
           "description": "Determines where text should be positioned relative to the switch.",
           "type": "'start'|'end'|'hidden'",
           "default": "\"end\""
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\".d2l-switch-container\""
         }
       ],
       "events": [
@@ -9516,6 +9641,11 @@
           "description": "Whether sort direction is descending",
           "type": "boolean",
           "default": "false"
+        },
+        {
+          "name": "focusElementSelector",
+          "type": "string",
+          "default": "\"button\""
         }
       ],
       "slots": [

package/mixins/focus-mixin.js

@@ -0,0 +1,41 @@
+import { dedupeMixin } from '@open-wc/dedupe-mixin';
+
+export const FocusMixin = dedupeMixin(superclass => class extends superclass {
+
+	static focusElementSelector = null;
+
+	constructor() {
+		super();
+		this._focusOnFirstRender = false;
+	}
+
+	firstUpdated(changedProperties) {
+		super.firstUpdated(changedProperties);
+		if (this._focusOnFirstRender) {
+			this._focusOnFirstRender = false;
+			this.focus();
+		}
+	}
+
+	focus() {
+
+		const selector = this.constructor.focusElementSelector;
+		if (!selector) {
+			throw new Error(`FocusMixin: no static focusElementSelector provided for "${this.tagName}"`);
+		}
+
+		if (!this.hasUpdated) {
+			this._focusOnFirstRender = true;
+			return;
+		}
+
+		const elem = this.shadowRoot.querySelector(selector);
+		if (!elem) {
+			throw new Error(`FocusMixin: selector "${selector}" yielded no element for "${this.tagName}"`);
+		}
+
+		elem.focus();
+
+	}
+
+});

package/mixins/focus-mixin.md

@@ -0,0 +1,24 @@
+# FocusMixin
+
+The `FocusMixin` can be used to delegate focus to an element within a component's shadow root when its `focus()` method is called.
+
+If the component has yet to render, focus will automatically be applied after `firstUpdated`.
+
+## Usage
+
+Apply the mixin and set the static `focusElementSelector` to a CSS query selector which will match the element to which focus should be delegated.
+
+```js
+import { FocusMixin } from '@brightspace-ui/core/mixins/focus-mixin.js';
+
+class MyComponent extends FocusMixin(LitElement) {
+  
+  // delegate focus to the underlying input
+  static focusElementSelector = 'input';
+
+  render() {
+	  return html`<input type="text">`;
+  }
+
+}
+```

package/package.json

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