@pixerate/editor 0.251.0 → 0.253.0

package/dist/brushes/ui.d.ts

@@ -0,0 +1,105 @@
+/**
+ * The brush editor as data, for the React and Svelte `BrushEditor` and `BrushLibraryBrowser`:
+ * `brushEditorSections` lists a brush's facets as ordered sections of controls (Medium, Shape,
+ * Marks, Feel, Behaviour, Light, Motion, Colour), each control a facet path with its value,
+ * range and label, leaving out what the host profile can't render. `setBrushEditorValue` applies
+ * one control's change; `brushLibraryGroups` groups a library by medium and variety, tools apart.
+ *
+ * Sliders reuse the paint editor's tables (`BRUSH_SLIDERS`, `brushEngineControls`), mapped from
+ * engine paths to facet paths through `BRUSH_FIELDS`, so the panels and the editor agree.
+ */
+import type { BrushLibraryEntry } from './library.js';
+import { type BrushHostProfile } from './profiles.js';
+import { type Brush } from './types.js';
+export type BrushEditorSectionId = 'medium' | 'shape' | 'marks' | 'feel' | 'behaviour' | 'light' | 'motion' | 'colour';
+interface ControlBase {
+    /** Facet path the control sets (`tip.size`, `behaviour.exchange.pickup`…). */
+    path: string;
+    label: string;
+    /** Accessible name (stable across hosts, for tests and assistive tech). */
+    ariaLabel: string;
+    /** Set when the host paints without this setting (its profile ignores it). */
+    note?: string;
+}
+export type BrushEditorControl = (ControlBase & {
+    kind: 'slider';
+    min: number;
+    max: number;
+    step: number;
+    value: number;
+}) | (ControlBase & {
+    kind: 'choice';
+    options: ReadonlyArray<{
+        value: string;
+        label: string;
+    }>;
+    value: string;
+}) | (ControlBase & {
+    kind: 'toggle';
+    value: boolean;
+}) | (ControlBase & {
+    kind: 'text';
+    value: string;
+    placeholder?: string;
+})
+/** A solid colour (#rrggbb), or `null` when there is none (or the default is a gradient or effect). */
+ | (ControlBase & {
+    kind: 'colour';
+    value: string | null;
+}) | (ControlBase & {
+    kind: 'palette';
+    value: string[];
+    max: number;
+})
+/** Stamp refs (`editor:star`…): `options` are the editor's stamps; hosts may offer more refs. */
+ | (ControlBase & {
+    kind: 'stamps';
+    value: string[];
+    max: number;
+    options: ReadonlyArray<{
+        value: string;
+        label: string;
+    }>;
+});
+export interface BrushEditorSection {
+    id: BrushEditorSectionId;
+    title: string;
+    controls: BrushEditorControl[];
+}
+/**
+ * Sections of controls for a brush, in order, as the host `profile` (default the paint editor)
+ * can render them: sections and controls it refuses are left out, ones it paints without carry
+ * a note. Values are the brush's own, else the defaults of the engine it resolves to.
+ */
+export declare function brushEditorSections(brush: Brush, profile?: BrushHostProfile): BrushEditorSection[];
+/**
+ * The brush with one control's value set (`undefined` removes it), normalised. Changing the kind,
+ * the marks or the tip shape starts that facet afresh. Returns the brush and what was clamped or
+ * dropped; an invalid change returns the brush unchanged with the reason.
+ */
+export declare function setBrushEditorValue(brush: Brush, path: string, value: unknown): {
+    brush: Brush;
+    problems: string[];
+};
+export interface BrushLibraryGroup {
+    /** `tools`, or a medium (`paint`, `ink`, `dry`, `spray`), or `other`. */
+    id: string;
+    title: string;
+    /** Brushes by variety (`''`: no variety), in library order. */
+    varieties: Array<{
+        variety: string;
+        title: string;
+        entries: BrushLibraryEntry[];
+    }>;
+}
+/**
+ * A library grouped for a browser: marks by medium, then variety; tools as their own group.
+ * `text` keeps brushes whose id, name, variety or tags start with each word; `profile` keeps only
+ * what that host renders.
+ */
+export declare function brushLibraryGroups(entries: readonly BrushLibraryEntry[], filter?: {
+    text?: string;
+    profile?: BrushHostProfile;
+    source?: 'builtin' | 'user';
+}): BrushLibraryGroup[];
+export {};