docs(storybook): move events to SelectableMixin base class

This also fixes a mixup of events that was forgotten
umbraco · Mar 21, 2022 · 9dc03e7 · 9dc03e7
1 parent 3f13ef8
commit 9dc03e7
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 19 deletions.
diff --git a/packages/uui-base/lib/mixins/SelectableMixin.ts b/packages/uui-base/lib/mixins/SelectableMixin.ts
@@ -1,5 +1,6 @@
 import { LitElement } from 'lit';
 import { property } from 'lit/decorators.js';
+
 import { UUISelectableEvent } from '../events/UUISelectableEvent';
 
 type Constructor<T = {}> = new (...args: any[]) => T;
@@ -19,6 +20,10 @@ export declare class SelectableMixinInterface extends LitElement {
 export const SelectableMixin = <T extends Constructor<LitElement>>(
   superClass: T
 ) => {
+  /**
+   * @fires {UUISelectableEvent} selected - fires when the media card is selected
+   * @fires {UUISelectableEvent} unselected - fires when the media card is unselected
+   */
   class SelectableMixinClass extends superClass {
     private _selectable = false;
     /**

diff --git a/packages/uui-card-content-node/lib/uui-card-content-node.element.ts b/packages/uui-card-content-node/lib/uui-card-content-node.element.ts
@@ -1,15 +1,12 @@
-import { UUICardElement } from '@umbraco-ui/uui-card/lib';
 import { defineElement } from '@umbraco-ui/uui-base/lib/registration';
+import { UUICardElement } from '@umbraco-ui/uui-card/lib';
 import { css, html, nothing } from 'lit';
 import { property, state } from 'lit/decorators.js';
 
 /**
  *  @element uui-card-content-node
- *  @fires {UUICardEvent} open - fires when the card title is clicked
- *  @fires {UUICardEvent} selected - fires when the card is selected
  *  @description - Card component for displaying a content-node.
  */
-
 @defineElement('uui-card-content-node')
 export class UUICardContentNodeElement extends UUICardElement {
   static styles = [

diff --git a/packages/uui-card-media/lib/uui-card-media.element.ts b/packages/uui-card-media/lib/uui-card-media.element.ts
@@ -1,15 +1,12 @@
-import { UUICardElement } from '@umbraco-ui/uui-card/lib';
 import { defineElement } from '@umbraco-ui/uui-base/lib/registration';
+import { UUICardElement } from '@umbraco-ui/uui-card/lib';
 import { css, html, nothing } from 'lit';
 import { property, state } from 'lit/decorators.js';
 
 /**
  *  @element uui-card-media
- *  @fires {UUICardEvent} open - fires when the media card title is clicked
- *  @fires {UUICardEvent} selected - fires when the card is selected
  *  @description - Card component for displaying a media item.
  */
-
 @defineElement('uui-card-media')
 export class UUICardMediaElement extends UUICardElement {
   static styles = [

diff --git a/packages/uui-card-user/lib/uui-card-user.element.ts b/packages/uui-card-user/lib/uui-card-user.element.ts
@@ -1,15 +1,12 @@
-import { UUICardElement } from '@umbraco-ui/uui-card/lib';
 import { defineElement } from '@umbraco-ui/uui-base/lib/registration';
+import { UUICardElement } from '@umbraco-ui/uui-card/lib';
 import { css, html, nothing } from 'lit';
 import { property } from 'lit/decorators.js';
 
 /**
  *  @element uui-card-user
- *  @fires {UUICardEvent} open - fires when the user card title is clicked
- *  @fires {UUICardEvent} selected - fires when the card is selected
  *  @description - Card component for displaying a user node.
  */
-
 @defineElement('uui-card-user')
 export class UUICardUserElement extends UUICardElement {
   static styles = [

diff --git a/packages/uui-card/lib/uui-card.element.ts b/packages/uui-card/lib/uui-card.element.ts
@@ -1,20 +1,18 @@
-import { LitElement, css } from 'lit';
-import { defineElement } from '@umbraco-ui/uui-base/lib/registration';
-import { property } from 'lit/decorators.js';
 import {
   SelectableMixin,
   SelectOnlyMixin,
 } from '@umbraco-ui/uui-base/lib/mixins';
+import { defineElement } from '@umbraco-ui/uui-base/lib/registration';
+import { css, LitElement } from 'lit';
+import { property } from 'lit/decorators.js';
+
 import { UUICardEvent } from './UUICardEvent';
 
 /**
  *  @element uui-card
- *  @fires {UUICardEvent} open - fires when the media card title is clicked
- *  @fires {UUISelectableEvent} select - fires when the media card is selected
- *  @fires {UUISelectableEvent} unselect - fires when the media card is unselected
+ *  @fires {UUICardEvent} open - fires when the card title is clicked
  *  @description - Base card component to be extended by specific cards.
  */
-
 @defineElement('uui-card')
 export class UUICardElement extends SelectOnlyMixin(
   SelectableMixin(LitElement)