@thatopen/services 0.2.0 → 0.3.0

package/src/built-in/UIManager/src/app/examples/Modal/example.ts

@@ -0,0 +1,165 @@
+/* MD
+  ## Confirmation modals with top:modal
+  ---
+  Destructive or irreversible actions — deleting records, overwriting files,
+  leaving unsaved changes — should ask the user to confirm before proceeding.
+  Opening a custom dialog element from a deeply nested component means threading
+  a reference to a controller up through every layer of the tree.
+
+  top-app provides a modal slot that any descendant can trigger by dispatching
+  a single DOM event. The modal blocks the UI, shows a configurable message and
+  action labels, and calls back into the originating component when the user
+  confirms or cancels — no reference to the root element required.
+
+  This tutorial covers showing a modal from a child component by dispatching
+  top:modal; setting the label, icon, and button labels; running an async
+  confirm handler while the modal shows a loading spinner; and handling the
+  cancel path without side effects.
+
+  By the end, you'll have an app where a panel can trigger confirmation dialogs
+  for actions of varying severity, each with its own copy and async behaviour.
+*/
+
+import { html, LitElement } from "lit";
+import { customElement, state } from "lit/decorators.js";
+import * as THREE from "three";
+import * as OBC from "@thatopen/components";
+import * as OBF from "@thatopen/components-front";
+import * as FRAGS from "@thatopen/fragments";
+import * as BUI from "@thatopen/ui";
+import { PlatformClient } from "thatopen-services";
+import uiManagerDef from "../../../../index";
+import type { App } from "../../index";
+
+// A child component that triggers modals without holding a reference to top-app.
+// It dispatches top:modal and receives the result via onConfirm / onCancel callbacks.
+@customElement("modal-actions")
+class ModalActions extends LitElement {
+  @state() private _lastAction = "—";
+
+  private _confirmDelete() {
+    // top:modal opens a blocking dialog on the nearest top-app ancestor.
+    // The modal stays open (with a loading spinner) while onConfirm is awaited.
+    this.dispatchEvent(
+      new CustomEvent("top:modal", {
+        bubbles: true,
+        composed: true,
+        detail: {
+          label: "Delete model",
+          icon: "tabler:trash",
+          confirmLabel: "Delete",
+          cancelLabel: "Keep",
+          content: html`
+            <bim-label style="white-space:normal;">
+              This will permanently remove the model and all its versions.
+              This action cannot be undone.
+            </bim-label>
+          `,
+          onConfirm: async () => {
+            // Simulate an async delete operation.
+            // The modal shows a loading spinner until this promise resolves.
+            await new Promise<void>((resolve) => setTimeout(resolve, 1500));
+            this._lastAction = "Model deleted";
+          },
+          onCancel: () => {
+            this._lastAction = "Delete cancelled";
+          },
+        },
+      }),
+    );
+  }
+
+  private _confirmOverwrite() {
+    this.dispatchEvent(
+      new CustomEvent("top:modal", {
+        bubbles: true,
+        composed: true,
+        detail: {
+          label: "File already exists",
+          icon: "tabler:alert-triangle",
+          confirmLabel: "Overwrite",
+          cancelLabel: "Cancel",
+          content: html`
+            <bim-label style="white-space:normal;">
+              A file named <strong>structure.ifc</strong> already exists in this
+              folder. Uploading will create a new version alongside it.
+            </bim-label>
+          `,
+          // onConfirm can be synchronous too — the modal closes immediately.
+          onConfirm: () => {
+            this._lastAction = "Overwrite confirmed";
+          },
+          onCancel: () => {
+            this._lastAction = "Overwrite cancelled";
+          },
+        },
+      }),
+    );
+  }
+
+  render() {
+    return html`
+      <bim-panel label="Modal Actions">
+        <bim-panel-section label="Actions" icon="tabler:click">
+          <bim-button
+            label="Delete model (async confirm)"
+            icon="tabler:trash"
+            @click=${this._confirmDelete}
+          ></bim-button>
+          <bim-button
+            label="Overwrite file (sync confirm)"
+            icon="tabler:file-upload"
+            @click=${this._confirmOverwrite}
+          ></bim-button>
+          <bim-label>Last action: ${this._lastAction}</bim-label>
+        </bim-panel-section>
+      </bim-panel>
+    `;
+  }
+}
+
+// ---- app wiring ----
+
+const UIManager = uiManagerDef.componentDefinition;
+const client = PlatformClient.fromPlatformContext();
+const { components } = (await client.setup(
+  { OBC, OBF, BUI, THREE, FRAGS },
+  { uuid: UIManager.uuid },
+)) as { components: OBC.Components };
+components.get(UIManager).init();
+
+const app = document.createElement("top-app") as unknown as App;
+
+app.setup = (waitUntil) => {
+  waitUntil(
+    (async () => {
+      const fragments = components.get(OBC.FragmentsManager);
+      const workerUrl = await FRAGS.FragmentsModels.getWorker();
+      fragments.init(await FRAGS.toClassicWorker(workerUrl), {
+        classicWorker: true,
+      });
+    })(),
+    "Fragments Core",
+  );
+  return { components, client };
+};
+
+app.elements = {
+  viewer: () =>
+    html`<top-viewer><top-viewer-tools></top-viewer-tools></top-viewer>`,
+  panel: () => html`<modal-actions></modal-actions>`,
+};
+
+app.base = "viewer";
+app.layouts = {
+  main: {
+    label: "Main",
+    icon: "solar:home-bold",
+    template: `"panel" 1fr / 22rem`,
+  },
+};
+app.layout = "main";
+
+const container = document.getElementById("that-open-app") ?? document.body;
+container.appendChild(app);
+document.body.style.margin = "0";

package/src/built-in/UIManager/src/app/examples/Notifications/example.ts

@@ -1,161 +1,135 @@
-/* MD
-  ## Toasts, file drop, and cross-component notifications
-  ---
-  Developers building BIM processing UIs need to surface status updates, errors,
-  and file-drop feedback to users from different points in the component tree —
-  but reaching back to the app root to trigger a notification from a deeply nested
-  component requires threading a reference through every layer in between.
-
-  top-app provides a built-in toast system that any descendant can trigger by
-  dispatching a standard DOM event, a drag-and-drop overlay that activates
-  automatically when files enter the window, and a drop-zone message that can be
-  computed from live state at render time rather than set once at initialization.
-
-  This tutorial covers showing a success toast when the app finishes booting;
-  building a component that dispatches notification events to report async progress
-  and completion without a reference to the root; handling dropped files, filtering
-  them by extension, and showing a warning when none are supported; and setting the
-  drop-zone message as a function that reads a live model counter.
-
-  By the end, you'll have an app with a full notification layer — a boot
-  confirmation toast, async status reporting from a child component, and a
-  drag-and-drop zone whose message updates as models are loaded.
-*/
-
-import { html, LitElement } from "lit";
-import { customElement, state } from "lit/decorators.js";
-import * as THREE from "three";
-import * as OBC from "@thatopen/components";
-import * as OBF from "@thatopen/components-front";
-import * as FRAGS from "@thatopen/fragments";
-import * as BUI from "@thatopen/ui";
-import { PlatformClient } from "thatopen-services";
-import uiManagerDef from "../../../../index";
-import type { App, AppReadyEvent } from "../../index";
-
-// A child component that dispatches top:notification to surface messages
-// to the nearest top-app ancestor — no reference to the app element needed.
-@customElement("status-reporter")
-class StatusReporter extends LitElement {
-  @state() private _busy = false;
-
-  private _simulateWork() {
-    this._busy = true;
-
-    // Dispatching top:notification from any descendant of top-app shows a toast.
-    // bubbles:true + composed:true lets it cross shadow-DOM boundaries.
-    this.dispatchEvent(
-      new CustomEvent("top:notification", {
-        bubbles: true,
-        composed: true,
-        detail: { message: "Analysis started", type: "info" },
-      }),
-    );
-
-    setTimeout(() => {
-      this._busy = false;
-      this.dispatchEvent(
-        new CustomEvent("top:notification", {
-          bubbles: true,
-          composed: true,
-          detail: {
-            message: "Analysis complete",
-            type: "success",
-            description: "Found 342 elements across 5 categories.",
-          },
-        }),
-      );
-    }, 2000);
-  }
-
-  render() {
-    return html`
-      <bim-panel label="Reporter">
-        <bim-panel-section label="Actions" icon="solar:play-bold">
-          <bim-button
-            label="Run Analysis"
-            icon="solar:play-bold"
-            .loading=${this._busy}
-            @click=${this._simulateWork}
-          ></bim-button>
-        </bim-panel-section>
-      </bim-panel>
-    `;
-  }
-}
-
-// ---- app wiring ----
-
-const UIManager = uiManagerDef.componentDefinition;
-const client = PlatformClient.fromPlatformContext();
-const { components } = (await client.setup(
-  { OBC, OBF, BUI, THREE, FRAGS },
-  { uuid: UIManager.uuid },
-)) as { components: OBC.Components };
-components.get(UIManager).init();
-
-const app = document.createElement("top-app") as unknown as App;
-
-app.setup = (waitUntil) => {
-  waitUntil(
-    (async () => {
-      const fragments = components.get(OBC.FragmentsManager);
-      const workerUrl = await FRAGS.FragmentsModels.getWorker();
-      fragments.init(await FRAGS.toClassicWorker(workerUrl), {
-        classicWorker: true,
-      });
-    })(),
-    "Fragments Core",
-  );
-  return { components, client };
-};
-
-app.elements = {
-  viewer: () =>
-    html`<top-viewer><top-viewer-tools></top-viewer-tools></top-viewer>`,
-  panel: () => html`<status-reporter></status-reporter>`,
-};
-
-app.base = "viewer";
-app.layouts = {
-  main: {
-    label: "Main",
-    icon: "solar:home-bold",
-    template: `"panel" 1fr / 22rem`,
-  },
-};
-app.layout = "main";
-
-// dropMessage as a function is called at render time so it can read live state.
-// Here it reads how many models are already loaded and adjusts the hint text.
-let loadedCount = 0;
-app.dropMessage = () =>
-  loadedCount === 0
-    ? "Drop an IFC or FRAG file to load your first model"
-    : `Drop a file to add to the ${loadedCount} loaded model${loadedCount === 1 ? "" : "s"}`;
-
-// top:files-dropped fires when the user drops files onto the window.
-// e.detail.files is a File[]. Handle upload, load, or validation here.
-app.addEventListener("top:files-dropped", (e) => {
-  const { files } = (e as CustomEvent<{ files: File[] }>).detail;
-  const supported = files.filter((f) =>
-    f.name.endsWith(".ifc") || f.name.endsWith(".frag"),
-  );
-  if (!supported.length) {
-    app.showToast("No supported files dropped", "warning");
-    return;
-  }
-  app.showToast(`Loading ${supported.length} file${supported.length === 1 ? "" : "s"}…`, "info");
-  loadedCount += supported.length;
-});
-
-// thatopen:app-ready fires after all waitUntil promises resolve.
-// e.detail.app is a reference to the top-app element itself.
-app.addEventListener("thatopen:app-ready", (e) => {
-  const { app: readyApp } = (e as AppReadyEvent).detail;
-  readyApp.showToast("App ready", "success");
-});
-
-const container = document.getElementById("that-open-app") ?? document.body;
-container.appendChild(app);
-document.body.style.margin = "0";
+/* MD
+  ## Toasts and cross-component notifications
+  ---
+  Developers building BIM processing UIs need to surface status updates, errors,
+  and async feedback to users from different points in the component tree —
+  but reaching back to the app root to trigger a notification from a deeply
+  nested component requires threading a reference through every layer in between.
+
+  top-app provides a built-in toast system that any descendant can trigger by
+  dispatching a standard DOM event. Toasts are auto-dismissed after a type-based
+  duration and stack at the bottom-left of the screen.
+
+  This tutorial covers showing a toast on app boot via showToast; building a
+  component that dispatches top:notification to report async progress and
+  completion without a reference to the root; and using the four toast types
+  (success, error, warning, info) with their respective durations.
+
+  By the end, you'll have an app with a boot confirmation toast and a panel that
+  reports async work status without holding any reference to top-app.
+*/
+
+import { html, LitElement } from "lit";
+import { customElement, state } from "lit/decorators.js";
+import * as THREE from "three";
+import * as OBC from "@thatopen/components";
+import * as OBF from "@thatopen/components-front";
+import * as FRAGS from "@thatopen/fragments";
+import * as BUI from "@thatopen/ui";
+import { PlatformClient } from "thatopen-services";
+import uiManagerDef from "../../../../index";
+import type { App, AppReadyEvent } from "../../index";
+
+// A child component that dispatches top:notification to surface messages
+// to the nearest top-app ancestor — no reference to the app element needed.
+@customElement("status-reporter")
+class StatusReporter extends LitElement {
+  @state() private _busy = false;
+
+  private _simulateWork() {
+    this._busy = true;
+
+    // Dispatching top:notification from any descendant of top-app shows a toast.
+    // bubbles:true + composed:true lets it cross shadow-DOM boundaries.
+    this.dispatchEvent(
+      new CustomEvent("top:notification", {
+        bubbles: true,
+        composed: true,
+        detail: { message: "Analysis started", type: "info" },
+      }),
+    );
+
+    setTimeout(() => {
+      this._busy = false;
+      this.dispatchEvent(
+        new CustomEvent("top:notification", {
+          bubbles: true,
+          composed: true,
+          detail: {
+            message: "Analysis complete",
+            type: "success",
+            description: "Found 342 elements across 5 categories.",
+          },
+        }),
+      );
+    }, 2000);
+  }
+
+  render() {
+    return html`
+      <bim-panel label="Reporter">
+        <bim-panel-section label="Actions" icon="solar:play-bold">
+          <bim-button
+            label="Run Analysis"
+            icon="solar:play-bold"
+            .loading=${this._busy}
+            @click=${this._simulateWork}
+          ></bim-button>
+        </bim-panel-section>
+      </bim-panel>
+    `;
+  }
+}
+
+// ---- app wiring ----
+
+const UIManager = uiManagerDef.componentDefinition;
+const client = PlatformClient.fromPlatformContext();
+const { components } = (await client.setup(
+  { OBC, OBF, BUI, THREE, FRAGS },
+  { uuid: UIManager.uuid },
+)) as { components: OBC.Components };
+components.get(UIManager).init();
+
+const app = document.createElement("top-app") as unknown as App;
+
+app.setup = (waitUntil) => {
+  waitUntil(
+    (async () => {
+      const fragments = components.get(OBC.FragmentsManager);
+      const workerUrl = await FRAGS.FragmentsModels.getWorker();
+      fragments.init(await FRAGS.toClassicWorker(workerUrl), {
+        classicWorker: true,
+      });
+    })(),
+    "Fragments Core",
+  );
+  return { components, client };
+};
+
+app.elements = {
+  viewer: () =>
+    html`<top-viewer><top-viewer-tools></top-viewer-tools></top-viewer>`,
+  panel: () => html`<status-reporter></status-reporter>`,
+};
+
+app.base = "viewer";
+app.layouts = {
+  main: {
+    label: "Main",
+    icon: "solar:home-bold",
+    template: `"panel" 1fr / 22rem`,
+  },
+};
+app.layout = "main";
+
+// top:app-ready fires after all waitUntil promises resolve.
+// e.detail.app is a reference to the top-app element itself.
+app.addEventListener("top:app-ready", (e) => {
+  const { app: readyApp } = (e as AppReadyEvent).detail;
+  readyApp.showToast("App ready", "success");
+});
+
+const container = document.getElementById("that-open-app") ?? document.body;
+container.appendChild(app);
+document.body.style.margin = "0";