@pixerate/editor-react 0.72.0 → 0.73.0

package/dist/vector/index.d.cts

@@ -1,4 +1,4 @@
-import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderMask, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
+import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderMask, VectorRenderNode, VectorRenderText, VectorWidthPointEdit } from '@pixerate/editor/vector';
 import React__default from 'react';
 
 /** A `VectorEditorController` created once for the component's lifetime (destroyed on unmount). */
@@ -60,7 +60,14 @@ declare function VectorGradientAnnotator({ annotator: g, accentColor }: {
 declare function VectorFilterDefs({ filters }: {
     filters: readonly VectorRenderFilter[];
 }): React__default.JSX.Element | null;
-/** Renders scene nodes (paths and groups) from `getVectorSceneRenderData`. */
+/**
+ * Text drawn as SVG text: one `<text>` per paint layer, every span a `<tspan>` placed character by
+ * character (the layout is the editor's, not the browser's).
+ */
+declare function VectorTextElement({ node }: {
+    node: VectorRenderText;
+}): React__default.JSX.Element;
+/** Renders scene nodes (paths, text and groups) from `getVectorSceneRenderData`. */
 declare function VectorSceneNodes({ nodes }: {
     nodes: readonly VectorRenderNode[];
 }): React__default.JSX.Element;
@@ -208,4 +215,61 @@ interface VectorAppearancePanelProps {
  */
 declare function VectorAppearancePanel({ controller, className }: VectorAppearancePanelProps): React__default.JSX.Element | null;
 
-export { type UseVectorEditorResult, VectorAppearancePanel, type VectorAppearancePanelProps, VectorCanvas, type VectorCanvasProps, type VectorCommandTarget, VectorEditor, type VectorEditorProps, VectorEffectsPanel, type VectorEffectsPanelProps, VectorEnvelopePanel, type VectorEnvelopePanelProps, VectorFilterDefs, VectorGradientAnnotator, VectorGradientDefs, VectorGradientEditor, type VectorGradientEditorProps, VectorMaskPanel, type VectorMaskPanelProps, VectorMaskedNodes, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };
+interface VectorTextPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Character and paragraph style of text: family, weight, size, italic, underline, strike-through,
+ * tracking, leading, alignment and point / area text. It edits the selected characters while text
+ * is being edited, else the selected text, else the defaults for new text. Type on a Path turns a
+ * selected path into path text, and Create Outlines turns text into paths (with an outline
+ * shaper). Each change is one undo step.
+ */
+declare function VectorTextPanel({ controller, className }: VectorTextPanelProps): React__default.JSX.Element | null;
+
+interface VectorSymbolsPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Symbols of the document with previews: New Symbol from the selection, Place, Edit (isolation
+ * mode) and Delete per symbol; for a selected instance, Replace, Scale strokes, a fill tint and
+ * Detach. Each change is one undo step.
+ */
+declare function VectorSymbolsPanel({ controller, className }: VectorSymbolsPanelProps): React__default.JSX.Element;
+
+interface VectorConstraintsPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Constraints: the degrees of freedom left, the constraints the selection allows (pick anchors with
+ * the direct tool, or round paths), Auto Constrain, the constraints of the selection with their
+ * values, and the named parameters. Each change is one undo step.
+ */
+declare function VectorConstraintsPanel({ controller, className }: VectorConstraintsPanelProps): React__default.JSX.Element | null;
+
+interface VectorFramePanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Frames (artboards): Frame Selection; for a selected frame its position, size (its children
+ * follow their constraints), background and clipping; for objects inside a frame their resizing
+ * constraints. Each change is one undo step (sizes apply on Enter or blur).
+ */
+declare function VectorFramePanel({ controller, className }: VectorFramePanelProps): React__default.JSX.Element;
+
+interface VectorConnectorPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * The selected connector: its route (straight, elbow, curved), the elbow corner radius, and for
+ * each glued end the side it meets (Auto: the side facing the other end) and Unglue. Each change is
+ * one undo step.
+ */
+declare function VectorConnectorPanel({ controller, className }: VectorConnectorPanelProps): React__default.JSX.Element | null;
+
+export { type UseVectorEditorResult, VectorAppearancePanel, type VectorAppearancePanelProps, VectorCanvas, type VectorCanvasProps, type VectorCommandTarget, VectorConnectorPanel, type VectorConnectorPanelProps, VectorConstraintsPanel, type VectorConstraintsPanelProps, VectorEditor, type VectorEditorProps, VectorEffectsPanel, type VectorEffectsPanelProps, VectorEnvelopePanel, type VectorEnvelopePanelProps, VectorFilterDefs, VectorFramePanel, type VectorFramePanelProps, VectorGradientAnnotator, VectorGradientDefs, VectorGradientEditor, type VectorGradientEditorProps, VectorMaskPanel, type VectorMaskPanelProps, VectorMaskedNodes, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorSymbolsPanel, type VectorSymbolsPanelProps, VectorTextElement, VectorTextPanel, type VectorTextPanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };

package/dist/vector/index.d.ts

@@ -1,4 +1,4 @@
-import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderMask, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
+import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderMask, VectorRenderNode, VectorRenderText, VectorWidthPointEdit } from '@pixerate/editor/vector';
 import React__default from 'react';
 
 /** A `VectorEditorController` created once for the component's lifetime (destroyed on unmount). */
@@ -60,7 +60,14 @@ declare function VectorGradientAnnotator({ annotator: g, accentColor }: {
 declare function VectorFilterDefs({ filters }: {
     filters: readonly VectorRenderFilter[];
 }): React__default.JSX.Element | null;
-/** Renders scene nodes (paths and groups) from `getVectorSceneRenderData`. */
+/**
+ * Text drawn as SVG text: one `<text>` per paint layer, every span a `<tspan>` placed character by
+ * character (the layout is the editor's, not the browser's).
+ */
+declare function VectorTextElement({ node }: {
+    node: VectorRenderText;
+}): React__default.JSX.Element;
+/** Renders scene nodes (paths, text and groups) from `getVectorSceneRenderData`. */
 declare function VectorSceneNodes({ nodes }: {
     nodes: readonly VectorRenderNode[];
 }): React__default.JSX.Element;
@@ -208,4 +215,61 @@ interface VectorAppearancePanelProps {
  */
 declare function VectorAppearancePanel({ controller, className }: VectorAppearancePanelProps): React__default.JSX.Element | null;
 
-export { type UseVectorEditorResult, VectorAppearancePanel, type VectorAppearancePanelProps, VectorCanvas, type VectorCanvasProps, type VectorCommandTarget, VectorEditor, type VectorEditorProps, VectorEffectsPanel, type VectorEffectsPanelProps, VectorEnvelopePanel, type VectorEnvelopePanelProps, VectorFilterDefs, VectorGradientAnnotator, VectorGradientDefs, VectorGradientEditor, type VectorGradientEditorProps, VectorMaskPanel, type VectorMaskPanelProps, VectorMaskedNodes, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };
+interface VectorTextPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Character and paragraph style of text: family, weight, size, italic, underline, strike-through,
+ * tracking, leading, alignment and point / area text. It edits the selected characters while text
+ * is being edited, else the selected text, else the defaults for new text. Type on a Path turns a
+ * selected path into path text, and Create Outlines turns text into paths (with an outline
+ * shaper). Each change is one undo step.
+ */
+declare function VectorTextPanel({ controller, className }: VectorTextPanelProps): React__default.JSX.Element | null;
+
+interface VectorSymbolsPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Symbols of the document with previews: New Symbol from the selection, Place, Edit (isolation
+ * mode) and Delete per symbol; for a selected instance, Replace, Scale strokes, a fill tint and
+ * Detach. Each change is one undo step.
+ */
+declare function VectorSymbolsPanel({ controller, className }: VectorSymbolsPanelProps): React__default.JSX.Element;
+
+interface VectorConstraintsPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Constraints: the degrees of freedom left, the constraints the selection allows (pick anchors with
+ * the direct tool, or round paths), Auto Constrain, the constraints of the selection with their
+ * values, and the named parameters. Each change is one undo step.
+ */
+declare function VectorConstraintsPanel({ controller, className }: VectorConstraintsPanelProps): React__default.JSX.Element | null;
+
+interface VectorFramePanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Frames (artboards): Frame Selection; for a selected frame its position, size (its children
+ * follow their constraints), background and clipping; for objects inside a frame their resizing
+ * constraints. Each change is one undo step (sizes apply on Enter or blur).
+ */
+declare function VectorFramePanel({ controller, className }: VectorFramePanelProps): React__default.JSX.Element;
+
+interface VectorConnectorPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * The selected connector: its route (straight, elbow, curved), the elbow corner radius, and for
+ * each glued end the side it meets (Auto: the side facing the other end) and Unglue. Each change is
+ * one undo step.
+ */
+declare function VectorConnectorPanel({ controller, className }: VectorConnectorPanelProps): React__default.JSX.Element | null;
+
+export { type UseVectorEditorResult, VectorAppearancePanel, type VectorAppearancePanelProps, VectorCanvas, type VectorCanvasProps, type VectorCommandTarget, VectorConnectorPanel, type VectorConnectorPanelProps, VectorConstraintsPanel, type VectorConstraintsPanelProps, VectorEditor, type VectorEditorProps, VectorEffectsPanel, type VectorEffectsPanelProps, VectorEnvelopePanel, type VectorEnvelopePanelProps, VectorFilterDefs, VectorFramePanel, type VectorFramePanelProps, VectorGradientAnnotator, VectorGradientDefs, VectorGradientEditor, type VectorGradientEditorProps, VectorMaskPanel, type VectorMaskPanelProps, VectorMaskedNodes, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorSymbolsPanel, type VectorSymbolsPanelProps, VectorTextElement, VectorTextPanel, type VectorTextPanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };