babylon.quarks-editor 0.27.0 → 0.28.0

package/src/react/ChoiceDialog.tsx

@@ -1,16 +1,23 @@
 import React, {useEffect} from 'react';
 import {buttonStyle, theme} from './theme.js';
 
+/** One button of a {@link ChoiceDialog}. */
 export interface ChoiceDialogAction {
+    /** The button's text. */
     label: string;
+    /** Runs when the button is pressed. */
     onSelect: () => void;
     /** Accent button — also what Enter picks. */
     primary?: boolean;
+    /** Shows the button in red, for a destructive choice. */
     danger?: boolean;
 }
 
+/** Props of {@link ChoiceDialog}. */
 export interface ChoiceDialogProps {
+    /** The question. */
     title: string;
+    /** What the choice means. */
     message: React.ReactNode;
     /** Shown left to right; put the cancel action first. */
     actions: ChoiceDialogAction[];

package/src/react/ContextMenu.tsx

@@ -2,18 +2,27 @@ import React, {useEffect, useLayoutEffect, useRef, useState} from 'react';
 import {createPortal} from 'react-dom';
 import {theme} from './theme.js';
 
+/** One entry of a {@link ContextMenu}. */
 export interface ContextMenuItem {
+    /** The entry's text. */
     label: string;
+    /** Runs when the entry is picked; the menu closes first. */
     onSelect: () => void;
+    /** Shows the entry in red, for a destructive action. */
     danger?: boolean;
+    /** Shows the entry greyed out and unpickable. */
     disabled?: boolean;
 }
 
+/** Props of {@link ContextMenu}. */
 export interface ContextMenuProps {
-    /** Client coordinates of the right-click. */
+    /** Client X of the right-click. */
     x: number;
+    /** Client Y of the right-click. */
     y: number;
+    /** The entries, top to bottom. */
     items: ContextMenuItem[];
+    /** Closes the menu: the host stops rendering it. */
     onClose: () => void;
 }
 

package/src/react/EditorWorkspace.tsx

@@ -6,6 +6,7 @@ import {EffectEditorHost, type EffectEditorHostProps} from './EffectEditorHost.j
 import {ProjectsPage} from './ProjectsPage.js';
 import {theme} from './theme.js';
 
+/** Props of {@link EditorWorkspace}: the editor's, plus where projects live. */
 export interface EditorWorkspaceProps extends Omit<EffectEditorHostProps, 'project' | 'onExitProject' | 'effectJson'> {
     /** Where projects are kept; defaults to the browser's IndexedDB. */
     store?: ProjectStore;
@@ -23,10 +24,7 @@ export function EditorWorkspace(props: EditorWorkspaceProps): React.ReactElement
     const [resolving, setResolving] = useState(Boolean(projectId));
 
     useEffect(() => {
-        if (!projectId) {
-            setResolving(false);
-            return;
-        }
+        if (!projectId) return;
         let cancelled = false;
         void store.getProject(projectId).then((meta) => {
             if (cancelled) return;
@@ -87,7 +85,15 @@ export function EditorWorkspace(props: EditorWorkspaceProps): React.ReactElement
 
 /** Imperative entry point, like QuarksEffectEditor.Show, for the project-based workspace. */
 export const QuarksEditorWorkspace = {
-    Show(options: EditorWorkspaceProps & {hostElement: HTMLElement}): {dispose: () => void} {
+    /**
+     * Mounts an {@link EditorWorkspace} into `hostElement`.
+     *
+     * @returns A handle whose `dispose()` unmounts it.
+     */
+    Show(options: EditorWorkspaceProps & {hostElement: HTMLElement}): {
+        /** Unmounts the workspace. */
+        dispose: () => void;
+    } {
         const {hostElement, ...props} = options;
         const root = createRoot(hostElement);
         root.render(<EditorWorkspace {...props} />);

package/src/react/EffectEditor.tsx

@@ -1,3 +1,4 @@
+import type {Texture} from '@babylonjs/core/Materials/Textures/texture.js';
 import type {TransformNode} from '@babylonjs/core/Meshes/transformNode.js';
 import type {ParticleSystem} from 'babylon.quarks';
 import React, {useEffect, useSyncExternalStore} from 'react';
@@ -37,17 +38,22 @@ import {ObjectModule} from './ObjectModule.js';
 import {SubEmittersModule} from './SubEmittersModule.js';
 import {theme} from './theme.js';
 
+/** Props of {@link EffectEditor}. */
 export interface EffectEditorProps {
+    /** The effect the modules edit. */
     binding: EffectBinding;
     /** Currently selected system, lifted up so the timeline panel and this module stack agree. */
     selectedSystem: ParticleSystem;
+    /** The node the Object module edits the transform of. */
     gizmoTargetNode: TransformNode;
+    /** The Object module's title for that node. */
     gizmoTargetLabel: string;
     /** Texture presets offered in the Renderer module (host supplies the loader). */
     textureOptions?: TextureOption[];
     /** Mesh presets offered for the Mesh render mode (host supplies the geometry buffers). */
     geometryOptions?: GeometryOption[];
-    resolveTexture?: (url: string) => unknown;
+    /** Host texture loader for picked URLs; a plain `Texture` is made without it. */
+    resolveTexture?: (url: string) => Texture | null | undefined;
     /** Host loader for "Load from file…" in the Mesh render mode (e.g. a GLB importer). */
     resolveGeometry?: (file: File) => Promise<GeometryData>;
 }