matterviz 0.3.7 → 0.4.1

package/dist/fermi-surface/FermiSurface.svelte

@@ -1,14 +1,13 @@
 <script lang="ts">
   import type { BrillouinZoneData } from '../brillouin'
   import { compute_brillouin_zone, reciprocal_lattice } from '../brillouin'
-  import type { ShowControlsProp } from '../controls'
-  import { normalize_show_controls } from '../controls'
+  import { normalize_show_controls, type ShowControlsProp } from '../controls'
   import EmptyState from '../EmptyState.svelte'
   import { StatusMessage } from '../feedback'
   import Spinner from '../feedback/Spinner.svelte'
-  import Icon from '../Icon.svelte'
-  import { create_file_drop_handler, load_from_url } from '../io'
-  import { set_fullscreen_bg, toggle_fullscreen } from '../layout'
+  import { create_file_drop_handler, drag_over_handlers, load_from_url } from '../io'
+  import { type FullscreenToggleProp, toggle_fullscreen, ViewerChrome } from '../layout'
+  import { sync_fullscreen } from '../layout/fullscreen.svelte'
   import { PlotTooltip } from '../plot'
   import type { CameraProjection } from '../settings'
   import { DEFAULTS } from '../settings'
@@ -16,7 +15,6 @@
   import { Canvas } from '@threlte/core'
   import type { ComponentProps, Snippet } from 'svelte'
   import { untrack } from 'svelte'
-  import { tooltip } from 'svelte-multiselect/attachments'
   import type { HTMLAttributes } from 'svelte/elements'
   import type { Camera, Scene } from 'three'
   import { detect_irreducible_bz, extract_fermi_surface } from './compute'
@@ -24,6 +22,7 @@
   import FermiSurfaceScene from './FermiSurfaceScene.svelte'
   import FermiSurfaceTooltip from './FermiSurfaceTooltip.svelte'
   import { parse_fermi_file } from './parse'
+  import { to_error } from '../utils'
   import type {
     BandGridData,
     ColorProperty,
@@ -90,6 +89,7 @@
     on_error,
     on_fullscreen_change,
     on_mu_change,
+    on_point_hover,
     on_hover,
     ...rest
   }: {
@@ -116,15 +116,13 @@
     clip_flip?: boolean
     interpolation_factor?: number
     camera_projection?: CameraProjection
-    /**
-     * Controls visibility configuration.
-     * - 'always': controls always visible
-     * - 'hover': controls visible on component hover (default)
-     * - 'never': controls never visible
-     * - object: { mode, hidden, style } for fine-grained control
-     *
-     * Control names: 'filename', 'fullscreen', 'controls'
-     */
+    // Controls visibility configuration.
+    // - 'always': controls always visible
+    // - 'hover': controls visible on component hover (default)
+    // - 'never': controls never visible
+    // - object: { mode, hidden, style } for fine-grained control
+    //
+    // Control names: 'filename', 'fullscreen', 'controls'
     show_controls?: ShowControlsProp
     fullscreen?: boolean
     width?: number
@@ -133,7 +131,7 @@
     hovered?: boolean
     dragover?: boolean
     allow_file_drop?: boolean
-    fullscreen_toggle?: Snippet<[{ fullscreen: boolean }]> | boolean
+    fullscreen_toggle?: FullscreenToggleProp
     data_url?: string
     spinner_props?: ComponentProps<typeof Spinner>
     loading?: boolean
@@ -147,6 +145,8 @@
     on_fullscreen_change?: (data: FermiHandlerData) => void
     on_mu_change?: (mu: number) => void
     tooltip_config?: Snippet<[{ hover_data: FermiHoverData }]> | FermiTooltipConfig
+    on_point_hover?: (data: FermiHoverData | null) => void
+    // Deprecated alias for on_point_hover (honored when on_point_hover is unset)
     on_hover?: (data: FermiHoverData | null) => void
   } & HTMLAttributes<HTMLDivElement> = $props()
 
@@ -156,9 +156,16 @@
   let recompute_job_id = 0 // monotonic counter to track latest recompute call
   let hover_data = $state<FermiHoverData | null>(null)
 
-  // Call on_hover callback when hover_data changes
+  // Call on_point_hover callback when hover_data changes (on_hover is a deprecated alias)
+  let warned_deprecated_on_hover = false
   $effect(() => {
-    on_hover?.(hover_data)
+    if (on_hover && !on_point_hover && !warned_deprecated_on_hover) {
+      warned_deprecated_on_hover = true
+      console.warn(
+        `FermiSurface: the on_hover prop was renamed to on_point_hover; the alias will be removed in a future release`,
+      )
+    }
+    ;(on_point_hover ?? on_hover)?.(hover_data)
   })
 
   let controls_config = $derived(normalize_show_controls(show_controls))
@@ -178,8 +185,8 @@
       ? new TextDecoder().decode(content)
       : content
 
+    // parse_fermi_file throws a descriptive error when parsing fails
     const parsed = parse_fermi_file(text, filename)
-    if (!parsed) throw new Error(`Failed to parse Fermi surface from ${filename}`)
 
     const file_size = new Blob([content]).size
     current_filename = filename
@@ -202,7 +209,7 @@
       await parse_fermi_content(content, filename)
     } catch (err) {
       error_msg = `Failed to parse ${filename}: ${
-        err instanceof Error ? err.message : err
+        to_error(err).message
       }`
       on_error?.({ error_msg, filename })
     }
@@ -263,7 +270,7 @@
       await export_scene(scene, format, current_filename || `fermi-surface`)
     } catch (err) {
       console.error(`Export failed:`, err)
-      error_msg = `Export failed: ${err instanceof Error ? err.message : err}`
+      error_msg = `Export failed: ${to_error(err).message}`
     }
   }
 
@@ -284,7 +291,7 @@
     try {
       bz_data = compute_brillouin_zone(k_lattice, 1)
     } catch (err) {
-      const msg = err instanceof Error ? err.message : String(err)
+      const msg = to_error(err).message
       console.warn(`BZ computation failed:`, msg)
       bz_data = undefined
       // Only report error for structure-derived lattice (user-provided data)
@@ -313,7 +320,7 @@
       load_from_url(data_url, safe_parse)
         .catch((err) => {
           if (current_load_id !== load_id) return // stale request
-          error_msg = err instanceof Error ? err.message : String(err)
+          error_msg = to_error(err).message
           on_error?.({ error_msg, filename: data_url })
         })
         .finally(() => {
@@ -348,28 +355,19 @@
     else if (event.key === `Escape`) controls_open = false
   }
 
-  $effect(() => {
-    if (typeof window === `undefined`) return
-    const fs_el = document.fullscreenElement
-    if (fullscreen && fs_el !== wrapper && wrapper) {
-      wrapper.requestFullscreen().catch((err) => {
-        console.error(err)
-        fullscreen = false
-      })
-    } else if (!fullscreen && fs_el === wrapper) document.exitFullscreen()
-    set_fullscreen_bg(wrapper, fullscreen, `--fermi-bg-fullscreen`)
+  sync_fullscreen({
+    get_wrapper: () => wrapper,
+    get_fullscreen: () => fullscreen,
+    set_fullscreen: (val) => (fullscreen = val),
+    bg_css_var: `--fermi-bg-fullscreen`,
+    on_request_error: () => (fullscreen = false),
+    on_change: (val) =>
+      on_fullscreen_change?.({ fermi_data, bz_data, fullscreen: val }),
   })
 </script>
 
 <svelte:window onkeydown={handle_keydown} />
 
-<svelte:document
-  onfullscreenchange={() => {
-    fullscreen = Boolean(document.fullscreenElement)
-    on_fullscreen_change?.({ fermi_data, bz_data, fullscreen })
-  }}
-/>
-
 <div
   class:dragover
   class:active={controls_open}
@@ -381,15 +379,7 @@
   onmouseenter={() => (hovered = true)}
   onmouseleave={() => (hovered = false)}
   ondrop={handle_file_drop}
-  ondragover={(event) => {
-    event.preventDefault()
-    if (!allow_file_drop) return
-    dragover = true
-  }}
-  ondragleave={(event) => {
-    event.preventDefault()
-    dragover = false
-  }}
+  {...drag_over_handlers({ allow: () => allow_file_drop, set_dragover: (over) => dragover = over })}
   {...rest}
   class="fermi-surface {rest.class ?? ``}"
 >
@@ -401,63 +391,48 @@
       {...spinner_props}
     />
   {:else if error_msg}
-    <StatusMessage bind:message={error_msg} type="error" dismissible />
+    <StatusMessage
+      bind:message={error_msg}
+      type="error"
+      dismissible
+      style="position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); max-width: 90%; text-align: center"
+    />
   {:else if fermi_data || band_data}
-    <section
-      class="control-buttons {controls_config.class}"
-      style={controls_config.style}
+    <ViewerChrome
+      {controls_config}
+      filename={current_filename}
+      {fullscreen}
+      {fullscreen_toggle}
+      {wrapper}
     >
-      {#if controls_config.mode !== `never`}
-        {#if current_filename && controls_config.visible(`filename`)}
-          <span class="filename">{current_filename}</span>
-        {/if}
-
-        {#if fullscreen_toggle && controls_config.visible(`fullscreen`)}
-          <button
-            type="button"
-            onclick={() => fullscreen_toggle && toggle_fullscreen(wrapper)}
-            title="{fullscreen ? `Exit` : `Enter`} fullscreen"
-            aria-pressed={fullscreen}
-            class="fullscreen-toggle"
-            {@attach tooltip()}
-          >
-            {#if typeof fullscreen_toggle === `function`}
-              {@render fullscreen_toggle({ fullscreen })}
-            {:else}
-              <Icon icon="{fullscreen ? `Exit` : ``}Fullscreen" />
-            {/if}
-          </button>
-        {/if}
-
-        {#if controls_config.visible(`controls`)}
-          <FermiSurfaceControls
-            bind:controls_open
-            {fermi_data}
-            {band_data}
-            bind:mu
-            bind:color_property
-            bind:color_scale
-            {custom_property_label}
-            bind:representation
-            bind:surface_opacity
-            bind:selected_bands
-            bind:show_bz
-            bind:bz_opacity
-            bind:show_vectors
-            bind:tile_bz
-            bind:clip_enabled
-            bind:clip_axis
-            bind:clip_position
-            bind:clip_flip
-            bind:interpolation_factor
-            bind:camera_projection
-            on_mu_change={handle_mu_change}
-            on_interpolation_change={handle_interpolation_change}
-            on_export={handle_export}
-          />
-        {/if}
+      {#if controls_config.visible(`controls`)}
+        <FermiSurfaceControls
+          bind:controls_open
+          {fermi_data}
+          {band_data}
+          bind:mu
+          bind:color_property
+          bind:color_scale
+          {custom_property_label}
+          bind:representation
+          bind:surface_opacity
+          bind:selected_bands
+          bind:show_bz
+          bind:bz_opacity
+          bind:show_vectors
+          bind:tile_bz
+          bind:clip_enabled
+          bind:clip_axis
+          bind:clip_position
+          bind:clip_flip
+          bind:interpolation_factor
+          bind:camera_projection
+          on_mu_change={handle_mu_change}
+          on_interpolation_change={handle_interpolation_change}
+          on_export={handle_export}
+        />
       {/if}
-    </section>
+    </ViewerChrome>
 
     {#if typeof WebGLRenderingContext !== `undefined`}
       <Canvas renderMode="on-demand" dpr={Math.min(2, window.devicePixelRatio)}>
@@ -549,52 +524,4 @@
   .fermi-surface :global(canvas) {
     user-select: none;
   }
-  section.control-buttons {
-    position: absolute;
-    display: flex;
-    top: var(--fermi-buttons-top, var(--ctrl-btn-top, 1ex));
-    right: var(--fermi-buttons-right, var(--ctrl-btn-right, 1ex));
-    gap: clamp(6pt, 1cqmin, 9pt);
-    z-index: var(
-      --fermi-buttons-z-index,
-      var(--z-index-overlay-controls, 100000000)
-    );
-    opacity: 0;
-    pointer-events: none;
-    transition: opacity 0.2s ease;
-    align-items: center;
-  }
-  /* Mode: always - controls always visible */
-  section.control-buttons.always-visible {
-    opacity: 1;
-    pointer-events: auto;
-  }
-  /* Mode: hover - controls visible on component hover */
-  .fermi-surface:hover section.control-buttons.hover-visible,
-  .fermi-surface:focus-within section.control-buttons.hover-visible {
-    opacity: 1;
-    pointer-events: auto;
-  }
-  /* Mode: never - stays hidden (default state, no additional CSS needed) */
-  section.control-buttons > :global(button) {
-    background-color: transparent;
-    display: flex;
-    padding: 4px;
-    border-radius: var(--border-radius, 3pt);
-    font-size: clamp(0.85em, 2cqmin, 1.3em);
-  }
-  section.control-buttons :global(button:hover) {
-    background-color: color-mix(in srgb, currentColor 8%, transparent);
-  }
-  .filename {
-    font-family: monospace;
-    font-size: 0.9em;
-    background: var(--code-bg, rgba(0, 0, 0, 0.1));
-    padding: 3pt 6pt;
-    border-radius: 3pt;
-    max-width: 200px;
-    overflow: hidden;
-    text-overflow: ellipsis;
-    white-space: nowrap;
-  }
 </style>

package/dist/fermi-surface/FermiSurface.svelte.d.ts

@@ -1,6 +1,7 @@
 import type { BrillouinZoneData } from '../brillouin';
-import type { ShowControlsProp } from '../controls';
+import { type ShowControlsProp } from '../controls';
 import Spinner from '../feedback/Spinner.svelte';
+import { type FullscreenToggleProp } from '../layout';
 import type { CameraProjection } from '../settings';
 import type { Crystal } from '../structure';
 import type { ComponentProps, Snippet } from 'svelte';
@@ -38,15 +39,6 @@ type $$ComponentProps = {
     clip_flip?: boolean;
     interpolation_factor?: number;
     camera_projection?: CameraProjection;
-    /**
-     * Controls visibility configuration.
-     * - 'always': controls always visible
-     * - 'hover': controls visible on component hover (default)
-     * - 'never': controls never visible
-     * - object: { mode, hidden, style } for fine-grained control
-     *
-     * Control names: 'filename', 'fullscreen', 'controls'
-     */
     show_controls?: ShowControlsProp;
     fullscreen?: boolean;
     width?: number;
@@ -55,9 +47,7 @@ type $$ComponentProps = {
     hovered?: boolean;
     dragover?: boolean;
     allow_file_drop?: boolean;
-    fullscreen_toggle?: Snippet<[{
-        fullscreen: boolean;
-    }]> | boolean;
+    fullscreen_toggle?: FullscreenToggleProp;
     data_url?: string;
     spinner_props?: ComponentProps<typeof Spinner>;
     loading?: boolean;
@@ -76,8 +66,9 @@ type $$ComponentProps = {
     tooltip_config?: Snippet<[{
         hover_data: FermiHoverData;
     }]> | FermiTooltipConfig;
+    on_point_hover?: (data: FermiHoverData | null) => void;
     on_hover?: (data: FermiHoverData | null) => void;
 } & HTMLAttributes<HTMLDivElement>;
-declare const FermiSurface: import("svelte").Component<$$ComponentProps, {}, "height" | "width" | "dragover" | "loading" | "fullscreen" | "hovered" | "controls_open" | "camera_projection" | "color_scale" | "wrapper" | "error_msg" | "surface_opacity" | "show_vectors" | "bz_data" | "mu" | "selected_bands" | "interpolation_factor" | "fermi_data" | "band_data" | "color_property" | "representation" | "show_bz" | "bz_opacity" | "tile_bz" | "clip_enabled" | "clip_axis" | "clip_position" | "clip_flip">;
+declare const FermiSurface: import("svelte").Component<$$ComponentProps, {}, "height" | "width" | "dragover" | "fullscreen" | "wrapper" | "hovered" | "controls_open" | "color_scale" | "loading" | "camera_projection" | "error_msg" | "surface_opacity" | "show_vectors" | "bz_data" | "mu" | "selected_bands" | "interpolation_factor" | "fermi_data" | "band_data" | "color_property" | "representation" | "show_bz" | "bz_opacity" | "tile_bz" | "clip_enabled" | "clip_axis" | "clip_position" | "clip_flip">;
 type FermiSurface = ReturnType<typeof FermiSurface>;
 export default FermiSurface;

package/dist/fermi-surface/FermiSurfaceControls.svelte

@@ -111,7 +111,7 @@
       return
     }
     const idx = selected_bands.indexOf(band_idx)
-    if (idx >= 0) {
+    if (idx !== -1) {
       selected_bands = selected_bands.filter((band) => band !== band_idx)
     } else {
       selected_bands = [...selected_bands, band_idx].toSorted((a, b) => a - b)

package/dist/fermi-surface/FermiSurfaceControls.svelte.d.ts

@@ -30,6 +30,6 @@ type $$ComponentProps = {
         band_data?: BandGridData;
     }]>;
 };
-declare const FermiSurfaceControls: import("svelte").Component<$$ComponentProps, {}, "controls_open" | "camera_projection" | "color_scale" | "surface_opacity" | "show_vectors" | "mu" | "selected_bands" | "interpolation_factor" | "color_property" | "representation" | "show_bz" | "bz_opacity" | "tile_bz" | "clip_enabled" | "clip_axis" | "clip_position" | "clip_flip">;
+declare const FermiSurfaceControls: import("svelte").Component<$$ComponentProps, {}, "controls_open" | "color_scale" | "camera_projection" | "surface_opacity" | "show_vectors" | "mu" | "selected_bands" | "interpolation_factor" | "color_property" | "representation" | "show_bz" | "bz_opacity" | "tile_bz" | "clip_enabled" | "clip_axis" | "clip_position" | "clip_flip">;
 type FermiSurfaceControls = ReturnType<typeof FermiSurfaceControls>;
 export default FermiSurfaceControls;