@filekit-studio/sketch 1.1.1 → 1.1.3

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import React__default from 'react';
-import { S as SketchBoardElement, G as GridStyle, C as Camera, P as Point, T as ToolType, L as LaserMode, a as LaserStroke } from './index-DNRZSQHn.js';
-export { A as AnchorPosition, b as ArrowType, c as Arrowhead, d as CanvasDimensions, E as EdgeStyle, e as ElementType, f as ExportPdfOptions, g as ExportPdfResult, F as FillStyle, h as FontFamily, i as LaserPoint, M as MarqueeBox, j as PointBinding, R as ResizeHandle, k as StrokeStyle, l as TableCell, m as TablePresetStyle, n as TextAlign, o as copyImageToClipboard, p as downloadFile, q as exportFrameToPng, r as exportToPng, s as exportToSvg, t as exportWhiteboardToPdf, u as getElementsBoundingBox } from './index-DNRZSQHn.js';
+import { S as SketchBoardElement, G as GridStyle, C as Camera, P as Point, T as ToolType, L as LaserMode, a as LaserStroke } from './index-BBEbI15I.js';
+export { A as AnchorPosition, b as ArrowType, c as Arrowhead, d as CanvasDimensions, E as EdgeStyle, e as ElementType, f as ExportPdfOptions, g as ExportPdfResult, F as FillStyle, h as FontFamily, i as LaserPoint, M as MarqueeBox, j as PointBinding, R as ResizeHandle, k as StrokeStyle, l as TableCell, m as TablePresetStyle, n as TextAlign, o as copyImageToClipboard, p as downloadFile, q as exportFrameToPng, r as exportToPng, s as exportToSvg, t as exportWhiteboardToPdf, u as getElementsBoundingBox } from './index-BBEbI15I.js';
 
 /**
  * Document schema, initialization, serialization, and validation.
@@ -100,67 +100,133 @@ declare function useSketchTheme(themeProp?: ThemeMode): {
 
 /** Default starter elements provided when no document is supplied */
 declare const DEFAULT_STARTER_ELEMENTS: SketchBoardElement[];
+/**
+ * Comprehensive UI visibility configuration for @filekit-studio/sketch.
+ * Controls every macro panel and granular micro-tool across the application.
+ */
 interface SketchUIConfig {
-    /** Display the top toolbar header (default: true) */
+    /** Display the top toolbar header container. Default: true */
     showTopBar?: boolean;
-    /** Display top bar Exit button (default: true if onExit provided) */
-    showExitButton?: boolean;
-    /** Display top bar board name title editor (default: true) */
+    /** Display the whiteboard title editor badge in the top bar. Default: true */
     showBoardName?: boolean;
-    /** Display top bar save status badge (default: true) */
+    /** Display the Exit / Back arrow button in the top bar. Default: true (if onExit provided) */
+    showExitButton?: boolean;
+    /** Display the auto-save indicator badge ("Saved" / "Saving") in the top bar. Default: true */
     showSaveIndicator?: boolean;
-    /** Display top bar undo/redo history buttons (default: true) */
+    /** Display undo/redo history buttons (Ctrl+Z / Ctrl+Y) in the top bar. Default: true */
     showHistoryControls?: boolean;
-    /** Display top bar zoom percentage & reset controls (default: true) */
+    /** Display the Undo history button. Default: true (when showHistoryControls is true) */
+    showUndoButton?: boolean;
+    /** Display the Redo history button. Default: true (when showHistoryControls is true) */
+    showRedoButton?: boolean;
+    /** Display zoom percentage and zoom in/out/reset controls in the top bar. Default: true */
     showZoomControls?: boolean;
-    /** Display top bar frames & artboards outline drawer toggle (default: true) */
+    /** Display Zoom Out button. Default: true (when showZoomControls is true) */
+    showZoomOutButton?: boolean;
+    /** Display Zoom In button. Default: true (when showZoomControls is true) */
+    showZoomInButton?: boolean;
+    /** Display Zoom Reset (100%) pill button. Default: true (when showZoomControls is true) */
+    showZoomResetButton?: boolean;
+    /** Display canvas grid pattern selector (Grid, Dots, Cross, None) in the top bar. Default: true */
+    showGridSelector?: boolean;
+    /** Display presentation frames outline drawer toggle in the top bar. Default: true */
     showFramesOutline?: boolean;
-    /** Display presentation slideshow trigger and mode (default: true) */
+    /** Display fullscreen presentation slideshow trigger in the top bar. Default: true */
     showPresentation?: boolean;
-    /** Display top bar laser pointer toggle (default: true) */
+    /** Display laser pointer tool button in the top bar. Default: true */
     showLaserPointer?: boolean;
-    /** Display top bar 1-click clipboard PNG copy button (default: true) */
+    /** Display spotlight focus overlay button (Alt+S) in the top bar. Default: true */
+    showSpotlight?: boolean;
+    /** Display 1-click clipboard PNG image copy button in the top bar. Default: true */
     showCopyImage?: boolean;
-    /** Display top bar clear canvas button (default: true) */
+    /** Display clear canvas trash button in the top bar. Default: true */
     showClearButton?: boolean;
-    /** Display top bar export modal dropdown (default: true) */
+    /** Display export menu dropdown modal (PNG, SVG, PDF, JSON) in the top bar. Default: true */
     showExportMenu?: boolean;
-    /** Display the left creation tool palette (default: true) */
+    /** Display PDF (A4) document export tab in the export modal. Default: true */
+    showExportPdf?: boolean;
+    /** Display PNG raster image export button in the export modal. Default: true */
+    showExportPng?: boolean;
+    /** Display SVG scalable vector export button in the export modal. Default: true */
+    showExportSvg?: boolean;
+    /** Display JSON project file export button in the export modal. Default: true */
+    showExportJson?: boolean;
+    /** Display JSON project file import button in the export modal. Default: true */
+    showImportJson?: boolean;
+    /** Display the left creation tool palette container. Default: true */
     showToolBar?: boolean;
-    /** Show select & hand pan tools (default: true) */
+    /** Display the pointer selection tool (V). Default: true */
     showSelectTool?: boolean;
-    /** Show geometric shapes flyout (default: true) */
+    /** Display the hand pan canvas tool (H). Default: true */
+    showHandTool?: boolean;
+    /** Display geometric shapes flyout (Rectangle, Ellipse, Diamond, Triangle, Star, etc.). Default: true */
     showShapeTools?: boolean;
-    /** Show freehand draw tool (default: true) */
+    /** Display freehand drawing pen tool (P). Default: true */
     showDrawTool?: boolean;
-    /** Show magnetic connector arrows and lines (default: true) */
+    /** Display magnetic connector arrows tool (A). Default: true */
     showArrowTool?: boolean;
-    /** Show text typography tool (default: true) */
+    /** Display straight lines connector tool (L). Default: true */
+    showLineTool?: boolean;
+    /** Display typography text block tool (T). Default: true */
     showTextTool?: boolean;
-    /** Show sticky notes tool (default: true) */
+    /** Display sticky notes idea cards tool (S). Default: true */
     showStickyNoteTool?: boolean;
-    /** Show matrix and grid table generator (default: true) */
+    /** Display matrix, SWOT, Kanban, and grid table generator tool. Default: true */
     showTableTool?: boolean;
-    /** Show insert image upload tool (default: true) */
+    /** Display insert image file upload tool (PNG, JPG, SVG, WebP). Default: true */
     showImageUpload?: boolean;
-    /** Enable tech and cloud architecture stencils (default: true) */
+    /** Display tech and cloud architecture stencils flyout (AWS, GCP, Azure, K8s). Default: true */
     showTechStencils?: boolean;
-    /** Enable diagram templates flyout (default: true) */
+    /** Display architecture starter diagram templates flyout. Default: true */
     showTemplates?: boolean;
-    /** Show eraser tool (default: true) */
+    /** Display element eraser tool (E). Default: true */
     showEraserTool?: boolean;
-    /** Show lock active tool toggle (default: true) */
+    /** Display laser pointer tool in the left toolbar (K). Default: true */
+    showLaserTool?: boolean;
+    /** Display lock active tool toggle button. Default: true */
     showLockTool?: boolean;
-    /** Display the right element styling and properties panel (default: true) */
+    /** Display the right element styling and properties panel container. Default: true */
     showPropertiesPanel?: boolean;
-    /** Display the bottom-right workspace overview minimap (default: true) */
+    /** Display stroke color picker and palette in properties panel. Default: true */
+    showStrokeColor?: boolean;
+    /** Display fill color picker and palette in properties panel. Default: true */
+    showFillColor?: boolean;
+    /** Display fill pattern texture selector (Solid, Hachure, Cross-hatch, Transparent). Default: true */
+    showFillStyle?: boolean;
+    /** Display stroke thickness width selector (Thin, Medium, Thick). Default: true */
+    showStrokeWidth?: boolean;
+    /** Display stroke line pattern selector (Solid, Dashed, Dotted). Default: true */
+    showStrokeStyle?: boolean;
+    /** Display hand-drawn roughness selector (Clean, Rough, Subtle, Sloppy). Default: true */
+    showRoughness?: boolean;
+    /** Display corner edge style selector (Sharp vs Rounded). Default: true */
+    showEdgeStyle?: boolean;
+    /** Display connector start/end arrowhead selector. Default: true */
+    showArrowheads?: boolean;
+    /** Display typography font family, font size, and text alignment options. Default: true */
+    showTypography?: boolean;
+    /** Display element opacity slider. Default: true */
+    showOpacity?: boolean;
+    /** Display canvas background color preset swatches in properties panel. Default: true */
+    showCanvasBackgroundPicker?: boolean;
+    /** Display multi-element alignment & distribution buttons (Align left/center/right). Default: true */
+    showAlignment?: boolean;
+    /** Display z-index layer ordering buttons (Bring to front, Send to back). Default: true */
+    showLayerOrdering?: boolean;
+    /** Display group and ungroup buttons in properties panel. Default: true */
+    showGrouping?: boolean;
+    /** Display duplicate and delete quick action buttons in properties panel header. Default: true */
+    showDuplicateDelete?: boolean;
+    /** Display the bottom-right workspace overview minimap. Default: true */
     showMinimap?: boolean;
-    /** Display the bottom-left keyboard shortcuts button (default: true) */
+    /** Display the bottom-left keyboard shortcuts modal trigger pill. Default: true */
     showShortcutsButton?: boolean;
-    /** Display the bottom-left documentation guide button (default: true if guideHref/onOpenGuide provided) */
+    /** Display the bottom-left documentation guide button pill. Default: true (if guideHref or onOpenGuide provided) */
     showGuideButton?: boolean;
-    /** Enable right-click context menu on canvas & elements (default: true) */
+    /** Enable right-click contextual menu on canvas and elements. Default: true */
     showContextMenu?: boolean;
+    /** Display contextual floating dock toolbar above selected elements. Default: true */
+    showFloatingDock?: boolean;
 }
 interface SketchEditorProps {
     /**
@@ -365,6 +431,7 @@ interface SketchBoardCanvasProps {
 declare function SketchBoardCanvas({ elements, setElements, selectedIds, selectElement, selectElements, clearSelection, addElement, updateElement, deleteSelectedElements, duplicateSelectedElements, groupSelectedElements, ungroupSelectedElements, pushHistory, undo, redo, camera, screenToWorld, worldToScreen, panBy, zoomAtPoint, tool, setTool, isToolLocked, setIsToolLocked, gridStyle, defaultStyles, editingElementId: externalEditingId, setEditingElementId: setExternalEditingId, canvasBackground, isPresentationOpen, laserColor, laserMode, laserStrokes, setLaserStrokes, laserPointerPos, setLaserPointerPos, readOnly, onDoubleClick, }: SketchBoardCanvasProps): React__default.JSX.Element;
 
 interface SketchBoardToolBarProps {
+    uiConfig?: SketchUIConfig;
     tool: ToolType;
     setTool: (tool: ToolType) => void;
     isToolLocked?: boolean;
@@ -376,9 +443,10 @@ interface SketchBoardToolBarProps {
     isTechStencilsOpen?: boolean;
     onInsertTablePreset?: (preset: 'blank' | 'matrix' | 'swot' | 'kanban', rows?: number, cols?: number) => void;
 }
-declare function SketchBoardToolBar({ tool, setTool, isToolLocked, setIsToolLocked, onInsertImage, onOpenTemplates, isTemplatesOpen, onOpenTechStencils, isTechStencilsOpen, onInsertTablePreset, }: SketchBoardToolBarProps): React__default.JSX.Element;
+declare function SketchBoardToolBar({ uiConfig, tool, setTool, isToolLocked, setIsToolLocked, onInsertImage, onOpenTemplates, isTemplatesOpen, onOpenTechStencils, isTechStencilsOpen, onInsertTablePreset, }: SketchBoardToolBarProps): React__default.JSX.Element;
 
 interface SketchBoardPropertiesPanelProps {
+    uiConfig?: SketchUIConfig;
     selectedElements: SketchBoardElement[];
     updateSelectedElements: (updates: Partial<SketchBoardElement>) => void;
     deleteSelectedElements: () => void;
@@ -396,9 +464,10 @@ interface SketchBoardPropertiesPanelProps {
     canvasBackground?: string;
     setCanvasBackground?: (color: string) => void;
 }
-declare function SketchBoardPropertiesPanel({ selectedElements, updateSelectedElements, deleteSelectedElements, duplicateSelectedElements, groupSelectedElements, ungroupSelectedElements, alignSelectedElements, distributeSelectedElements, bringToFront, sendToBack, bringForward, sendBackward, defaultStyles, setDefaultStyles, canvasBackground, setCanvasBackground, }: SketchBoardPropertiesPanelProps): React__default.JSX.Element;
+declare function SketchBoardPropertiesPanel({ uiConfig, selectedElements, updateSelectedElements, deleteSelectedElements, duplicateSelectedElements, groupSelectedElements, ungroupSelectedElements, alignSelectedElements, distributeSelectedElements, bringToFront, sendToBack, bringForward, sendBackward, defaultStyles, setDefaultStyles, canvasBackground, setCanvasBackground, }: SketchBoardPropertiesPanelProps): React__default.JSX.Element;
 
 interface SketchBoardTopBarProps {
+    uiConfig?: SketchUIConfig;
     boardName: string;
     setBoardName: (name: string) => void;
     onOpenExport: () => void;
@@ -431,7 +500,7 @@ interface SketchBoardTopBarProps {
     isSpotlightActive?: boolean;
     onToggleSpotlight?: () => void;
 }
-declare function SketchBoardTopBar({ boardName, setBoardName, onOpenExport, onOpenTemplates, onCopyImage, onClearBoard, elementCount, zoom, zoomIn, zoomOut, resetCamera, canUndo, canRedo, undo, redo, tool, setTool, gridStyle, setGridStyle, onExit, saveStatus, onManualSave, onStartPresentation, hasFrames, frameCount, isFramesOutlineOpen, onToggleFramesOutline, onOpenTechStencils, isTechStencilsOpen, isSpotlightActive, onToggleSpotlight, }: SketchBoardTopBarProps): React__default.JSX.Element;
+declare function SketchBoardTopBar({ boardName, setBoardName, onOpenExport, onOpenTemplates, onCopyImage, onClearBoard, elementCount, zoom, zoomIn, zoomOut, resetCamera, canUndo, canRedo, undo, redo, tool, setTool, gridStyle, setGridStyle, onExit, saveStatus, onManualSave, onStartPresentation, hasFrames, frameCount, isFramesOutlineOpen, onToggleFramesOutline, onOpenTechStencils, isTechStencilsOpen, isSpotlightActive, onToggleSpotlight, uiConfig, }: SketchBoardTopBarProps): React__default.JSX.Element;
 
 interface SketchBoardMinimapProps {
     elements: SketchBoardElement[];
@@ -481,8 +550,9 @@ interface SketchBoardExportModalProps {
     boardName: string;
     canvasBackground?: string;
     gridStyle?: GridStyle;
+    uiConfig?: SketchUIConfig;
 }
-declare function SketchBoardExportModal({ isOpen, onClose, elements, selectedIds, onImportElements, boardName, canvasBackground, gridStyle, }: SketchBoardExportModalProps): React__default.JSX.Element | null;
+declare function SketchBoardExportModal({ isOpen, onClose, elements, selectedIds, onImportElements, boardName, canvasBackground, gridStyle, uiConfig, }: SketchBoardExportModalProps): React__default.JSX.Element | null;
 
 interface SketchBoardPresentationModeProps {
     isOpen: boolean;