@pixerate/editor-react 0.68.1 → 0.70.0

package/dist/vector/index.d.cts

@@ -1,4 +1,4 @@
-import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
+import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderMask, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
 import React__default from 'react';
 
 /** A `VectorEditorController` created once for the component's lifetime (destroyed on unmount). */
@@ -64,6 +64,15 @@ declare function VectorFilterDefs({ filters }: {
 declare function VectorSceneNodes({ nodes }: {
     nodes: readonly VectorRenderNode[];
 }): React__default.JSX.Element;
+/**
+ * A mask group's contents under its mask: the `<clipPath>` (clip) or `<mask>` (alpha, luminance;
+ * the mask drawn inside, through the inverting filter when inverted), and an inner `<g>` that
+ * references it. The group's own transform, opacity, blend mode and filter are on the outer `<g>`.
+ */
+declare function VectorMaskedNodes({ mask, nodes }: {
+    mask: VectorRenderMask;
+    nodes: readonly VectorRenderNode[];
+}): React__default.JSX.Element;
 /**
  * An SVG canvas for a `VectorEditorController`: draws the document and the editing overlay
  * and forwards pointer, wheel, keyboard and clipboard events. Focus it to use shortcuts.
@@ -149,6 +158,18 @@ interface VectorEnvelopePanelProps {
  */
 declare function VectorEnvelopePanel({ controller, className }: VectorEnvelopePanelProps): React__default.JSX.Element | null;
 
+interface VectorMaskPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Masks of the selection: Make Clipping Mask, Make Opacity Mask (the topmost selected object
+ * masks the others) and Release; for a mask group (or something inside one) its type, Invert, a
+ * switch that turns the mask off by hiding it, and Edit Mask / Edit Contents, which select the mask
+ * (a path opens for anchor editing) or what it masks. Each change is one undo step.
+ */
+declare function VectorMaskPanel({ controller, className }: VectorMaskPanelProps): React__default.JSX.Element | null;
+
 interface VectorEditorProps {
     controller: VectorEditorController;
     /** Tools in the toolbar (default: all). */
@@ -187,4 +208,4 @@ 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, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };
+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 };

package/dist/vector/index.d.ts

@@ -1,4 +1,4 @@
-import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
+import { VectorEditorController, VectorEditorState, VectorTool, VectorCommandOptions, VectorEditorOptions, VectorRenderFilter, VectorRenderGradientAnnotator, VectorPaintDef, VectorRenderMask, VectorRenderNode, VectorWidthPointEdit } from '@pixerate/editor/vector';
 import React__default from 'react';
 
 /** A `VectorEditorController` created once for the component's lifetime (destroyed on unmount). */
@@ -64,6 +64,15 @@ declare function VectorFilterDefs({ filters }: {
 declare function VectorSceneNodes({ nodes }: {
     nodes: readonly VectorRenderNode[];
 }): React__default.JSX.Element;
+/**
+ * A mask group's contents under its mask: the `<clipPath>` (clip) or `<mask>` (alpha, luminance;
+ * the mask drawn inside, through the inverting filter when inverted), and an inner `<g>` that
+ * references it. The group's own transform, opacity, blend mode and filter are on the outer `<g>`.
+ */
+declare function VectorMaskedNodes({ mask, nodes }: {
+    mask: VectorRenderMask;
+    nodes: readonly VectorRenderNode[];
+}): React__default.JSX.Element;
 /**
  * An SVG canvas for a `VectorEditorController`: draws the document and the editing overlay
  * and forwards pointer, wheel, keyboard and clipboard events. Focus it to use shortcuts.
@@ -149,6 +158,18 @@ interface VectorEnvelopePanelProps {
  */
 declare function VectorEnvelopePanel({ controller, className }: VectorEnvelopePanelProps): React__default.JSX.Element | null;
 
+interface VectorMaskPanelProps {
+    controller: VectorEditorController;
+    className?: string;
+}
+/**
+ * Masks of the selection: Make Clipping Mask, Make Opacity Mask (the topmost selected object
+ * masks the others) and Release; for a mask group (or something inside one) its type, Invert, a
+ * switch that turns the mask off by hiding it, and Edit Mask / Edit Contents, which select the mask
+ * (a path opens for anchor editing) or what it masks. Each change is one undo step.
+ */
+declare function VectorMaskPanel({ controller, className }: VectorMaskPanelProps): React__default.JSX.Element | null;
+
 interface VectorEditorProps {
     controller: VectorEditorController;
     /** Tools in the toolbar (default: all). */
@@ -187,4 +208,4 @@ 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, VectorSceneNodes, VectorStylePanel, type VectorStylePanelProps, VectorToolbar, type VectorToolbarProps, VectorWidthPointEditor, type VectorWidthPointEditorProps, useVectorCommands, useVectorEditor, useVectorEditorController, useVectorEditorState };
+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 };