@pixerate/editor-react 0.31.0 → 0.33.0

package/dist/vector/index.d.ts

@@ -1,4 +1,4 @@
-import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, SvgGradientDef, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
+import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
 import React__default from 'react';
 
 /** A `VectorEditorController` created once for the component's lifetime (destroyed on unmount). */
@@ -44,10 +44,18 @@ interface VectorCanvasProps {
     /** Accessible label (default "Vector canvas"). */
     'aria-label'?: string;
 }
-/** Renders `<linearGradient>` / `<radialGradient>` descriptors. */
+/**
+ * Renders paint servers: `<linearGradient>` / `<radialGradient>` descriptors and patterns of
+ * gradient tiles (conic, diamond and stroke-mode gradients).
+ */
 declare function VectorGradientDefs({ defs }: {
-    defs: readonly SvgGradientDef[];
+    defs: readonly VectorPaintDef[];
 }): React__default.JSX.Element | null;
+/** The gradient tool's annotator (screen space): extent, bar, handles, stop chips and midpoints. */
+declare function VectorGradientAnnotator({ annotator: g, accentColor }: {
+    annotator: VectorRenderGradientAnnotator;
+    accentColor?: string;
+}): React__default.JSX.Element;
 /** Renders scene nodes (paths and groups) from `getVectorSceneRenderData`. */
 declare function VectorSceneNodes({ nodes }: {
     nodes: readonly VectorRenderNode[];
@@ -105,12 +113,24 @@ interface VectorStylePanelProps {
     className?: string;
 }
 /**
- * Fill, stroke, stroke width, alignment and width profile, arrowheads, live corner radius and opacity of the
+ * Fill, stroke and their gradients (`VectorGradientEditor`), stroke width, alignment and width profile, arrowheads, live corner radius, opacity and path effects (`VectorEffectsPanel`) of the
  * selection (corners of the selected points with the direct tool); with nothing selected it
  * edits the defaults for new shapes.
  */
 declare function VectorStylePanel({ controller, className }: VectorStylePanelProps): React__default.JSX.Element;
 
+interface VectorEffectsPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * The live path effects of the selection: add effects (to every selected node), and for one
+ * selected node list its stack (applied top to bottom) to turn on and off, reorder, remove and
+ * edit. Slider drags and typing are one undo step each. Expand Appearance bakes the effects and
+ * live booleans into plain paths.
+ */
+declare function VectorEffectsPanel({ controller, className }: VectorEffectsPanelProps): React__default.JSX.Element | null;
+
 interface VectorEditorProps {
     controller: VectorEditorController;
     /** Tools in the toolbar (default: all). */
@@ -125,4 +145,15 @@ interface VectorEditorProps {
 /** Toolbar, canvas and style panel for a `VectorEditorController`. */
 declare function VectorEditor({ controller, tools, showStylePanel, height, canvasProps, className }: VectorEditorProps): React__default.JSX.Element;
 
-export { type UseVectorEditorResult, VectorCanvas, type VectorCanvasProps, type VectorCommandTarget, VectorEditor, type VectorEditorProps, VectorGradientDefs, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };
+interface VectorGradientEditorProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Gradient editor for the selection's fill or stroke: style (or solid), the stop ramp (click it
+ * to add a stop, pick a stop to edit its colour, opacity, position and midpoint), interpolation
+ * space, smoothness, spread, how it lies on a stroke, and reverse.
+ */
+declare function VectorGradientEditor({ controller, className }: VectorGradientEditorProps): React__default.JSX.Element | null;
+
+export { type UseVectorEditorResult, VectorCanvas, type VectorCanvasProps, type VectorCommandTarget, VectorEditor, type VectorEditorProps, VectorEffectsPanel, type VectorEffectsPanelProps, VectorGradientAnnotator, VectorGradientDefs, VectorGradientEditor, type VectorGradientEditorProps, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };