@brightspace-ui/core 1.196.2 → 1.197.2

package/components/selection/selection-summary.js

@@ -6,13 +6,15 @@ import { SelectionObserverMixin } from './selection-observer-mixin.js';
 
 /**
  * A summary showing the current selected count.
+ * @fires d2l-selection-observer-subscribe - Internal event
  */
 class Summary extends LocalizeCoreElement(SelectionObserverMixin(LitElement)) {
 
 	static get properties() {
 		return {
 			/**
-			 * Text to display if no items are selected.
+			 * Text to display if no items are selected
+			 * @type {string}
 			 */
 			noSelectionText: { type: String, attribute: 'no-selection-text' }
 		};

package/components/skeleton/skeleton-mixin.js

@@ -148,6 +148,7 @@ export const SkeletonMixin = dedupeMixin(superclass => class extends RtlMixin(su
 		return {
 			/**
 			 * Renders the input as a [skeleton loader](https://github.com/BrightspaceUI/core/tree/main/components/skeleton)
+			 * @type {boolean}
 			 */
 			skeleton: { reflect: true, type: Boolean  }
 		};

package/components/status-indicator/status-indicator.js

@@ -18,12 +18,14 @@ class StatusIndicator extends LitElement {
 			},
 			/**
 			 * REQUIRED: The text that is displayed within the status indicator
+			 * @type {string}
 			 */
 			text: {
 				type: String
 			},
 			/**
 			 * Use when the status is very important and needs to have a lot of prominence
+			 * @type {boolean}
 			 */
 			bold: {
 				type: Boolean,

package/components/switch/switch-mixin.js

@@ -234,6 +234,7 @@ export const SwitchMixin = superclass => class extends RtlMixin(FocusVisiblePoly
 	_toggleState() {
 		if (this.disabled) return;
 		this.on = !this.on;
+		/** Dispatched when the `on` property is updated */
 		this.dispatchEvent(new CustomEvent('change', { bubbles: true }));
 	}
 };

package/components/switch/switch-visibility.js

@@ -3,6 +3,9 @@ import { html, LitElement } from 'lit-element/lit-element.js';
 import { LocalizeCoreElement } from '../../lang/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".
+ */
 class VisibilitySwitch extends LocalizeCoreElement(SwitchMixin(LitElement)) {
 
 	get text() {

package/components/switch/switch.js

@@ -4,6 +4,9 @@ import '../icons/icon-custom.js';
 import { html, LitElement } from 'lit-element/lit-element.js';
 import { SwitchMixin } from './switch-mixin.js';
 
+/**
+ * A generic switch with on/off semantics.
+ */
 class Switch extends SwitchMixin(LitElement) {
 
 	get offIcon() {

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

@@ -2,9 +2,7 @@ import '../icons/icon.js';
 import { css, html, LitElement } from 'lit-element/lit-element.js';
 
 /**
- *
  * Button for sorting a table column in ascending/descending order.
- *
  * @slot - Text of the sort button
  */
 export class TableColSortButton extends LitElement {

package/components/table/table-wrapper.js

@@ -164,9 +164,7 @@ export const tableStyles = css`
 `;
 
 /**
- *
  * Wraps a native <table> element, providing styling and scroll buttons for overflow.
- *
  * @slot - Content to wrap
  */
 export class TableWrapper extends RtlMixin(LitElement) {

package/components/tabs/tab-panel-mixin.js

@@ -55,6 +55,7 @@ export const TabPanelMixin = superclass => class extends superclass {
 		super.attributeChangedCallback(name, oldval, newval);
 		if (name === 'text') {
 			this.setAttribute('aria-label', this.text);
+			/** Dispatched when the text attribute is changed */
 			this.dispatchEvent(new CustomEvent(
 				'd2l-tab-panel-text-changed', { bubbles: true, composed: true, detail: { text: this.text } }
 			));
@@ -73,6 +74,7 @@ export const TabPanelMixin = superclass => class extends superclass {
 			if (prop === 'selected') {
 				if (this.selected) {
 					requestAnimationFrame(() => {
+						/** Dispatched when a tab is selected */
 						this.dispatchEvent(new CustomEvent(
 							'd2l-tab-panel-selected', { bubbles: true, composed: true }
 						));

package/components/tabs/tab-panel.js

@@ -4,8 +4,6 @@ import { TabPanelMixin } from './tab-panel-mixin.js';
 /**
  * A component for tab panel content.
  * @slot - Default content in tab panel
- * @fires d2l-tab-panel-text-changed - Dispatched when the text attribute is changed
- * @fires d2l-tab-panel-selected - Dispatched when a tab is selected
  */
 class TabPanel extends TabPanelMixin(LitElement) {