@pixerate/editor 0.258.0 → 0.260.0

package/dist/vector/controller.d.cts

@@ -104,6 +104,8 @@ export interface VectorEditorOptions {
      * profile decides which). Share one with the paint editor so a brush saved there paints here.
      */
     brushLibrary?: Pick<BrushLibrary, 'list' | 'subscribe'>;
+    /** The app's colour scheme, which picks the side of a brush's light / dark default colour (default light). */
+    colorScheme?: 'light' | 'dark';
     /** History to record into, e.g. one shared with the rest of the app (default: a new one). */
     history?: HistoryManager;
     /** Starting tool (default `select`). */
@@ -789,6 +791,7 @@ export declare class VectorEditorController {
     private committing;
     private revision;
     private state;
+    private colorScheme;
     constructor(options?: VectorEditorOptions);
     /** Listens to the history (once; again after `destroy`). */
     private connect;
@@ -1117,7 +1120,8 @@ export declare class VectorEditorController {
      * Adds a brushstroke to the selected (or given) paths: a stroke layer that paints the path with
      * brush `brushId` (a preset, or a saved brush of the brush library: `listBrushstrokeBrushes`), `size` document
      * units across (default the brush's own), an optional `pressure` profile along the length, in
-     * `color` (default the top stroke's paint, else black) at `opacity`. At the top of the stroke
+     * `color` (default the brush's own default colour, unless `keepColour`; else the top stroke's
+     * paint, else black) at `opacity`. At the top of the stroke
      * stack or at `index`. A `seed` gives it the brush's character (jitter and the grain of `paper`,
      * `null` for none); without one it renders plain. One undo step.
      */
@@ -1125,13 +1129,15 @@ export declare class VectorEditorController {
         ids?: readonly string[];
         index?: number;
         color?: string;
+        keepColour?: boolean;
         opacity?: number;
     }): VectorActionResult;
     /**
      * Changes brushstroke layer `index` (in the stroke stack, 0 is the bottom) of the selected (or
      * given) paths: another brush, size, pressure profile (null removes it), colour or opacity, the
      * character `seed` (null removes it: plain dabs) or the `paper` (replaced whole: `null` for no
-     * grain, `{}` for the default paper). Fails, changing nothing, when that layer is not a
+     * grain, `{}` for the default paper). Another brush without a `color` takes that brush's default
+     * colour, if it has one, unless `keepColour`. Fails, changing nothing, when that layer is not a
      * brushstroke. With `merge`, consecutive edits fold into one undo step.
      */
     setBrushstroke(index: number, patch: {
@@ -1139,6 +1145,7 @@ export declare class VectorEditorController {
         size?: number | null;
         pressure?: number[] | null;
         color?: string;
+        keepColour?: boolean;
         opacity?: number;
         seed?: number | null;
         paper?: VectorBrushstrokePaper | null;
@@ -1146,6 +1153,8 @@ export declare class VectorEditorController {
         ids?: readonly string[];
         merge?: boolean | string;
     }): VectorActionResult;
+    /** Sets the colour scheme that picks the side of a brush's light / dark default colour. Existing strokes keep their colour. */
+    setColorScheme(scheme: 'light' | 'dark'): void;
     /** Removes layer `index` of the fill or stroke stack of the selected (or given) paths. */
     removePaintLayer(kind: 'fill' | 'stroke', index: number, options?: {
         ids?: readonly string[];

package/dist/vector/controller.d.ts

@@ -104,6 +104,8 @@ export interface VectorEditorOptions {
      * profile decides which). Share one with the paint editor so a brush saved there paints here.
      */
     brushLibrary?: Pick<BrushLibrary, 'list' | 'subscribe'>;
+    /** The app's colour scheme, which picks the side of a brush's light / dark default colour (default light). */
+    colorScheme?: 'light' | 'dark';
     /** History to record into, e.g. one shared with the rest of the app (default: a new one). */
     history?: HistoryManager;
     /** Starting tool (default `select`). */
@@ -789,6 +791,7 @@ export declare class VectorEditorController {
     private committing;
     private revision;
     private state;
+    private colorScheme;
     constructor(options?: VectorEditorOptions);
     /** Listens to the history (once; again after `destroy`). */
     private connect;
@@ -1117,7 +1120,8 @@ export declare class VectorEditorController {
      * Adds a brushstroke to the selected (or given) paths: a stroke layer that paints the path with
      * brush `brushId` (a preset, or a saved brush of the brush library: `listBrushstrokeBrushes`), `size` document
      * units across (default the brush's own), an optional `pressure` profile along the length, in
-     * `color` (default the top stroke's paint, else black) at `opacity`. At the top of the stroke
+     * `color` (default the brush's own default colour, unless `keepColour`; else the top stroke's
+     * paint, else black) at `opacity`. At the top of the stroke
      * stack or at `index`. A `seed` gives it the brush's character (jitter and the grain of `paper`,
      * `null` for none); without one it renders plain. One undo step.
      */
@@ -1125,13 +1129,15 @@ export declare class VectorEditorController {
         ids?: readonly string[];
         index?: number;
         color?: string;
+        keepColour?: boolean;
         opacity?: number;
     }): VectorActionResult;
     /**
      * Changes brushstroke layer `index` (in the stroke stack, 0 is the bottom) of the selected (or
      * given) paths: another brush, size, pressure profile (null removes it), colour or opacity, the
      * character `seed` (null removes it: plain dabs) or the `paper` (replaced whole: `null` for no
-     * grain, `{}` for the default paper). Fails, changing nothing, when that layer is not a
+     * grain, `{}` for the default paper). Another brush without a `color` takes that brush's default
+     * colour, if it has one, unless `keepColour`. Fails, changing nothing, when that layer is not a
      * brushstroke. With `merge`, consecutive edits fold into one undo step.
      */
     setBrushstroke(index: number, patch: {
@@ -1139,6 +1145,7 @@ export declare class VectorEditorController {
         size?: number | null;
         pressure?: number[] | null;
         color?: string;
+        keepColour?: boolean;
         opacity?: number;
         seed?: number | null;
         paper?: VectorBrushstrokePaper | null;
@@ -1146,6 +1153,8 @@ export declare class VectorEditorController {
         ids?: readonly string[];
         merge?: boolean | string;
     }): VectorActionResult;
+    /** Sets the colour scheme that picks the side of a brush's light / dark default colour. Existing strokes keep their colour. */
+    setColorScheme(scheme: 'light' | 'dark'): void;
     /** Removes layer `index` of the fill or stroke stack of the selected (or given) paths. */
     removePaintLayer(kind: 'fill' | 'stroke', index: number, options?: {
         ids?: readonly string[];