@fieldnotes/core 0.18.0 → 0.20.0

package/dist/index.d.cts

@@ -432,12 +432,25 @@ declare class HistoryRecorder {
     private flushUpdateSnapshots;
 }
 
+type ShortcutBindings = Record<string, string | string[] | null>;
+interface ShortcutOptions {
+    scope?: 'focus' | 'window';
+    bindings?: ShortcutBindings;
+}
+interface ShortcutsApi {
+    rebind(action: string, bindings: string | string[] | null): void;
+    disable(action: string): void;
+    reset(action?: string): void;
+    getBindings(): Record<string, string[]>;
+}
+
 interface InputHandlerOptions {
     toolManager?: ToolManager;
     toolContext?: ToolContext;
     historyRecorder?: HistoryRecorder;
     historyStack?: HistoryStack;
     fitToContent?: () => void;
+    shortcuts?: ShortcutOptions;
 }
 declare class InputHandler {
     private readonly element;
@@ -458,9 +471,12 @@ declare class InputHandler {
     private deferredDown;
     private readonly abortController;
     private readonly actions;
+    private readonly shortcutMap;
+    private readonly scope;
     constructor(element: HTMLElement, camera: Camera, options?: InputHandlerOptions);
     setToolManager(toolManager: ToolManager, toolContext: ToolContext): void;
     flushPendingHistory(): void;
+    get shortcuts(): ShortcutsApi;
     destroy(): void;
     private bind;
     private onWheel;
@@ -469,6 +485,7 @@ declare class InputHandler {
     private onPointerUp;
     private onKeyDown;
     private onKeyUp;
+    private runAction;
     private startPinch;
     private handlePinchMove;
     private getPinchPoints;
@@ -479,6 +496,8 @@ declare class InputHandler {
     private dispatchToolMove;
     private dispatchToolHover;
     private dispatchToolUp;
+    private isInScope;
+    private focusSelf;
     private cancelToolIfActive;
 }
 
@@ -569,6 +588,8 @@ interface ViewportOptions {
     background?: BackgroundOptions;
     fontSizePresets?: FontSizePreset[];
     toolbar?: boolean;
+    placeholder?: string;
+    shortcuts?: ShortcutOptions;
     onHtmlElementMount?: (elementId: string, domId: string | undefined, container: HTMLDivElement) => void;
     onDrop?: (event: DragEvent, worldPosition: {
         x: number;
@@ -617,6 +638,7 @@ declare class Viewport {
     loadState(state: CanvasState): void;
     loadJSON(json: string): void;
     setTool(name: string): void;
+    get shortcuts(): ShortcutsApi;
     undo(): boolean;
     redo(): boolean;
     addImage(src: string, position: {
@@ -703,6 +725,7 @@ declare class ElementRenderer {
 interface NoteEditorOptions {
     fontSizePresets?: FontSizePreset[];
     toolbar?: boolean;
+    placeholder?: string;
 }
 declare class NoteEditor {
     private editingId;
@@ -710,9 +733,11 @@ declare class NoteEditor {
     private blurHandler;
     private keyHandler;
     private pointerHandler;
+    private inputHandler;
     private pendingEditId;
     private onStopCallback;
     private toolbar;
+    private readonly placeholder;
     constructor(options?: NoteEditorOptions);
     get isEditing(): boolean;
     get editingElementId(): string | null;
@@ -735,6 +760,7 @@ interface StyledRun extends RunStyle {
     text: string;
 }
 declare function sanitizeNoteHtml(html: string): string;
+declare function isNoteContentEmpty(html: string): boolean;
 
 interface ActiveFormats {
     bold: boolean;
@@ -964,6 +990,7 @@ declare class SelectTool implements Tool {
     private pendingSingleSelectId;
     private hasDragged;
     private resizeAspectRatio;
+    private hoveredId;
     get selectedIds(): string[];
     setSelection(ids: string[]): void;
     get isMarqueeActive(): boolean;
@@ -978,6 +1005,7 @@ declare class SelectTool implements Tool {
     private updateArrowsBoundTo;
     nudgeSelection(dx: number, dy: number, ctx: ToolContext): boolean;
     private updateHoverCursor;
+    private setHovered;
     private handleResize;
     private hitTestResizeHandle;
     private getHandlePositions;
@@ -1212,6 +1240,6 @@ declare class UpdateLayerCommand implements Command {
     undo(_store: ElementStore): void;
 }
 
-declare const VERSION = "0.18.0";
+declare const VERSION = "0.20.0";
 
-export { type ActiveFormats, AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Binding, type Bounds, Camera, type CameraChangeInfo, type CameraOptions, type CanvasElement, type CanvasState, type Command, CreateLayerCommand, DEFAULT_FONT_SIZE_PRESETS, DEFAULT_NOTE_FONT_SIZE, DoubleTapDetector, type DoubleTapDetectorOptions, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, type ExportImageOptions, type FilterAction, type FilteredEvent, type FilteredUpEvent, type FontSizePreset, type GridElement, type GridInfo, HandTool, type HexOrientation, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputFilter, InputHandler, type InputHandlerOptions, type Layer, LayerManager, MeasureTool, type MeasureToolOptions, type Measurement, NoteEditor, type NoteEditorOptions, type NoteElement, NoteTool, type NoteToolOptions, NoteToolbar, PencilTool, type PencilToolOptions, type Point, type PointerState, Quadtree, RemoveElementCommand, RemoveLayerCommand, type RenderStatsSnapshot, SelectTool, type ShapeElement, type ShapeKind, ShapeTool, type ShapeToolOptions, type Size, type StrokeElement, type StrokePoint, type StyledRun, type TemplateElement, type TemplateShape, TemplateTool, type TemplateToolOptions, type TextElement, TextTool, type TextToolOptions, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, UpdateLayerCommand, VERSION, Viewport, type ViewportOptions, boundsIntersect, clearStaleBindings, createArrow, createGrid, createHtmlElement, createId, createImage, createNote, createShape, createStroke, createTemplate, createText, drawHexPath, exportImage, exportState, findBindTarget, findBoundArrows, getActiveFormats, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, getEdgeIntersection, getElementBounds, getElementCenter, getElementsBoundingBox, getHexCellsInCone, getHexCellsInLine, getHexCellsInRadius, getHexCellsInSquare, getHexDistance, isBindable, isNearBezier, parseState, sanitizeNoteHtml, setFontSize, smartSnap, snapPoint, snapToHexCenter, toggleBold, toggleItalic, toggleStrikethrough, toggleUnderline, unbindArrow, updateBoundArrow };
+export { type ActiveFormats, AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Binding, type Bounds, Camera, type CameraChangeInfo, type CameraOptions, type CanvasElement, type CanvasState, type Command, CreateLayerCommand, DEFAULT_FONT_SIZE_PRESETS, DEFAULT_NOTE_FONT_SIZE, DoubleTapDetector, type DoubleTapDetectorOptions, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, type ExportImageOptions, type FilterAction, type FilteredEvent, type FilteredUpEvent, type FontSizePreset, type GridElement, type GridInfo, HandTool, type HexOrientation, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputFilter, InputHandler, type InputHandlerOptions, type Layer, LayerManager, MeasureTool, type MeasureToolOptions, type Measurement, NoteEditor, type NoteEditorOptions, type NoteElement, NoteTool, type NoteToolOptions, NoteToolbar, PencilTool, type PencilToolOptions, type Point, type PointerState, Quadtree, RemoveElementCommand, RemoveLayerCommand, type RenderStatsSnapshot, SelectTool, type ShapeElement, type ShapeKind, ShapeTool, type ShapeToolOptions, type ShortcutBindings, type ShortcutOptions, type ShortcutsApi, type Size, type StrokeElement, type StrokePoint, type StyledRun, type TemplateElement, type TemplateShape, TemplateTool, type TemplateToolOptions, type TextElement, TextTool, type TextToolOptions, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, UpdateLayerCommand, VERSION, Viewport, type ViewportOptions, boundsIntersect, clearStaleBindings, createArrow, createGrid, createHtmlElement, createId, createImage, createNote, createShape, createStroke, createTemplate, createText, drawHexPath, exportImage, exportState, findBindTarget, findBoundArrows, getActiveFormats, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, getEdgeIntersection, getElementBounds, getElementCenter, getElementsBoundingBox, getHexCellsInCone, getHexCellsInLine, getHexCellsInRadius, getHexCellsInSquare, getHexDistance, isBindable, isNearBezier, isNoteContentEmpty, parseState, sanitizeNoteHtml, setFontSize, smartSnap, snapPoint, snapToHexCenter, toggleBold, toggleItalic, toggleStrikethrough, toggleUnderline, unbindArrow, updateBoundArrow };

package/dist/index.d.ts

@@ -432,12 +432,25 @@ declare class HistoryRecorder {
     private flushUpdateSnapshots;
 }
 
+type ShortcutBindings = Record<string, string | string[] | null>;
+interface ShortcutOptions {
+    scope?: 'focus' | 'window';
+    bindings?: ShortcutBindings;
+}
+interface ShortcutsApi {
+    rebind(action: string, bindings: string | string[] | null): void;
+    disable(action: string): void;
+    reset(action?: string): void;
+    getBindings(): Record<string, string[]>;
+}
+
 interface InputHandlerOptions {
     toolManager?: ToolManager;
     toolContext?: ToolContext;
     historyRecorder?: HistoryRecorder;
     historyStack?: HistoryStack;
     fitToContent?: () => void;
+    shortcuts?: ShortcutOptions;
 }
 declare class InputHandler {
     private readonly element;
@@ -458,9 +471,12 @@ declare class InputHandler {
     private deferredDown;
     private readonly abortController;
     private readonly actions;
+    private readonly shortcutMap;
+    private readonly scope;
     constructor(element: HTMLElement, camera: Camera, options?: InputHandlerOptions);
     setToolManager(toolManager: ToolManager, toolContext: ToolContext): void;
     flushPendingHistory(): void;
+    get shortcuts(): ShortcutsApi;
     destroy(): void;
     private bind;
     private onWheel;
@@ -469,6 +485,7 @@ declare class InputHandler {
     private onPointerUp;
     private onKeyDown;
     private onKeyUp;
+    private runAction;
     private startPinch;
     private handlePinchMove;
     private getPinchPoints;
@@ -479,6 +496,8 @@ declare class InputHandler {
     private dispatchToolMove;
     private dispatchToolHover;
     private dispatchToolUp;
+    private isInScope;
+    private focusSelf;
     private cancelToolIfActive;
 }
 
@@ -569,6 +588,8 @@ interface ViewportOptions {
     background?: BackgroundOptions;
     fontSizePresets?: FontSizePreset[];
     toolbar?: boolean;
+    placeholder?: string;
+    shortcuts?: ShortcutOptions;
     onHtmlElementMount?: (elementId: string, domId: string | undefined, container: HTMLDivElement) => void;
     onDrop?: (event: DragEvent, worldPosition: {
         x: number;
@@ -617,6 +638,7 @@ declare class Viewport {
     loadState(state: CanvasState): void;
     loadJSON(json: string): void;
     setTool(name: string): void;
+    get shortcuts(): ShortcutsApi;
     undo(): boolean;
     redo(): boolean;
     addImage(src: string, position: {
@@ -703,6 +725,7 @@ declare class ElementRenderer {
 interface NoteEditorOptions {
     fontSizePresets?: FontSizePreset[];
     toolbar?: boolean;
+    placeholder?: string;
 }
 declare class NoteEditor {
     private editingId;
@@ -710,9 +733,11 @@ declare class NoteEditor {
     private blurHandler;
     private keyHandler;
     private pointerHandler;
+    private inputHandler;
     private pendingEditId;
     private onStopCallback;
     private toolbar;
+    private readonly placeholder;
     constructor(options?: NoteEditorOptions);
     get isEditing(): boolean;
     get editingElementId(): string | null;
@@ -735,6 +760,7 @@ interface StyledRun extends RunStyle {
     text: string;
 }
 declare function sanitizeNoteHtml(html: string): string;
+declare function isNoteContentEmpty(html: string): boolean;
 
 interface ActiveFormats {
     bold: boolean;
@@ -964,6 +990,7 @@ declare class SelectTool implements Tool {
     private pendingSingleSelectId;
     private hasDragged;
     private resizeAspectRatio;
+    private hoveredId;
     get selectedIds(): string[];
     setSelection(ids: string[]): void;
     get isMarqueeActive(): boolean;
@@ -978,6 +1005,7 @@ declare class SelectTool implements Tool {
     private updateArrowsBoundTo;
     nudgeSelection(dx: number, dy: number, ctx: ToolContext): boolean;
     private updateHoverCursor;
+    private setHovered;
     private handleResize;
     private hitTestResizeHandle;
     private getHandlePositions;
@@ -1212,6 +1240,6 @@ declare class UpdateLayerCommand implements Command {
     undo(_store: ElementStore): void;
 }
 
-declare const VERSION = "0.18.0";
+declare const VERSION = "0.20.0";
 
-export { type ActiveFormats, AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Binding, type Bounds, Camera, type CameraChangeInfo, type CameraOptions, type CanvasElement, type CanvasState, type Command, CreateLayerCommand, DEFAULT_FONT_SIZE_PRESETS, DEFAULT_NOTE_FONT_SIZE, DoubleTapDetector, type DoubleTapDetectorOptions, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, type ExportImageOptions, type FilterAction, type FilteredEvent, type FilteredUpEvent, type FontSizePreset, type GridElement, type GridInfo, HandTool, type HexOrientation, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputFilter, InputHandler, type InputHandlerOptions, type Layer, LayerManager, MeasureTool, type MeasureToolOptions, type Measurement, NoteEditor, type NoteEditorOptions, type NoteElement, NoteTool, type NoteToolOptions, NoteToolbar, PencilTool, type PencilToolOptions, type Point, type PointerState, Quadtree, RemoveElementCommand, RemoveLayerCommand, type RenderStatsSnapshot, SelectTool, type ShapeElement, type ShapeKind, ShapeTool, type ShapeToolOptions, type Size, type StrokeElement, type StrokePoint, type StyledRun, type TemplateElement, type TemplateShape, TemplateTool, type TemplateToolOptions, type TextElement, TextTool, type TextToolOptions, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, UpdateLayerCommand, VERSION, Viewport, type ViewportOptions, boundsIntersect, clearStaleBindings, createArrow, createGrid, createHtmlElement, createId, createImage, createNote, createShape, createStroke, createTemplate, createText, drawHexPath, exportImage, exportState, findBindTarget, findBoundArrows, getActiveFormats, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, getEdgeIntersection, getElementBounds, getElementCenter, getElementsBoundingBox, getHexCellsInCone, getHexCellsInLine, getHexCellsInRadius, getHexCellsInSquare, getHexDistance, isBindable, isNearBezier, parseState, sanitizeNoteHtml, setFontSize, smartSnap, snapPoint, snapToHexCenter, toggleBold, toggleItalic, toggleStrikethrough, toggleUnderline, unbindArrow, updateBoundArrow };
+export { type ActiveFormats, AddElementCommand, type ArrowElement, ArrowTool, type ArrowToolOptions, AutoSave, type AutoSaveOptions, Background, type BackgroundOptions, type BackgroundPattern, BatchCommand, type Binding, type Bounds, Camera, type CameraChangeInfo, type CameraOptions, type CanvasElement, type CanvasState, type Command, CreateLayerCommand, DEFAULT_FONT_SIZE_PRESETS, DEFAULT_NOTE_FONT_SIZE, DoubleTapDetector, type DoubleTapDetectorOptions, ElementRenderer, ElementStore, type ElementType, type ElementUpdateEvent, EraserTool, type EraserToolOptions, EventBus, type ExportImageOptions, type FilterAction, type FilteredEvent, type FilteredUpEvent, type FontSizePreset, type GridElement, type GridInfo, HandTool, type HexOrientation, HistoryRecorder, HistoryStack, type HistoryStackOptions, type HtmlElement, type ImageElement, ImageTool, type ImageToolOptions, InputFilter, InputHandler, type InputHandlerOptions, type Layer, LayerManager, MeasureTool, type MeasureToolOptions, type Measurement, NoteEditor, type NoteEditorOptions, type NoteElement, NoteTool, type NoteToolOptions, NoteToolbar, PencilTool, type PencilToolOptions, type Point, type PointerState, Quadtree, RemoveElementCommand, RemoveLayerCommand, type RenderStatsSnapshot, SelectTool, type ShapeElement, type ShapeKind, ShapeTool, type ShapeToolOptions, type ShortcutBindings, type ShortcutOptions, type ShortcutsApi, type Size, type StrokeElement, type StrokePoint, type StyledRun, type TemplateElement, type TemplateShape, TemplateTool, type TemplateToolOptions, type TextElement, TextTool, type TextToolOptions, type Tool, type ToolContext, ToolManager, type ToolName, UpdateElementCommand, UpdateLayerCommand, VERSION, Viewport, type ViewportOptions, boundsIntersect, clearStaleBindings, createArrow, createGrid, createHtmlElement, createId, createImage, createNote, createShape, createStroke, createTemplate, createText, drawHexPath, exportImage, exportState, findBindTarget, findBoundArrows, getActiveFormats, getArrowBounds, getArrowControlPoint, getArrowMidpoint, getArrowTangentAngle, getBendFromPoint, getEdgeIntersection, getElementBounds, getElementCenter, getElementsBoundingBox, getHexCellsInCone, getHexCellsInLine, getHexCellsInRadius, getHexCellsInSquare, getHexDistance, isBindable, isNearBezier, isNoteContentEmpty, parseState, sanitizeNoteHtml, setFontSize, smartSnap, snapPoint, snapToHexCenter, toggleBold, toggleItalic, toggleStrikethrough, toggleUnderline, unbindArrow, updateBoundArrow };