shoelace-rails-ui 0.1.0

data/remote-src/2.0.0.beta64/shoelace-next/src/components/drawer/drawer.ts

@@ -0,0 +1,377 @@
+import { LitElement, html } from 'lit';
+import { customElement, property, query } from 'lit/decorators.js';
+import { classMap } from 'lit/directives/class-map.js';
+import { ifDefined } from 'lit/directives/if-defined.js';
+import { animateTo, stopAnimations } from '../../internal/animate';
+import { emit } from '../../internal/event';
+import { watch } from '../../internal/watch';
+import { waitForEvent } from '../../internal/event';
+import { lockBodyScrolling, unlockBodyScrolling } from '../../internal/scroll';
+import { HasSlotController } from '../../internal/slot';
+import { uppercaseFirstLetter } from '../../internal/string';
+import { isPreventScrollSupported } from '../../internal/support';
+import Modal from '../../internal/modal';
+import { setDefaultAnimation, getAnimation } from '../../utilities/animation-registry';
+import styles from './drawer.styles';
+
+import '../icon-button/icon-button';
+
+const hasPreventScroll = isPreventScrollSupported();
+
+/**
+ * @since 2.0
+ * @status stable
+ *
+ * @dependency sl-icon-button
+ *
+ * @slot - The drawer's content.
+ * @slot label - The drawer's label. Alternatively, you can use the label prop.
+ * @slot footer - The drawer's footer, usually one or more buttons representing various options.
+ *
+ * @event sl-show - Emitted when the drawer opens.
+ * @event sl-after-show - Emitted after the drawer opens and all animations are complete.
+ * @event sl-hide - Emitted when the drawer closes.
+ * @event sl-after-hide - Emitted after the drawer closes and all animations are complete.
+ * @event sl-initial-focus - Emitted when the drawer opens and the panel gains focus. Calling `event.preventDefault()` will
+ *   prevent focus and allow you to set it on a different element in the drawer, such as an input or button.
+ * @event sl-request-close - Emitted when the user attempts to close the drawer by clicking the close button, clicking the
+ *   overlay, or pressing the escape key. Calling `event.preventDefault()` will prevent the drawer from closing. Avoid
+ *   using this unless closing the drawer will result in destructive behavior such as data loss.
+ *
+ * @csspart base - The component's base wrapper.
+ * @csspart overlay - The overlay.
+ * @csspart panel - The drawer panel (where the drawer and its content is rendered).
+ * @csspart header - The drawer header.
+ * @csspart title - The drawer title.
+ * @csspart close-button - The close button.
+ * @csspart body - The drawer body.
+ * @csspart footer - The drawer footer.
+ *
+ * @cssproperty --size - The preferred size of the drawer. This will be applied to the drawer's width or height
+ *   depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens.
+ * @cssproperty --header-spacing - The amount of padding to use for the header.
+ * @cssproperty --body-spacing - The amount of padding to use for the body.
+ * @cssproperty --footer-spacing - The amount of padding to use for the footer.
+ *
+ * @animation drawer.showTop - The animation to use when showing a drawer with `top` placement.
+ * @animation drawer.showEnd - The animation to use when showing a drawer with `end` placement.
+ * @animation drawer.showBottom - The animation to use when showing a drawer with `bottom` placement.
+ * @animation drawer.showStart - The animation to use when showing a drawer with `start` placement.
+ * @animation drawer.hideTop - The animation to use when hiding a drawer with `top` placement.
+ * @animation drawer.hideEnd - The animation to use when hiding a drawer with `end` placement.
+ * @animation drawer.hideBottom - The animation to use when hiding a drawer with `bottom` placement.
+ * @animation drawer.hideStart - The animation to use when hiding a drawer with `start` placement.
+ * @animation drawer.denyClose - The animation to use when a request to close the drawer is denied.
+ * @animation drawer.overlay.show - The animation to use when showing the drawer's overlay.
+ * @animation drawer.overlay.hide - The animation to use when hiding the drawer's overlay.
+ */
+@customElement('sl-drawer')
+export default class SlDrawer extends LitElement {
+  static styles = styles;
+
+  @query('.drawer') drawer: HTMLElement;
+  @query('.drawer__panel') panel: HTMLElement;
+  @query('.drawer__overlay') overlay: HTMLElement;
+
+  private hasSlotController = new HasSlotController(this, 'footer');
+  private modal: Modal;
+  private originalTrigger: HTMLElement | null;
+
+  /** Indicates whether or not the drawer is open. You can use this in lieu of the show/hide methods. */
+  @property({ type: Boolean, reflect: true }) open = false;
+
+  /**
+   * The drawer's label as displayed in the header. You should always include a relevant label even when using
+   * `no-header`, as it is required for proper accessibility.
+   */
+  @property({ reflect: true }) label = '';
+
+  /** The direction from which the drawer will open. */
+  @property({ reflect: true }) placement: 'top' | 'end' | 'bottom' | 'start' = 'end';
+
+  /**
+   * By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of
+   * its parent element, set this prop and add `position: relative` to the parent.
+   */
+  @property({ type: Boolean, reflect: true }) contained = false;
+
+  /**
+   * Removes the header. This will also remove the default close button, so please ensure you provide an easy,
+   * accessible way for users to dismiss the drawer.
+   */
+  @property({ attribute: 'no-header', type: Boolean, reflect: true }) noHeader = false;
+
+  connectedCallback() {
+    super.connectedCallback();
+    this.modal = new Modal(this);
+  }
+
+  firstUpdated() {
+    this.drawer.hidden = !this.open;
+
+    if (this.open && !this.contained) {
+      this.modal.activate();
+      lockBodyScrolling(this);
+    }
+  }
+
+  disconnectedCallback() {
+    super.disconnectedCallback();
+    unlockBodyScrolling(this);
+  }
+
+  /** Shows the drawer. */
+  async show() {
+    if (this.open) {
+      return;
+    }
+
+    this.open = true;
+    return waitForEvent(this, 'sl-after-show');
+  }
+
+  /** Hides the drawer */
+  async hide() {
+    if (!this.open) {
+      return;
+    }
+
+    this.open = false;
+    return waitForEvent(this, 'sl-after-hide');
+  }
+
+  private requestClose() {
+    const slRequestClose = emit(this, 'sl-request-close', { cancelable: true });
+    if (slRequestClose.defaultPrevented) {
+      const animation = getAnimation(this, 'drawer.denyClose');
+      animateTo(this.panel, animation.keyframes, animation.options);
+      return;
+    }
+
+    this.hide();
+  }
+
+  handleKeyDown(event: KeyboardEvent) {
+    if (event.key === 'Escape') {
+      event.stopPropagation();
+      this.requestClose();
+    }
+  }
+
+  @watch('open', { waitUntilFirstUpdate: true })
+  async handleOpenChange() {
+    if (this.open) {
+      // Show
+      emit(this, 'sl-show');
+      this.originalTrigger = document.activeElement as HTMLElement;
+
+      // Lock body scrolling only if the drawer isn't contained
+      if (!this.contained) {
+        this.modal.activate();
+        lockBodyScrolling(this);
+      }
+
+      await Promise.all([stopAnimations(this.drawer), stopAnimations(this.overlay)]);
+      this.drawer.hidden = false;
+
+      // Browsers that support el.focus({ preventScroll }) can set initial focus immediately
+      if (hasPreventScroll) {
+        const slInitialFocus = emit(this, 'sl-initial-focus', { cancelable: true });
+        if (!slInitialFocus.defaultPrevented) {
+          this.panel.focus({ preventScroll: true });
+        }
+      }
+
+      const panelAnimation = getAnimation(this, `drawer.show${uppercaseFirstLetter(this.placement)}`);
+      const overlayAnimation = getAnimation(this, 'drawer.overlay.show');
+      await Promise.all([
+        animateTo(this.panel, panelAnimation.keyframes, panelAnimation.options),
+        animateTo(this.overlay, overlayAnimation.keyframes, overlayAnimation.options)
+      ]);
+
+      // Browsers that don't support el.focus({ preventScroll }) have to wait for the animation to finish before initial
+      // focus to prevent scrolling issues. See: https://caniuse.com/mdn-api_htmlelement_focus_preventscroll_option
+      if (!hasPreventScroll) {
+        const slInitialFocus = emit(this, 'sl-initial-focus', { cancelable: true });
+        if (!slInitialFocus.defaultPrevented) {
+          this.panel.focus({ preventScroll: true });
+        }
+      }
+
+      emit(this, 'sl-after-show');
+    } else {
+      // Hide
+      emit(this, 'sl-hide');
+      this.modal.deactivate();
+      unlockBodyScrolling(this);
+
+      await Promise.all([stopAnimations(this.drawer), stopAnimations(this.overlay)]);
+      const panelAnimation = getAnimation(this, `drawer.hide${uppercaseFirstLetter(this.placement)}`);
+      const overlayAnimation = getAnimation(this, 'drawer.overlay.hide');
+      await Promise.all([
+        animateTo(this.panel, panelAnimation.keyframes, panelAnimation.options),
+        animateTo(this.overlay, overlayAnimation.keyframes, overlayAnimation.options)
+      ]);
+
+      this.drawer.hidden = true;
+
+      // Restore focus to the original trigger
+      const trigger = this.originalTrigger;
+      if (trigger && typeof trigger.focus === 'function') {
+        setTimeout(() => trigger.focus());
+      }
+
+      emit(this, 'sl-after-hide');
+    }
+  }
+
+  render() {
+    return html`
+      <div
+        part="base"
+        class=${classMap({
+          drawer: true,
+          'drawer--open': this.open,
+          'drawer--top': this.placement === 'top',
+          'drawer--end': this.placement === 'end',
+          'drawer--bottom': this.placement === 'bottom',
+          'drawer--start': this.placement === 'start',
+          'drawer--contained': this.contained,
+          'drawer--fixed': !this.contained,
+          'drawer--has-footer': this.hasSlotController.test('footer')
+        })}
+        @keydown=${this.handleKeyDown}
+      >
+        <div part="overlay" class="drawer__overlay" @click=${this.requestClose} tabindex="-1"></div>
+
+        <div
+          part="panel"
+          class="drawer__panel"
+          role="dialog"
+          aria-modal="true"
+          aria-hidden=${this.open ? 'false' : 'true'}
+          aria-label=${ifDefined(this.noHeader ? this.label : undefined)}
+          aria-labelledby=${ifDefined(!this.noHeader ? 'title' : undefined)}
+          tabindex="0"
+        >
+          ${!this.noHeader
+            ? html`
+                <header part="header" class="drawer__header">
+                  <span part="title" class="drawer__title" id="title">
+                    <!-- If there's no label, use an invisible character to prevent the header from collapsing -->
+                    <slot name="label"> ${this.label || String.fromCharCode(65279)} </slot>
+                  </span>
+                  <sl-icon-button
+                    exportparts="base:close-button"
+                    class="drawer__close"
+                    name="x"
+                    library="system"
+                    @click=${this.requestClose}
+                  ></sl-icon-button>
+                </header>
+              `
+            : ''}
+
+          <div part="body" class="drawer__body">
+            <slot></slot>
+          </div>
+
+          <footer part="footer" class="drawer__footer">
+            <slot name="footer"></slot>
+          </footer>
+        </div>
+      </div>
+    `;
+  }
+}
+
+// Top
+setDefaultAnimation('drawer.showTop', {
+  keyframes: [
+    { opacity: 0, transform: 'translateY(-100%)' },
+    { opacity: 1, transform: 'translateY(0)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+setDefaultAnimation('drawer.hideTop', {
+  keyframes: [
+    { opacity: 1, transform: 'translateY(0)' },
+    { opacity: 0, transform: 'translateY(-100%)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+// End
+setDefaultAnimation('drawer.showEnd', {
+  keyframes: [
+    { opacity: 0, transform: 'translateX(100%)' },
+    { opacity: 1, transform: 'translateX(0)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+setDefaultAnimation('drawer.hideEnd', {
+  keyframes: [
+    { opacity: 1, transform: 'translateX(0)' },
+    { opacity: 0, transform: 'translateX(100%)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+// Bottom
+setDefaultAnimation('drawer.showBottom', {
+  keyframes: [
+    { opacity: 0, transform: 'translateY(100%)' },
+    { opacity: 1, transform: 'translateY(0)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+setDefaultAnimation('drawer.hideBottom', {
+  keyframes: [
+    { opacity: 1, transform: 'translateY(0)' },
+    { opacity: 0, transform: 'translateY(100%)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+// Start
+setDefaultAnimation('drawer.showStart', {
+  keyframes: [
+    { opacity: 0, transform: 'translateX(-100%)' },
+    { opacity: 1, transform: 'translateX(0)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+setDefaultAnimation('drawer.hideStart', {
+  keyframes: [
+    { opacity: 1, transform: 'translateX(0)' },
+    { opacity: 0, transform: 'translateX(-100%)' }
+  ],
+  options: { duration: 250, easing: 'ease' }
+});
+
+// Deny close
+setDefaultAnimation('drawer.denyClose', {
+  keyframes: [{ transform: 'scale(1)' }, { transform: 'scale(1.01)' }, { transform: 'scale(1)' }],
+  options: { duration: 250 }
+});
+
+// Overlay
+setDefaultAnimation('drawer.overlay.show', {
+  keyframes: [{ opacity: 0 }, { opacity: 1 }],
+  options: { duration: 250 }
+});
+
+setDefaultAnimation('drawer.overlay.hide', {
+  keyframes: [{ opacity: 1 }, { opacity: 0 }],
+  options: { duration: 250 }
+});
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'sl-drawer': SlDrawer;
+  }
+}

data/remote-src/2.0.0.beta64/shoelace-next/src/components/dropdown/dropdown.styles.ts

@@ -0,0 +1,58 @@
+import { css } from 'lit';
+import componentStyles from '../../styles/component.styles';
+
+export default css`
+  ${componentStyles}
+
+  :host {
+    display: inline-block;
+  }
+
+  .dropdown {
+    position: relative;
+  }
+
+  .dropdown__trigger {
+    display: block;
+  }
+
+  .dropdown__positioner {
+    position: absolute;
+    z-index: var(--sl-z-index-dropdown);
+  }
+
+  .dropdown__panel {
+    max-height: 75vh;
+    font-family: var(--sl-font-sans);
+    font-size: var(--sl-font-size-medium);
+    font-weight: var(--sl-font-weight-normal);
+    color: var(--color);
+    background-color: var(--sl-panel-background-color);
+    border: solid var(--sl-panel-border-width) var(--sl-panel-border-color);
+    border-radius: var(--sl-border-radius-medium);
+    box-shadow: var(--sl-shadow-large);
+    overflow: auto;
+    overscroll-behavior: none;
+    pointer-events: none;
+  }
+
+  .dropdown--open .dropdown__panel {
+    pointer-events: all;
+  }
+
+  .dropdown__positioner[data-popper-placement^='top'] .dropdown__panel {
+    transform-origin: bottom;
+  }
+
+  .dropdown__positioner[data-popper-placement^='bottom'] .dropdown__panel {
+    transform-origin: top;
+  }
+
+  .dropdown__positioner[data-popper-placement^='left'] .dropdown__panel {
+    transform-origin: right;
+  }
+
+  .dropdown__positioner[data-popper-placement^='right'] .dropdown__panel {
+    transform-origin: left;
+  }
+`;

data/remote-src/2.0.0.beta64/shoelace-next/src/components/dropdown/dropdown.test.ts

@@ -0,0 +1,147 @@
+import { expect, fixture, html, waitUntil } from '@open-wc/testing';
+import sinon from 'sinon';
+
+import '../../../dist/shoelace.js';
+import type SlDropdown from './dropdown';
+
+describe('<sl-dropdown>', () => {
+  it('should be visible with the open attribute', async () => {
+    const el = await fixture<SlDropdown>(html`
+      <sl-dropdown open>
+        <sl-button slot="trigger" caret>Toggle</sl-button>
+        <sl-menu>
+          <sl-menu-item>Item 1</sl-menu-item>
+          <sl-menu-item>Item 2</sl-menu-item>
+          <sl-menu-item>Item 3</sl-menu-item>
+        </sl-menu>
+      </sl-dropdown>
+    `);
+    const panel = el.shadowRoot?.querySelector('[part="panel"]') as HTMLElement;
+
+    expect(panel.hidden).to.be.false;
+  });
+
+  it('should not be visible without the open attribute', async () => {
+    const el = await fixture<SlDropdown>(html`
+      <sl-dropdown>
+        <sl-button slot="trigger" caret>Toggle</sl-button>
+        <sl-menu>
+          <sl-menu-item>Item 1</sl-menu-item>
+          <sl-menu-item>Item 2</sl-menu-item>
+          <sl-menu-item>Item 3</sl-menu-item>
+        </sl-menu>
+      </sl-dropdown>
+    `);
+    const panel = el.shadowRoot?.querySelector('[part="panel"]') as HTMLElement;
+
+    expect(panel.hidden).to.be.true;
+  });
+
+  it('should emit sl-show and sl-after-show when calling show()', async () => {
+    const el = await fixture<SlDropdown>(html`
+      <sl-dropdown>
+        <sl-button slot="trigger" caret>Toggle</sl-button>
+        <sl-menu>
+          <sl-menu-item>Item 1</sl-menu-item>
+          <sl-menu-item>Item 2</sl-menu-item>
+          <sl-menu-item>Item 3</sl-menu-item>
+        </sl-menu>
+      </sl-dropdown>
+    `);
+    const panel = el.shadowRoot?.querySelector('[part="panel"]') as HTMLElement;
+    const showHandler = sinon.spy();
+    const afterShowHandler = sinon.spy();
+
+    el.addEventListener('sl-show', showHandler);
+    el.addEventListener('sl-after-show', afterShowHandler);
+    el.show();
+
+    await waitUntil(() => showHandler.calledOnce);
+    await waitUntil(() => afterShowHandler.calledOnce);
+
+    expect(showHandler).to.have.been.calledOnce;
+    expect(afterShowHandler).to.have.been.calledOnce;
+    expect(panel.hidden).to.be.false;
+  });
+
+  it('should emit sl-hide and sl-after-hide when calling hide()', async () => {
+    const el = await fixture<SlDropdown>(html`
+      <sl-dropdown open>
+        <sl-button slot="trigger" caret>Toggle</sl-button>
+        <sl-menu>
+          <sl-menu-item>Item 1</sl-menu-item>
+          <sl-menu-item>Item 2</sl-menu-item>
+          <sl-menu-item>Item 3</sl-menu-item>
+        </sl-menu>
+      </sl-dropdown>
+    `);
+    const panel = el.shadowRoot?.querySelector('[part="panel"]') as HTMLElement;
+    const hideHandler = sinon.spy();
+    const afterHideHandler = sinon.spy();
+
+    el.addEventListener('sl-hide', hideHandler);
+    el.addEventListener('sl-after-hide', afterHideHandler);
+    el.hide();
+
+    await waitUntil(() => hideHandler.calledOnce);
+    await waitUntil(() => afterHideHandler.calledOnce);
+
+    expect(hideHandler).to.have.been.calledOnce;
+    expect(afterHideHandler).to.have.been.calledOnce;
+    expect(panel.hidden).to.be.true;
+  });
+
+  it('should emit sl-show and sl-after-show when setting open = true', async () => {
+    const el = await fixture<SlDropdown>(html`
+      <sl-dropdown>
+        <sl-button slot="trigger" caret>Toggle</sl-button>
+        <sl-menu>
+          <sl-menu-item>Item 1</sl-menu-item>
+          <sl-menu-item>Item 2</sl-menu-item>
+          <sl-menu-item>Item 3</sl-menu-item>
+        </sl-menu>
+      </sl-dropdown>
+    `);
+    const panel = el.shadowRoot?.querySelector('[part="panel"]') as HTMLElement;
+    const showHandler = sinon.spy();
+    const afterShowHandler = sinon.spy();
+
+    el.addEventListener('sl-show', showHandler);
+    el.addEventListener('sl-after-show', afterShowHandler);
+    el.open = true;
+
+    await waitUntil(() => showHandler.calledOnce);
+    await waitUntil(() => afterShowHandler.calledOnce);
+
+    expect(showHandler).to.have.been.calledOnce;
+    expect(afterShowHandler).to.have.been.calledOnce;
+    expect(panel.hidden).to.be.false;
+  });
+
+  it('should emit sl-hide and sl-after-hide when setting open = false', async () => {
+    const el = await fixture<SlDropdown>(html`
+      <sl-dropdown open>
+        <sl-button slot="trigger" caret>Toggle</sl-button>
+        <sl-menu>
+          <sl-menu-item>Item 1</sl-menu-item>
+          <sl-menu-item>Item 2</sl-menu-item>
+          <sl-menu-item>Item 3</sl-menu-item>
+        </sl-menu>
+      </sl-dropdown>
+    `);
+    const panel = el.shadowRoot?.querySelector('[part="panel"]') as HTMLElement;
+    const hideHandler = sinon.spy();
+    const afterHideHandler = sinon.spy();
+
+    el.addEventListener('sl-hide', hideHandler);
+    el.addEventListener('sl-after-hide', afterHideHandler);
+    el.open = false;
+
+    await waitUntil(() => hideHandler.calledOnce);
+    await waitUntil(() => afterHideHandler.calledOnce);
+
+    expect(hideHandler).to.have.been.calledOnce;
+    expect(afterHideHandler).to.have.been.calledOnce;
+    expect(panel.hidden).to.be.true;
+  });
+});