svelte-tiler 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2026 Roman Krasilnikov
+
+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

@@ -0,0 +1,17 @@
+# svelte-tiler
+
+A small, unstyled library for building tiling user interfaces.
+
+```sh
+npm i svelte-tiler
+```
+
+**Features**:
+
+- Serializable state
+- Type-safe model extension
+- No external dependencies
+
+## License
+
+MIT

package/dist/context.svelte.d.ts

@@ -0,0 +1,50 @@
+import { DndContext } from './shared/dnd.svelte.ts';
+import type { Tile, TileComponent, Tiles, TileType } from './model.ts';
+export declare const getTilerContext: () => TilerContext, setTilerContext: (context: TilerContext) => TilerContext;
+export interface TileDefinition<T extends TileType> {
+    default: TileComponent<T>;
+    onRemoveChild: (ctx: TilerContext, tile: Tiles[T], index: number) => void;
+    onClear: (ctx: TilerContext, tile: Tiles[T]) => void;
+}
+export type TileDefinitions = {
+    [T in TileType]: TileDefinition<T>;
+};
+export type TileEffects = {
+    [T in TileType]?: (tile: Tiles[T]) => void | (() => void);
+};
+export interface TilerContextOptions {
+    tiles: TileDefinitions;
+    parents?: WeakMap<Tile, Tile>;
+    dnd?: DndContext<Tile>;
+    effects?: TileEffects;
+}
+export declare class TilerContext {
+    protected definitions: TileDefinitions;
+    protected parents: WeakMap<Tile, Tile>;
+    protected effects: TileEffects;
+    protected updateRootFn: ((tile: Tile) => void) | undefined;
+    readonly dnd: DndContext<Tile>;
+    constructor(options: TilerContextOptions);
+    registerParent(tile: Tile, parent: Tile): void;
+    setUpdateRoot(tile: Tile, update: (tile: Tile) => void): void;
+    getTileEffect(tile: Tile): ((tile: import("./model.ts").TileBase<"leaf"> & {
+        name: string;
+    }) => void | (() => void)) | ((tile: import("./model.ts").TileBase<"split"> & {
+        constraints: Array<import("./shared/constraints.ts").Constraint[]>;
+        weights: number[];
+        direction: import("./shared/spatial.ts").Direction;
+        resizer?: string;
+        gapPx: number;
+    }) => void | (() => void)) | ((tile: import("./model.ts").TileBase<"tabs"> & {
+        titles: string[];
+        selectedTab: number;
+        headersDirection: import("./tiles/tabs.svelte.ts").HeadersDirection;
+        actions?: string;
+        tabHeader?: string;
+        empty?: string;
+    }) => void | (() => void)) | undefined;
+    getTileComponent(tile: Tile): TileComponent<"leaf"> | TileComponent<"split"> | TileComponent<"tabs">;
+    replaceWith(tile: Tile, replace: Tile): void;
+    removeChild(tile: Tile, index: number): void;
+    destroy(tile: Tile): void;
+}

package/dist/context.svelte.js

@@ -0,0 +1,57 @@
+import { createContext } from 'svelte';
+import { DndContext } from "./shared/dnd.svelte.js";
+export const [getTilerContext, setTilerContext] = createContext();
+export class TilerContext {
+    definitions;
+    parents;
+    effects;
+    updateRootFn;
+    dnd;
+    constructor(options) {
+        this.definitions = $derived(options.tiles);
+        this.dnd = $derived(options.dnd ?? new DndContext());
+        this.parents = $derived(options.parents ?? new WeakMap());
+        this.effects = $derived(options.effects ?? {});
+    }
+    registerParent(tile, parent) {
+        this.parents.set(tile, parent);
+    }
+    setUpdateRoot(tile, update) {
+        this.parents.delete(tile);
+        this.updateRootFn = update;
+    }
+    getTileEffect(tile) {
+        return this.effects[tile.type];
+    }
+    getTileComponent(tile) {
+        return this.definitions[tile.type].default;
+    }
+    replaceWith(tile, replace) {
+        const parent = this.parents.get(tile);
+        if (parent) {
+            const index = parent.children.findIndex((c) => c.id === tile.id);
+            if (index < 0) {
+                throw new Error(`Invalid parent for ${JSON.stringify($state.snapshot(tile))} tile`);
+            }
+            parent.children[index] = replace;
+        }
+        else {
+            this.updateRootFn?.(replace);
+        }
+    }
+    removeChild(tile, index) {
+        return this.definitions[tile.type].onRemoveChild(this, tile, index);
+    }
+    destroy(tile) {
+        const parent = this.parents.get(tile);
+        if (parent === undefined) {
+            this.definitions[tile.type].onClear(this, tile);
+            return;
+        }
+        const index = parent.children.findIndex((c) => c.id === tile.id);
+        if (index < 0) {
+            throw new Error(`Invalid parent for ${JSON.stringify($state.snapshot(tile))} tile`);
+        }
+        this.removeChild(parent, index);
+    }
+}

package/dist/dnd.d.ts

@@ -0,0 +1,6 @@
+import { DndContext, Droppable } from './shared/dnd.svelte.js';
+import type { Tile } from './model.js';
+export declare class TileDroppable<T extends Tile> extends Droppable<Tile, T> {
+    readonly targetTileId: string;
+    constructor(ctx: DndContext<Tile>, targetTileId: string);
+}

package/dist/dnd.js

@@ -0,0 +1,8 @@
+import { DndContext, Droppable } from './shared/dnd.svelte.js';
+export class TileDroppable extends Droppable {
+    targetTileId;
+    constructor(ctx, targetTileId) {
+        super(ctx);
+        this.targetTileId = targetTileId;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './context.svelte.ts';
+export * from './model.ts';
+export * from './dnd.ts';
+export { default as Panel } from './panel.svelte';
+export { default as Tiler } from './tiler.svelte';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from "./context.svelte.js";
+export * from "./model.js";
+export * from "./dnd.js";
+export { default as Panel } from './panel.svelte';
+export { default as Tiler } from './tiler.svelte';

package/dist/model.d.ts

@@ -0,0 +1,20 @@
+import type { Component, Snippet } from 'svelte';
+export interface TileBase<T extends TileType> {
+    id: string;
+    type: T;
+    children: Tile[];
+}
+export interface TileRegistry {
+}
+export type TileType = keyof TileRegistry;
+export type Tiles = {
+    [T in TileType]: TileBase<T> & TileRegistry[T];
+};
+export type Tile = Tiles[TileType];
+export type TileProps<T extends TileType> = {
+    tile: Tiles[T];
+    parent: Tile | undefined;
+    index: number;
+    child: Snippet<[number]>;
+};
+export type TileComponent<T extends TileType> = Component<TileProps<T>, {}, 'tile' | 'parent'>;

package/dist/model.js

@@ -0,0 +1 @@
+export {};

package/dist/panel.svelte

@@ -0,0 +1,14 @@
+<script lang="ts">
+  import Render from './render.svelte';
+  import type { Tile } from './model.js';
+
+  let { layout = $bindable() }: { layout: Tile | undefined } = $props();
+</script>
+
+{#if layout}
+  <Render
+    bind:tile={layout}
+    bind:parent={() => undefined, (t) => (layout = t)}
+    index={0}
+  />
+{/if}

package/dist/panel.svelte.d.ts

@@ -0,0 +1,7 @@
+import type { Tile } from './model.ts';
+type $$ComponentProps = {
+    layout: Tile | undefined;
+};
+declare const Panel: import("svelte").Component<$$ComponentProps, {}, "layout">;
+type Panel = ReturnType<typeof Panel>;
+export default Panel;

package/dist/render.svelte

@@ -0,0 +1,35 @@
+<script lang="ts">
+  import { getTilerContext } from './context.svelte.js';
+  import type { Tile } from './model.js';
+  import Self from './render.svelte';
+
+  let {
+    tile = $bindable(),
+    parent = $bindable(),
+    index,
+  }: {
+    tile: Tile;
+    parent: Tile | undefined;
+    index: number;
+  } = $props();
+
+  const ctx = getTilerContext();
+
+  $effect(() => {
+    if (parent) {
+      ctx.registerParent(tile, parent);
+    } else {
+      ctx.setUpdateRoot(tile, (t) => (parent = t));
+    }
+  });
+
+  $effect(() => ctx.getTileEffect(tile)?.(tile as never));
+
+  const TileComponent = $derived(ctx.getTileComponent(tile));
+</script>
+
+{#snippet child(index: number)}
+  <Self bind:parent={tile} bind:tile={tile.children[index]} {index} />
+{/snippet}
+
+<TileComponent bind:parent bind:tile={tile as never} {index} {child} />

package/dist/render.svelte.d.ts

@@ -0,0 +1,9 @@
+import type { Tile } from './model.ts';
+type $$ComponentProps = {
+    tile: Tile;
+    parent: Tile | undefined;
+    index: number;
+};
+declare const Render: import("svelte").Component<$$ComponentProps, {}, "tile" | "parent">;
+type Render = ReturnType<typeof Render>;
+export default Render;

package/dist/shared/constraints.d.ts

@@ -0,0 +1,19 @@
+export type ConstraintUnit = 'px' | 'weight' | '%';
+export type ConstraintType = 'maxSize' | 'minSize';
+export interface Constraint {
+    type: ConstraintType;
+    unit: ConstraintUnit;
+    value: number;
+}
+export type NormalizedConstraints = Record<ConstraintType, number>;
+interface Sizes {
+    totalWeight: number;
+    totalSizePx: number;
+    totalSizePercent: number;
+}
+export interface NormalizeOptions extends Sizes {
+    constraints: Constraint[];
+    targetUnit: ConstraintUnit;
+}
+export declare function normalize(options: NormalizeOptions): NormalizedConstraints;
+export {};

package/dist/shared/constraints.js

@@ -0,0 +1,26 @@
+const UNIT_TO_TOTAL_SIZE = {
+    px: 'totalSizePx',
+    '%': 'totalSizePercent',
+    weight: 'totalWeight',
+};
+const CONSTRAINT_COMBINATOR = {
+    maxSize: Math.min,
+    minSize: Math.max,
+};
+// TODO: Handle 0 total sizes
+export function normalize(options) {
+    const result = {
+        maxSize: Infinity,
+        minSize: 0,
+    };
+    const targetTotal = options[UNIT_TO_TOTAL_SIZE[options.targetUnit]];
+    for (const constraint of options.constraints) {
+        // (constraint.value * targetTotal) / sourceTotal;
+        const normalizedValue = options.targetUnit === constraint.unit
+            ? constraint.value
+            : (constraint.value * targetTotal) /
+                options[UNIT_TO_TOTAL_SIZE[constraint.unit]];
+        result[constraint.type] = CONSTRAINT_COMBINATOR[constraint.type](result[constraint.type], normalizedValue);
+    }
+    return result;
+}

package/dist/shared/dnd.svelte.d.ts

@@ -0,0 +1,74 @@
+import type { MutableRegistry } from './registry.ts';
+declare const ON_ENTER: unique symbol;
+declare const ON_MOVE: unique symbol;
+declare const ON_LEAVE: unique symbol;
+declare const ON_DROP: unique symbol;
+export type FeedbackFactory = (e: PointerEvent, el: HTMLElement) => {
+    onMove: (e: PointerEvent) => void;
+    onStop: (e: StopEvent) => void;
+} | undefined;
+export interface DndContextOptions {
+    feedback?: FeedbackFactory;
+}
+export declare class DndContext<D = unknown> {
+    #private;
+    readonly feedback: FeedbackFactory;
+    constructor(options?: DndContextOptions);
+    sourceId: string | undefined;
+    targetId: string | undefined;
+    get droppables(): MutableRegistry<string, Droppable<D, any> | undefined>;
+    findDroppable(x: number, y: number, draggable: Draggable<D>): Droppable<D, any> | undefined;
+}
+export type StopReason = 'drop' | 'cancel';
+export interface StopEvent {
+    reason: StopReason;
+}
+export interface DraggableOptions<D> {
+    data?: D;
+}
+export declare class Draggable<D = unknown> {
+    #private;
+    protected readonly ctx: DndContext<D>;
+    protected readonly options: DraggableOptions<D>;
+    readonly id: `${string}-${string}-${string}-${string}-${string}`;
+    constructor(ctx: DndContext<D>, options?: DraggableOptions<D>);
+    get isDragged(): boolean;
+    get data(): D | undefined;
+    register(el: HTMLElement): () => void;
+    registerHandel(el: HTMLElement): () => void;
+    [Symbol.dispose](): void;
+    protected onStart(_e: PointerEvent, _el: HTMLElement): void;
+    protected onMove(_e: PointerEvent): void;
+    protected onStop(_e: StopEvent): void;
+    protected addEventHandlers(el: HTMLElement): void;
+    protected pointerDownHandler(event: PointerEvent & {
+        currentTarget: HTMLElement;
+    }): void;
+}
+export declare class Droppable<D = unknown, T extends D = D> {
+    #private;
+    protected readonly ctx: DndContext<D>;
+    readonly id: `${string}-${string}-${string}-${string}-${string}`;
+    constructor(ctx: DndContext<D>);
+    get element(): HTMLElement | undefined;
+    get isOver(): boolean;
+    [Symbol.dispose](): void;
+    register(el: HTMLElement): () => void;
+    accepts(draggable: Draggable<D>): draggable is Draggable<T>;
+    [ON_ENTER](): void;
+    [ON_MOVE](e: PointerEvent): void;
+    [ON_LEAVE](): void;
+    [ON_DROP](data: T, draggable: Draggable<T>): void;
+    protected onEnter(): void;
+    protected onMove(_e: PointerEvent): void;
+    protected onLeave(): void;
+    protected onDrop(_data: T, _draggable: Draggable<T>): void;
+}
+export declare class ClonedGhost {
+    #private;
+    constructor(el: HTMLElement, e: PointerEvent);
+    attach(root: ShadowRoot | Document | Node): this;
+    onMove(e: PointerEvent): void;
+    onStop(): void;
+}
+export {};

package/dist/shared/dnd.svelte.js

@@ -0,0 +1,247 @@
+import { flushSync } from 'svelte';
+import { SvelteMap } from 'svelte/reactivity';
+import { on } from 'svelte/events';
+const ON_ENTER = Symbol('on-enter-key');
+const ON_MOVE = Symbol('on-move-key');
+const ON_LEAVE = Symbol('on-leave-key');
+const ON_DROP = Symbol('on-drop-key');
+export class DndContext {
+    feedback;
+    constructor(options = {}) {
+        this.feedback = options.feedback ?? (() => undefined);
+    }
+    #droppables = new SvelteMap();
+    sourceId = $state.raw();
+    targetId = $state.raw();
+    get droppables() {
+        return this.#droppables;
+    }
+    findDroppable(x, y, draggable) {
+        for (const d of this.#droppables.values()) {
+            if (d.element === undefined) {
+                continue;
+            }
+            const r = d.element.getBoundingClientRect();
+            if (x < r.left || x > r.right || y < r.top || y > r.bottom) {
+                continue;
+            }
+            if (d.accepts(draggable)) {
+                return d;
+            }
+        }
+    }
+}
+export class Draggable {
+    ctx;
+    options;
+    #disposePointerDownHandler;
+    #disposeClickHandler;
+    #didDrag = false;
+    #baseElement;
+    #hasHandel = false;
+    id = crypto.randomUUID();
+    constructor(ctx, options = {}) {
+        this.ctx = ctx;
+        this.options = options;
+        this.register = this.register.bind(this);
+        this.registerHandel = this.registerHandel.bind(this);
+    }
+    get isDragged() {
+        return this.ctx.sourceId === this.id;
+    }
+    get data() {
+        return this.options.data;
+    }
+    register(el) {
+        if (!this.#hasHandel) {
+            this[Symbol.dispose]();
+            this.addEventHandlers(el);
+        }
+        this.#baseElement = el;
+        return () => {
+            this.#baseElement = undefined;
+            if (!this.#hasHandel) {
+                this[Symbol.dispose]();
+            }
+        };
+    }
+    registerHandel(el) {
+        this[Symbol.dispose]();
+        this.addEventHandlers(el);
+        this.#hasHandel = true;
+        return () => {
+            this.#hasHandel = false;
+            this[Symbol.dispose]();
+        };
+    }
+    [Symbol.dispose]() {
+        this.#disposeClickHandler?.();
+        this.#disposePointerDownHandler?.();
+    }
+    onStart(_e, _el) { }
+    onMove(_e) { }
+    onStop(_e) { }
+    addEventHandlers(el) {
+        this.#disposePointerDownHandler = on(el, 'pointerdown', (e) => this.pointerDownHandler(e));
+        this.#disposeClickHandler = on(el, 'click', (e) => {
+            if (!this.#didDrag) {
+                return;
+            }
+            e.stopImmediatePropagation();
+            e.preventDefault();
+            this.#didDrag = false;
+        }, { capture: true });
+    }
+    // NOTE: I believe this logic should be in `DndContext`, but it is difficult to
+    // separate and there is no specific reason to do so right now.
+    pointerDownHandler(event) {
+        if (event.button !== 0 ||
+            !event.isPrimary ||
+            event.composedPath().some((n) => n instanceof HTMLButtonElement)) {
+            return;
+        }
+        const el = event.currentTarget;
+        el.setPointerCapture(event.pointerId);
+        const abortController = new AbortController();
+        let feedback;
+        let activeDroppable;
+        const handleMove = (e) => {
+            if (e.pointerId !== event.pointerId) {
+                return;
+            }
+            if (!this.#didDrag) {
+                const dx = e.clientX - event.clientX;
+                const dy = e.clientY - event.clientY;
+                if (dx * dx + dy * dy < 16) {
+                    return;
+                }
+                this.#didDrag = true;
+                this.ctx.sourceId = this.id;
+                feedback = this.ctx.feedback(e, this.#baseElement ?? el);
+                this.onStart(e, el);
+            }
+            this.onMove(e);
+            feedback?.onMove(e);
+            const nextDroppable = this.ctx.findDroppable(e.clientX, e.clientY, this);
+            if (activeDroppable !== nextDroppable) {
+                activeDroppable?.[ON_LEAVE]();
+                nextDroppable?.[ON_ENTER]();
+                activeDroppable = nextDroppable;
+                this.ctx.targetId = activeDroppable?.id;
+            }
+            activeDroppable?.[ON_MOVE](e);
+        };
+        const handleStop = (ev) => {
+            el.releasePointerCapture(event.pointerId);
+            abortController.abort();
+            if (!this.#didDrag) {
+                return;
+            }
+            const snap = ev.reason === 'drop' ? $state.snapshot(this.options.data) : undefined;
+            activeDroppable?.[ON_LEAVE]();
+            feedback?.onStop(ev);
+            this.onStop(ev);
+            if (ev.reason === 'drop') {
+                flushSync(() => {
+                    activeDroppable?.[ON_DROP](snap, this);
+                });
+            }
+            this.ctx.targetId = undefined;
+            this.ctx.sourceId = undefined;
+        };
+        function onKeydown(e) {
+            if (e.key === 'Escape') {
+                handleStop({ reason: 'cancel' });
+            }
+        }
+        window.addEventListener('pointermove', handleMove, abortController);
+        window.addEventListener('pointerup', (e) => {
+            if (e.pointerId !== event.pointerId) {
+                return;
+            }
+            handleStop({
+                reason: activeDroppable === undefined ? 'cancel' : 'drop',
+            });
+        }, abortController);
+        window.addEventListener('keydown', onKeydown, abortController);
+        window.addEventListener('contextmenu', () => handleStop({ reason: 'cancel' }), abortController);
+    }
+}
+export class Droppable {
+    ctx;
+    #element = $state.raw();
+    id = crypto.randomUUID();
+    constructor(ctx) {
+        this.ctx = ctx;
+        this.register = this.register.bind(this);
+    }
+    get element() {
+        return this.#element;
+    }
+    get isOver() {
+        return this.ctx.targetId === this.id;
+    }
+    [Symbol.dispose]() {
+        this.#element = undefined;
+        this.ctx.droppables.delete(this.id);
+    }
+    register(el) {
+        this[Symbol.dispose]();
+        this.ctx.droppables.set(this.id, this);
+        this.#element = el;
+        return () => {
+            this[Symbol.dispose]();
+        };
+    }
+    accepts(draggable) {
+        return true;
+    }
+    [ON_ENTER]() {
+        this.onEnter();
+    }
+    [ON_MOVE](e) {
+        this.onMove(e);
+    }
+    [ON_LEAVE]() {
+        this.onLeave();
+    }
+    [ON_DROP](data, draggable) {
+        this.onDrop(data, draggable);
+    }
+    onEnter() { }
+    onMove(_e) { }
+    onLeave() { }
+    onDrop(_data, _draggable) { }
+}
+export class ClonedGhost {
+    #element;
+    #offsetX;
+    #offsetY;
+    constructor(el, e) {
+        const rect = el.getBoundingClientRect();
+        this.#element = el.cloneNode(true);
+        this.#offsetX = e.clientX - rect.left;
+        this.#offsetY = e.clientY - rect.top;
+        this.#element.style.position = 'fixed';
+        this.#element.style.left = '0';
+        this.#element.style.top = '0';
+        this.#element.style.width = `${rect.width}px`;
+        this.#element.style.height = `${rect.height}px`;
+        this.#element.style.pointerEvents = 'none';
+        this.#element.style.zIndex = '9999';
+        this.#element.style.opacity = '0.85';
+        this.onMove(e);
+    }
+    attach(root) {
+        root.appendChild(this.#element);
+        return this;
+    }
+    onMove(e) {
+        const x = e.clientX - this.#offsetX;
+        const y = e.clientY - this.#offsetY;
+        this.#element.style.transform = `translate3d(${x}px, ${y}px, 0)`;
+    }
+    onStop() {
+        this.#element.remove();
+    }
+}

package/dist/shared/math.d.ts

@@ -0,0 +1 @@
+export declare function almostEqual(a: number, b: number, eps?: number): boolean;

package/dist/shared/math.js

@@ -0,0 +1,3 @@
+export function almostEqual(a, b, eps = 1e-6) {
+    return Math.abs(a - b) < eps;
+}

package/dist/shared/registry.d.ts

@@ -0,0 +1,9 @@
+export interface Registry<K, V> {
+    get(key: K): V;
+}
+export interface MutableRegistry<K, V> extends Registry<K, V> {
+    set(key: K, val: V): void;
+    delete(key: K): void;
+}
+export declare function fromRecord<R extends Record<string, unknown>>(record: R): Registry<keyof R, R[keyof R]>;
+export declare function fromConstant<V>(value: V): Registry<any, V>;

package/dist/shared/registry.js

@@ -0,0 +1,14 @@
+export function fromRecord(record) {
+    return {
+        get(key) {
+            return record[key];
+        },
+    };
+}
+export function fromConstant(value) {
+    return {
+        get() {
+            return value;
+        },
+    };
+}

package/dist/shared/spatial.d.ts

@@ -0,0 +1,7 @@
+export type Direction = 'row' | 'column';
+export type EdgePart = 'start' | 'center' | 'end';
+export declare function getEdgePart(a: number, b: number, x: number, ratio: number): EdgePart | undefined;
+export declare function getRectParts(rect: DOMRect, x: number, y: number, ratio: number): {
+    hpart: EdgePart | undefined;
+    vpart: EdgePart | undefined;
+};