@cardstack/boxel-cli 0.11.0-unstable.1 → 0.11.0-unstable.3

package/bundled-realms/pretui/components/quick-look.gts

@@ -0,0 +1,377 @@
+// Pretui — QuickLook: a sheet that shows a card or file over the transcript, with a way to open it properly.
+import Component from '@glimmer/component';
+import { on } from '@ember/modifier';
+import { guidFor } from '@ember/object/internals';
+import { modifier } from 'ember-modifier';
+import { motion } from 'glimmer-motion';
+import XIcon from '@cardstack/boxel-icons/x';
+import { IconButton } from './icon-button';
+
+// ── QuickLook ────────────────────────────────────────────────────────────
+// A look before a commitment: the reader clicks a card or a file in the
+// transcript and sees it here, over the transcript, without leaving the
+// conversation. The bar says what it is (its kind, quietly, and its title)
+// and offers the way to open it properly; Escape, Space (when the card has
+// nothing to scroll), the close button and a click on the backdrop all put
+// it away.
+//
+// It is modal: Tab cycles inside the sheet, and while it is open everything
+// beside it in its parent is `inert`, so render it as a direct child of the
+// region it covers (the transcript and the composer are then out of reach).
+// Keys are handled on the sheet as they bubble, so a control inside the card
+// (a dropdown in an edit-format card) takes its own Escape first.
+//
+// Presentational only. Whether it is open is the caller's state: render it
+// to open it, stop rendering it to close it. It never waits on an animation
+// and never keeps a "closing" state of its own (ADR 007 §1.1).
+//
+// Motion is declared, not performed: the sheet and the backdrop carry
+// `{{motion id= role=}}` so a Choreo region around them can fly the sheet
+// out of whatever opened it and fade the backdrop. Outside a region the
+// declaration does nothing and the sheet simply appears.
+
+export interface QuickLookSignature {
+  Args: {
+    /** the card's or the file's title: the sheet's accessible name */
+    title: string;
+    /** what it is, said quietly before the title: 'Tea lot', 'PNG image' */
+    kind?: string;
+    /** put it away: Escape, Space, the close button, the backdrop */
+    onClose: () => void;
+    /** the close button's name (default 'Close') */
+    closeLabel?: string;
+    /** where focus goes when it closes. Default: whatever had focus when
+     * it opened, the pill or embed that opened it */
+    returnFocusTo?: HTMLElement | null;
+  };
+  Blocks: {
+    /** the bar's actions: Open (the one primary action), Open in code */
+    actions: [];
+    /** the card or the file; it scrolls in its own box */
+    default: [];
+  };
+  Element: HTMLDivElement;
+}
+
+// Space closes only when it would not do something else: typing a space,
+// pressing a focused button or link, or toggling a control inside the card.
+const SPACE_KEEPERS =
+  'input, textarea, select, button, a[href], summary, label, [contenteditable=""], [contenteditable="true"], [role="button"], [role="checkbox"], [role="radio"], [role="switch"], [role="textbox"], [role="combobox"], [role="slider"], [role="menuitem"], [role="option"], [role="tab"], [role="treeitem"], [role="gridcell"]';
+
+// What Tab can land on, before the tabindex and visibility checks.
+const TABBABLE =
+  'a[href], area[href], button, input, select, textarea, summary, iframe, audio[controls], video[controls], [contenteditable=""], [contenteditable="true"], [tabindex]';
+
+function tabbablesIn(root: HTMLElement): HTMLElement[] {
+  return [...root.querySelectorAll<HTMLElement>(TABBABLE)].filter(
+    (el) =>
+      el.tabIndex >= 0 &&
+      !(el as HTMLButtonElement).disabled &&
+      !(el instanceof HTMLInputElement && el.type === 'hidden') &&
+      !el.closest('[inert]') &&
+      el.getClientRects().length > 0,
+  );
+}
+
+export class QuickLook extends Component<QuickLookSignature> {
+  private guid = guidFor(this);
+
+  get titleId(): string {
+    return this.guid + '-title';
+  }
+  get closeLabel(): string {
+    return this.args.closeLabel ?? 'Close';
+  }
+
+  close = () => {
+    this.args.onClose();
+  };
+
+  private sheet: HTMLElement | undefined;
+  private body: HTMLElement | undefined;
+
+  /** Tab wraps between the sheet's first and last tabbable elements. */
+  private trapTab(ev: KeyboardEvent) {
+    let sheet = this.sheet;
+    if (!sheet) {
+      return;
+    }
+    let stops = tabbablesIn(sheet);
+    let first = stops[0];
+    let last = stops[stops.length - 1];
+    let active = document.activeElement;
+    if (!first || !last) {
+      ev.preventDefault();
+      sheet.focus({ preventScroll: true });
+      return;
+    }
+    if (ev.shiftKey && (active === first || active === sheet)) {
+      ev.preventDefault();
+      last.focus();
+    } else if (!ev.shiftKey && active === last) {
+      ev.preventDefault();
+      first.focus();
+    }
+  }
+
+  /** the card is taller than its box: Space pages it rather than closing */
+  private get bodyScrolls(): boolean {
+    let body = this.body;
+    return Boolean(body && body.scrollHeight > body.clientHeight + 1);
+  }
+
+  /** Tab stays in the sheet. Escape closes, unless something inside the
+   * card already used it; Space closes when focus is not somewhere a space
+   * means something else and the card has nothing to scroll. Every key the
+   * sheet uses stops here, so a host's document-level handler does not
+   * also run. */
+  onKey = (event: Event) => {
+    let ev = event as KeyboardEvent;
+    if (ev.isComposing) {
+      return;
+    }
+    if (ev.key === 'Tab') {
+      this.trapTab(ev);
+      return;
+    }
+    if (ev.defaultPrevented) {
+      return;
+    }
+    if (ev.key === 'Escape') {
+      ev.preventDefault();
+      ev.stopPropagation();
+      this.close();
+      return;
+    }
+    if (ev.key === ' ' || ev.key === 'Spacebar') {
+      let target = ev.target as Element | null;
+      if (target instanceof Element && target.closest(SPACE_KEEPERS)) {
+        return;
+      }
+      if (this.bodyScrolls) {
+        // focus inside the card: the browser pages it. Focus on the sheet
+        // itself: the card's box is not its scroller, so page it here
+        if (target === this.sheet && this.body) {
+          ev.preventDefault();
+          ev.stopPropagation();
+          let page = this.body.clientHeight * 0.875;
+          this.body.scrollBy({ top: ev.shiftKey ? -page : page });
+        }
+        return;
+      }
+      ev.preventDefault();
+      ev.stopPropagation();
+      this.close();
+    }
+  };
+
+  private registerBody = modifier((body: HTMLElement) => {
+    this.body = body;
+    return () => (this.body = undefined);
+  });
+
+  /** Everything beside the sheet in its parent is inert while it is open;
+   * what was already inert is left as it was. */
+  private inertBehind = modifier((root: HTMLElement) => {
+    let made: HTMLElement[] = [];
+    for (let sibling of root.parentElement?.children ?? []) {
+      if (
+        sibling !== root &&
+        sibling instanceof HTMLElement &&
+        !sibling.inert
+      ) {
+        sibling.inert = true;
+        made.push(sibling);
+      }
+    }
+    return () => {
+      for (let el of made) {
+        el.inert = false;
+      }
+    };
+  });
+
+  /** Focus moves into the sheet when it is rendered, and back to what
+   * opened it when it is torn down: on the state change, never at the end
+   * of an animation (ADR 007 §1.5). */
+  private focusIn = modifier(
+    (sheet: HTMLElement, [returnTo]: [HTMLElement | null | undefined]) => {
+      this.sheet = sheet;
+      let previous =
+        returnTo ??
+        (document.activeElement instanceof HTMLElement
+          ? document.activeElement
+          : null);
+      sheet.focus({ preventScroll: true });
+      return () => {
+        this.sheet = undefined;
+        let active = document.activeElement;
+        let focusWasHere =
+          !active || active === document.body || sheet.contains(active);
+        if (focusWasHere && previous?.isConnected) {
+          previous.focus({ preventScroll: true });
+        }
+      };
+    },
+  );
+
+  <template>
+    <div class='pretui-quick-look' {{this.inertBehind}} data-test-pretui-quick-look>
+      {{! the backdrop is a pointer target only: the close button is the
+          keyboard's way out, so it stays out of the tab order and the tree }}
+      {{! template-lint-disable no-invalid-interactive }}
+      <div
+        class='pretui-quick-look-backdrop'
+        aria-hidden='true'
+        {{motion id='quick-look-backdrop' role='quick-look-backdrop'}}
+        {{on 'click' this.close}}
+        data-test-pretui-quick-look-backdrop
+      ></div>
+      <div
+        class='pretui-quick-look-sheet'
+        role='dialog'
+        aria-modal='true'
+        aria-labelledby={{this.titleId}}
+        tabindex='-1'
+        {{on 'keydown' this.onKey}}
+        {{motion id='quick-look' role='quick-look'}}
+        {{this.focusIn @returnFocusTo}}
+        data-test-pretui-quick-look-sheet
+        ...attributes
+      >
+        <div class='pretui-quick-look-bar'>
+          <div class='pretui-quick-look-heading'>
+            {{#if @kind}}
+              <span
+                class='pretui-quick-look-kind'
+                data-test-pretui-quick-look-kind
+              >{{@kind}}</span>
+            {{/if}}
+            <h2
+              id={{this.titleId}}
+              class='pretui-quick-look-title'
+              title={{@title}}
+              data-test-pretui-quick-look-title
+            >{{@title}}</h2>
+          </div>
+          <div
+            class='pretui-quick-look-actions'
+            data-test-pretui-quick-look-actions
+          >
+            {{yield to='actions'}}
+          </div>
+          <IconButton
+            class='pretui-quick-look-close'
+            @label={{this.closeLabel}}
+            @icon={{XIcon}}
+            @tone='neutral'
+            @appearance='plain'
+            @size='s'
+            {{on 'click' this.close}}
+            data-test-pretui-quick-look-close
+          />
+        </div>
+        <div
+          class='pretui-quick-look-body'
+          {{this.registerBody}}
+          data-test-pretui-quick-look-body
+        >
+          {{yield}}
+        </div>
+      </div>
+    </div>
+    <style scoped>
+      @layer PretComponent {
+        .pretui-quick-look {
+          position: absolute;
+          inset: 0;
+          z-index: var(--pretui-quick-look-z, 20);
+        }
+        .pretui-quick-look-backdrop {
+          position: absolute;
+          inset: 0;
+          background-color: var(
+            --pretui-scrim,
+            color-mix(in oklch, var(--background) 55%, transparent)
+          );
+        }
+        .pretui-quick-look-sheet {
+          position: absolute;
+          inset: var(
+            --pretui-quick-look-inset,
+            var(--boxel-sp-3xl) var(--boxel-sp-sm) var(--boxel-sp-sm)
+          );
+          display: flex;
+          flex-direction: column;
+          min-height: 0;
+          overflow: hidden;
+          border-radius: var(--boxel-border-radius-lg);
+          background-color: var(--card);
+          color: var(--card-foreground);
+          box-shadow:
+            var(--pretui-shadow-hairline, 0 0 0 1px var(--border)),
+            var(--pretui-shadow-overlay, var(--shadow-lg));
+        }
+        .pretui-quick-look-sheet:focus {
+          outline: none;
+        }
+        .pretui-quick-look-sheet:focus-visible {
+          box-shadow:
+            0 0 0 2px var(--ring),
+            var(--pretui-shadow-overlay, var(--shadow-lg));
+        }
+        .pretui-quick-look-bar {
+          display: flex;
+          align-items: center;
+          gap: var(--boxel-sp-xs);
+          min-height: var(--boxel-sp-3xl);
+          padding: var(--boxel-sp-xs) var(--boxel-sp-xs) var(--boxel-sp-xs)
+            var(--boxel-sp);
+          border-bottom: 1px solid var(--border);
+        }
+        .pretui-quick-look-heading {
+          display: flex;
+          flex-direction: column;
+          flex: 1;
+          min-width: 0;
+        }
+        .pretui-quick-look-kind {
+          font-size: var(--boxel-caption-font-size);
+          line-height: var(--boxel-caption-line-height);
+          color: var(--subtle-foreground);
+          overflow: hidden;
+          white-space: nowrap;
+          text-overflow: ellipsis;
+        }
+        .pretui-quick-look-title {
+          margin: 0;
+          font-size: var(--boxel-ui-label-font-size);
+          line-height: var(--boxel-ui-label-line-height);
+          font-weight: 600;
+          overflow: hidden;
+          white-space: nowrap;
+          text-overflow: ellipsis;
+        }
+        .pretui-quick-look-actions {
+          display: flex;
+          align-items: center;
+          gap: var(--boxel-sp-xs);
+          flex-shrink: 0;
+        }
+        .pretui-quick-look-actions:empty {
+          display: none;
+        }
+        .pretui-quick-look-close {
+          flex-shrink: 0;
+          color: var(--muted-foreground);
+        }
+        .pretui-quick-look-body {
+          flex: 1;
+          min-height: 0;
+          overflow: auto;
+          overscroll-behavior: contain;
+        }
+      }
+    </style>
+  </template>
+}

package/bundled-realms/pretui/components/reactions.gts

@@ -0,0 +1,136 @@
+// Pretui — Reactions: who reacted to a message or a call, as small pills under it.
+import Component from '@glimmer/component';
+import { on } from '@ember/modifier';
+import { fn } from '@ember/helper';
+
+export interface Reaction {
+  /** the emoji: '👍', '👎', '🎉' */
+  key: string;
+  /** who reacted, in order, as the room names them */
+  by: string[];
+  /** the reader is among them: the pill is pressed */
+  mine?: boolean;
+}
+
+export interface ReactionsSignature {
+  Args: {
+    reactions: Reaction[];
+    /** toggle the reader's own reaction; omit and the pills only show */
+    onToggle?: (key: string) => void;
+    /** what the reactions are on, for the group's name: 'the read' */
+    subject?: string;
+  };
+  Element: HTMLDivElement;
+}
+
+/**
+ * "👍 Chris" under the thing it answers, the way a chat shows a reaction:
+ * the content stays as it was, and the pill says who. Two names show, then
+ * "+N"; every name is in the pill's title and its accessible name. With
+ * `@onToggle` a pill is a pressed toggle for the reader's own reaction.
+ */
+export class Reactions extends Component<ReactionsSignature> {
+  names = (reaction: Reaction): string => {
+    let [a, b, ...rest] = reaction.by;
+    let shown = [a, b].filter(Boolean).join(', ');
+    return rest.length ? `${shown} +${rest.length}` : shown;
+  };
+  label = (reaction: Reaction): string =>
+    `${reaction.key} by ${reaction.by.join(', ')}`;
+  toggle = (key: string) => this.args.onToggle?.(key);
+  get groupLabel(): string {
+    return this.args.subject
+      ? `Reactions to ${this.args.subject}`
+      : 'Reactions';
+  }
+  <template>
+    <div
+      class='pretui-reactions'
+      role='group'
+      aria-label={{this.groupLabel}}
+      data-test-pretui-reactions
+      ...attributes
+    >
+      {{#each @reactions as |reaction|}}
+        {{#if @onToggle}}
+          <button
+            type='button'
+            class='pretui-reaction'
+            aria-pressed={{if reaction.mine 'true' 'false'}}
+            aria-label={{this.label reaction}}
+            title={{this.label reaction}}
+            {{on 'click' (fn this.toggle reaction.key)}}
+            data-test-pretui-reaction={{reaction.key}}
+          ><span
+              class='pretui-reaction-key'
+              aria-hidden='true'
+            >{{reaction.key}}</span><span
+              class='pretui-reaction-by'
+              aria-hidden='true'
+            >{{this.names reaction}}</span></button>
+        {{else}}
+          <span
+            class='pretui-reaction'
+            data-mine={{if reaction.mine 'true'}}
+            role='img'
+            aria-label={{this.label reaction}}
+            title={{this.label reaction}}
+            data-test-pretui-reaction={{reaction.key}}
+          ><span
+              class='pretui-reaction-key'
+              aria-hidden='true'
+            >{{reaction.key}}</span><span
+              class='pretui-reaction-by'
+              aria-hidden='true'
+            >{{this.names reaction}}</span></span>
+        {{/if}}
+      {{/each}}
+    </div>
+    <style scoped>
+      @layer PretComponent {
+        .pretui-reactions {
+          display: flex;
+          flex-wrap: wrap;
+          gap: var(--boxel-sp-4xs);
+        }
+        .pretui-reaction {
+          display: inline-flex;
+          align-items: center;
+          gap: var(--boxel-sp-4xs);
+          /* the least a pointer target takes */
+          height: 1.5rem;
+          padding: 0 var(--boxel-sp-xs) 0 var(--boxel-sp-2xs);
+          border: 0;
+          border-radius: var(--boxel-border-radius-pill);
+          background-color: var(--muted);
+          box-shadow: inset 0 0 0 1px var(--border);
+          font-family: inherit;
+          font-size: var(--boxel-font-size-xs);
+          font-weight: 500;
+          line-height: 1;
+          color: var(--muted-foreground);
+        }
+        .pretui-reaction-key {
+          font-size: var(--boxel-font-size-xs);
+        }
+        .pretui-reaction[data-mine],
+        .pretui-reaction[aria-pressed='true'] {
+          background-color: color-mix(in oklch, var(--primary) 14%, var(--card));
+          box-shadow: inset 0 0 0 1px
+            color-mix(in oklch, var(--primary) 45%, transparent);
+          color: var(--foreground);
+        }
+        button.pretui-reaction {
+          cursor: pointer;
+        }
+        button.pretui-reaction:hover {
+          color: var(--foreground);
+        }
+        button.pretui-reaction:focus-visible {
+          outline: 2px solid var(--ring);
+          outline-offset: 1px;
+        }
+      }
+    </style>
+  </template>
+}