@realmorg/ui 0.0.0-stage → 2.0.0-alpha.3

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 RealmOrg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,45 @@
-# Temporary Holding Version
+# @realmorg/ui
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+About 60 accessible components built with [REALM](https://realm.js.org). Each one is a native custom element made of composable parts (such as `<ui-card-header>`) and styled with the design tokens in `theme.css`. Form controls work as native form fields.
+
+Load REALM, the theme and the components from the CDN. There is no build step.
+
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@realmorg/realm@alpha/dist/realm.css">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@realmorg/ui@alpha/dist/theme.css">
+<script type="module" src="https://cdn.jsdelivr.net/npm/@realmorg/realm@alpha/dist/realm.js"></script>
+<import-element from="https://cdn.jsdelivr.net/npm/@realmorg/ui@alpha/dist/ui.html"></import-element>
+
+<ui-card>
+  <ui-card-header>
+    <ui-card-title>Create project</ui-card-title>
+    <ui-card-description>Deploy in one click.</ui-card-description>
+  </ui-card-header>
+  <ui-card-content>
+    <ui-field>
+      <ui-label for="name">Name</ui-label>
+      <ui-input id="name" name="name"></ui-input>
+    </ui-field>
+  </ui-card-content>
+  <ui-card-footer justify="end"><ui-button>Create</ui-button></ui-card-footer>
+</ui-card>
+```
+
+To load only what you use, import single files instead of `ui.html`:
+
+```html
+<import-element from="https://cdn.jsdelivr.net/npm/@realmorg/ui@alpha/components/button.html"></import-element>
+<import-element from="https://cdn.jsdelivr.net/npm/@realmorg/ui@alpha/components/card.html"></import-element>
+```
+
+Each file imports its own dependencies (`sheet.html` loads `dialog.html`), and each file is fetched once.
+
+- `dist/ui.html` holds every component in one file.
+- `components/*.html` holds one component per file. Import a file on its own, or copy it into your project and edit it.
+- `dist/theme.css` defines the colour, spacing, radius, shadow and type tokens, with a dark theme.
+
+Docs and live demos for each component are at [realm.js.org/components](https://realm.js.org/components/).
+
+## License
+
+MIT

package/components/accordion.html

@@ -0,0 +1,139 @@
+<custom-element name="ui-accordion">
+  <script>
+    const props = defineProps({
+      type: prop.enum(["single", "multiple"]).default("single"),
+    });
+
+    listen("toggle", (event) => {
+      const item = event.target;
+      if (props.type !== "single" || item.localName !== "ui-accordion-item" || !item.open) return;
+      for (const other of host.querySelectorAll("ui-accordion-item")) {
+        if (other !== item && other.open) other.open = false;
+      }
+    });
+  </script>
+
+  <style>
+    /* A double tap must not zoom the page. Set inside the shadow root, because a page-level
+       touch-action does not reach shadow content in iOS Safari. */
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-accordion-item">
+  <script>
+    const props = defineProps({
+      open: prop.boolean().reflect(),
+      disabled: prop.boolean(),
+    });
+
+    function toggled(details) {
+      if (details.open === props.open) return;
+      props.open = details.open;
+      dispatch("toggle");
+    }
+
+    function guard() {
+      return !props.disabled;
+    }
+  </script>
+
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+      border-bottom: 1px solid var(--border);
+    }
+    :host(:last-of-type) {
+      border-bottom: 0;
+    }
+    summary {
+      display: flex;
+      align-items: flex-start;
+      justify-content: space-between;
+      gap: calc(var(--spacing) * 4);
+      padding: calc(var(--spacing) * 4) 0;
+      border-radius: var(--radius-md);
+      font-size: var(--text-sm);
+      font-weight: var(--font-weight-medium);
+      list-style: none;
+      cursor: pointer;
+      outline: none;
+    }
+    summary::-webkit-details-marker {
+      display: none;
+    }
+    summary:hover {
+      text-decoration: underline;
+    }
+    summary:focus-visible {
+      box-shadow: var(--focus-ring);
+    }
+    :host(:state(attr-disabled)) summary {
+      pointer-events: none;
+      opacity: 0.5;
+    }
+    svg {
+      flex-shrink: 0;
+      width: calc(var(--spacing) * 4);
+      height: calc(var(--spacing) * 4);
+      color: var(--muted-foreground);
+      transition: rotate 0.2s;
+    }
+    details[open] svg {
+      rotate: 180deg;
+    }
+  </style>
+
+  <details _open="@open" ontoggle="toggled(this)">
+    <summary part="summary" onclick="return guard()">
+      <slot name="trigger"></slot>
+      <svg aria-hidden="true" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m6 9 6 6 6-6" /></svg>
+    </summary>
+    <slot></slot>
+  </details>
+</custom-element>
+
+<custom-element name="ui-accordion-trigger" slot="trigger">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: flex;
+      flex: 1;
+      align-items: center;
+      gap: calc(var(--spacing) * 2);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-accordion-content">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+      padding-bottom: calc(var(--spacing) * 4);
+      font-size: var(--text-sm);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>

package/components/alert-dialog.html

@@ -0,0 +1,236 @@
+<import-element from="./button.html"></import-element>
+
+<custom-element name="ui-alert-dialog">
+  <script>
+    const props = defineProps({ open: prop.boolean().reflect() });
+
+    const parts = useChildren("ui-alert-dialog-header, ui-alert-dialog-title, ui-alert-dialog-description");
+    const alert = useState({
+      get label() {
+        return text("ui-alert-dialog-title");
+      },
+      get description() {
+        return text("ui-alert-dialog-description");
+      },
+    });
+
+    function text(selector) {
+      const found = parts.flatMap((part) => (part.matches(selector) ? [part] : [...part.querySelectorAll(selector)]));
+      return found.map((part) => part.textContent.trim()).join(" ") || null;
+    }
+
+    function show() {
+      props.open = true;
+    }
+
+    function showFrom(trigger) {
+      trigger.firstElementChild?.focus();
+      show();
+    }
+
+    function close(value) {
+      if (value !== undefined) refs.dialog.returnValue = String(value);
+      props.open = false;
+    }
+
+    function closed() {
+      if (refs.dialog.open) return;
+      props.open = false;
+      dispatch("close", undefined, { bubbles: false, composed: false });
+    }
+
+    defineMethods({
+      showModal: show,
+      show,
+      close,
+      get returnValue() {
+        return refs.dialog.returnValue;
+      },
+    });
+
+    const COMMANDS = { "show-modal": show, close: () => close(), "request-close": () => close() };
+
+    listen("command", (event) => COMMANDS[event.command.replace(/^--/, "")]?.());
+
+    observe(() => {
+      const dialog = refs.dialog;
+      if (!dialog || props.open === dialog.open) return;
+      if (props.open) dialog.showModal();
+      else dialog.close();
+    });
+  </script>
+
+  <style>
+    /* A double tap must not zoom the page. Set inside the shadow root, because a page-level
+       touch-action does not reach shadow content in iOS Safari. */
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: contents;
+    }
+    dialog {
+      box-sizing: border-box;
+      width: 100%;
+      max-width: min(calc(var(--spacing) * 128), calc(100% - calc(var(--spacing) * 8)));
+      /* See ui-dialog: an explicit height keeps it from stretching, svh from resizing on scroll. */
+      height: fit-content;
+      max-height: calc(100svh - calc(var(--spacing) * 8));
+      overflow: auto;
+      padding: calc(var(--spacing) * 6);
+      border: 1px solid var(--border);
+      border-radius: var(--radius-lg);
+      background: var(--background);
+      color: var(--foreground);
+      box-shadow: var(--shadow-lg);
+    }
+    dialog[open] {
+      display: grid;
+      /* Safari stretches a grid overlay to its max-height unless the rows are packed at the start. */
+      align-content: start;
+      gap: calc(var(--spacing) * 4);
+    }
+    dialog::backdrop {
+      background: rgb(0 0 0 / 0.5);
+    }
+  </style>
+
+  <slot name="trigger"></slot>
+  <dialog
+    ref="dialog"
+    part="dialog"
+    role="alertdialog"
+    _aria-label="#alert.label"
+    _aria-description="#alert.description"
+    onclose="closed()"
+    oncancel="event.preventDefault()">
+    <slot name="header"></slot>
+    <slot></slot>
+    <slot name="footer"></slot>
+  </dialog>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-trigger" slot="trigger">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host,
+    span {
+      display: contents;
+    }
+  </style>
+
+  <span part="trigger" onclick="showFrom(host)"><slot></slot></span>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-header" slot="header">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: grid;
+      gap: calc(var(--spacing) * 2);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-title">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+    }
+    h2 {
+      margin: 0;
+      font-size: var(--text-lg);
+      font-weight: var(--font-weight-semibold);
+    }
+  </style>
+
+  <h2 part="title"><slot></slot></h2>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-description">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+    }
+    p {
+      margin: 0;
+      font-size: var(--text-sm);
+      color: var(--muted-foreground);
+    }
+  </style>
+
+  <p part="description"><slot></slot></p>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-footer" slot="footer">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: flex;
+      flex-wrap: wrap;
+      justify-content: flex-end;
+      gap: calc(var(--spacing) * 2);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-action">
+  <script>
+    const props = defineProps({
+      value: prop.string().default("action"),
+      variant: prop.enum(["default", "destructive"]).default("default"),
+    });
+  </script>
+
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: inline-flex;
+    }
+  </style>
+
+  <ui-button part="button" _variant="@variant" onclick="close(props.value)"><slot></slot></ui-button>
+</custom-element>
+
+<custom-element name="ui-alert-dialog-cancel">
+  <script>
+    const props = defineProps({ value: prop.string().default("cancel") });
+  </script>
+
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: inline-flex;
+    }
+  </style>
+
+  <ui-button part="button" variant="outline" onclick="close(props.value)"><slot></slot></ui-button>
+</custom-element>

package/components/alert.html

@@ -0,0 +1,83 @@
+<custom-element name="ui-alert" role="alert">
+  <script>
+    defineProps({
+      variant: prop.enum(["default", "destructive"]).default("default"),
+    });
+  </script>
+
+  <style>
+    /* A double tap must not zoom the page. Set inside the shadow root, because a page-level
+       touch-action does not reach shadow content in iOS Safari. */
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      position: relative;
+      display: grid;
+      grid-template-columns: auto 1fr;
+      row-gap: calc(var(--spacing) * 0.5);
+      align-items: start;
+      width: 100%;
+      box-sizing: border-box;
+      padding: calc(var(--spacing) * 3) calc(var(--spacing) * 4);
+      border: 1px solid var(--border);
+      border-radius: var(--radius-lg);
+      background: var(--card);
+      color: var(--card-foreground);
+      font-size: var(--text-sm);
+    }
+    :host(:state(attr-variant-is-destructive)) {
+      color: var(--destructive);
+    }
+    ::slotted(svg) {
+      width: calc(var(--spacing) * 4);
+      height: calc(var(--spacing) * 4);
+      margin-inline-end: calc(var(--spacing) * 3);
+      translate: 0 calc(var(--spacing) * 0.5);
+      grid-row: span 2;
+    }
+    ::slotted(:not(svg)) {
+      grid-column: 2;
+    }
+    :host(:state(attr-variant-is-destructive)) ::slotted(ui-alert-description) {
+      color: color-mix(in oklab, var(--destructive) 90%, transparent);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-alert-title">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+      min-height: calc(var(--spacing) * 4);
+      font-weight: var(--font-weight-medium);
+      letter-spacing: -0.01em;
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-alert-description">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: grid;
+      justify-items: start;
+      gap: calc(var(--spacing) * 1);
+      color: var(--muted-foreground);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>

package/components/aspect-ratio.html

@@ -0,0 +1,29 @@
+<custom-element name="ui-aspect-ratio">
+  <script>
+    defineProps({ ratio: prop.string().default("16 / 9") });
+  </script>
+
+  <style>
+    /* A double tap must not zoom the page. Set inside the shadow root, because a page-level
+       touch-action does not reach shadow content in iOS Safari. */
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: block;
+      position: relative;
+      aspect-ratio: var(--attr-ratio);
+      overflow: hidden;
+    }
+    ::slotted(img),
+    ::slotted(video),
+    ::slotted(iframe) {
+      width: 100%;
+      height: 100%;
+      object-fit: cover;
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>

package/components/attachment.html

@@ -0,0 +1,98 @@
+<custom-element name="ui-attachment">
+  <script>
+    defineProps({ name: prop.string(), size: prop.string(), href: prop.string() });
+  </script>
+
+  <style>
+    /* A double tap must not zoom the page. Set inside the shadow root, because a page-level
+       touch-action does not reach shadow content in iOS Safari. */
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: inline-flex;
+      align-items: center;
+      gap: calc(var(--spacing) * 2);
+      max-width: 100%;
+      min-width: 0;
+      padding: calc(var(--spacing) * 2) calc(var(--spacing) * 2.5);
+      border: 1px solid var(--border);
+      border-radius: var(--radius-xl);
+      background: var(--card);
+      color: var(--card-foreground);
+      font-size: var(--text-sm);
+    }
+    :host(:focus-within) {
+      box-shadow: 0 0 0 1px var(--ring);
+    }
+    .content {
+      display: grid;
+      min-width: 0;
+    }
+    .title {
+      overflow: hidden;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+      font-weight: var(--font-weight-medium);
+      color: inherit;
+      text-decoration: none;
+    }
+    .size {
+      font-size: var(--text-xs);
+      color: var(--muted-foreground);
+    }
+  </style>
+
+  <slot name="media"></slot>
+  <div class="content" part="content">
+    <a class="title" part="title" _href="@href" _download="@name"><slot name="@name"></slot></a>
+    <span class="size" _hidden="!@size"><slot name="@size"></slot></span>
+  </div>
+  <slot name="actions"></slot>
+</custom-element>
+
+<custom-element name="ui-attachment-media" slot="media">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: grid;
+      place-content: center;
+      flex-shrink: 0;
+      width: calc(var(--spacing) * 8);
+      height: calc(var(--spacing) * 8);
+      overflow: hidden;
+      border-radius: var(--radius-md);
+      background: var(--muted);
+    }
+    ::slotted(svg) {
+      width: calc(var(--spacing) * 4);
+      height: calc(var(--spacing) * 4);
+    }
+    ::slotted(img) {
+      width: calc(var(--spacing) * 8);
+      height: calc(var(--spacing) * 8);
+      object-fit: cover;
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>
+
+<custom-element name="ui-attachment-actions" slot="actions">
+  <style>
+    :host,
+    * {
+      touch-action: manipulation;
+    }
+    :host {
+      display: flex;
+      gap: calc(var(--spacing) * 1);
+    }
+  </style>
+
+  <slot></slot>
+</custom-element>