js-draw 0.18.0 → 0.18.1

package/dist/mjs/src/Editor.d.ts

@@ -1,308 +0,0 @@
-import EditorImage from './EditorImage';
-import ToolController from './tools/ToolController';
-import { InputEvtType, EditorNotifier, ImageLoader } from './types';
-import Command from './commands/Command';
-import UndoRedoHistory from './UndoRedoHistory';
-import Viewport from './Viewport';
-import { Point2 } from './math/Vec2';
-import HTMLToolbar from './toolbar/HTMLToolbar';
-import { RenderablePathSpec } from './rendering/renderers/AbstractRenderer';
-import Display, { RenderingMode } from './rendering/Display';
-import Color4 from './Color4';
-import Pointer from './Pointer';
-import Rect2 from './math/Rect2';
-import { EditorLocalization } from './localization';
-import IconProvider from './toolbar/IconProvider';
-import AbstractComponent from './components/AbstractComponent';
-type HTMLPointerEventType = 'pointerdown' | 'pointermove' | 'pointerup' | 'pointercancel';
-type HTMLPointerEventFilter = (eventName: HTMLPointerEventType, event: PointerEvent) => boolean;
-export interface EditorSettings {
-    /** Defaults to `RenderingMode.CanvasRenderer` */
-    renderingMode: RenderingMode;
-    /** Uses a default English localization if a translation is not given. */
-    localization: Partial<EditorLocalization>;
-    /**
-     * `true` if touchpad/mousewheel scrolling should scroll the editor instead of the document.
-     * This does not include pinch-zoom events.
-     * Defaults to true.
-     */
-    wheelEventsEnabled: boolean | 'only-if-focused';
-    /** Minimum zoom fraction (e.g. 0.5 → 50% zoom). */
-    minZoom: number;
-    maxZoom: number;
-    iconProvider: IconProvider;
-}
-/**
- * The main entrypoint for the full editor.
- *
- * @example
- * To create an editor with a toolbar,
- * ```
- * const editor = new Editor(document.body);
- *
- * const toolbar = editor.addToolbar();
- * toolbar.addActionButton('Save', () => {
- *   const saveData = editor.toSVG().outerHTML;
- *   // Do something with saveData...
- * });
- * ```
- *
- * See also
- * [`docs/example/example.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/docs/example/example.ts#L15).
- */
-export declare class Editor {
-    private container;
-    private renderingRegion;
-    /** Manages drawing surfaces/{@link lib!AbstractRenderer}s. */
-    display: Display;
-    /**
-     * Handles undo/redo.
-     *
-     * @example
-     * ```
-     * const editor = new Editor(document.body);
-     *
-     * // Do something undoable.
-     * // ...
-     *
-     * // Undo the last action
-     * editor.history.undo();
-     * ```
-     */
-    history: UndoRedoHistory;
-    /**
-     * Data structure for adding/removing/querying objects in the image.
-     *
-     * @example
-     * ```
-     * const editor = new Editor(document.body);
-     *
-     * // Create a path.
-     * const stroke = new Stroke([
-     *   Path.fromString('M0,0 L30,30 z').toRenderable({ fill: Color4.black }),
-     * ]);
-     * const addElementCommand = editor.image.addElement(stroke);
-     *
-     * // Add the stroke to the editor
-     * editor.dispatch(addElementCommand);
-     * ```
-     */
-    readonly image: EditorImage;
-    /**
-     * Allows transforming the view and querying information about
-     * what is currently visible.
-     */
-    readonly viewport: Viewport;
-    /** @internal */
-    readonly localization: EditorLocalization;
-    /** {@link lib!EditorSettings.iconProvider} */
-    readonly icons: IconProvider;
-    /**
-     * Controls the list of tools. See
-     * [the custom tool example](https://github.com/personalizedrefrigerator/js-draw/tree/main/docs/example-custom-tools)
-     * for more.
-     */
-    readonly toolController: ToolController;
-    /**
-     * Global event dispatcher/subscriber.
-     */
-    readonly notifier: EditorNotifier;
-    private loadingWarning;
-    private accessibilityAnnounceArea;
-    private accessibilityControlArea;
-    private eventListenerTargets;
-    private settings;
-    /**
-     * @example
-     * ```
-     * const container = document.body;
-     *
-     * // Create an editor
-     * const editor = new Editor(container, {
-     *   // 2e-10 and 1e12 are the default values for minimum/maximum zoom.
-     *   minZoom: 2e-10,
-     *   maxZoom: 1e12,
-     * });
-     *
-     * // Add the default toolbar
-     * const toolbar = editor.addToolbar();
-     *
-     * // Add a save button
-     * toolbar.addActionButton({
-     *   label: 'Save'
-     *   icon: createSaveIcon(),
-     * }, () => {
-     *   const saveData = editor.toSVG().outerHTML;
-     *   // Do something with saveData
-     * });
-     * ```
-     */
-    constructor(parent: HTMLElement, settings?: Partial<EditorSettings>);
-    /**
-     * @returns a reference to the editor's container.
-     *
-     * @example
-     * ```
-     *   // Set the editor's height to 500px
-     *   editor.getRootElement().style.height = '500px';
-     * ```
-     */
-    getRootElement(): HTMLElement;
-    /** @param fractionLoaded - should be a number from 0 to 1, where 1 represents completely loaded. */
-    showLoadingWarning(fractionLoaded: number): void;
-    hideLoadingWarning(): void;
-    private previousAccessibilityAnnouncement;
-    /**
-     * Announce `message` for screen readers. If `message` is the same as the previous
-     * message, it is re-announced.
-     */
-    announceForAccessibility(message: string): void;
-    /**
-     * Creates a toolbar. If `defaultLayout` is true, default buttons are used.
-     * @returns a reference to the toolbar.
-     */
-    addToolbar(defaultLayout?: boolean): HTMLToolbar;
-    private registerListeners;
-    private pointers;
-    private getPointerList;
-    /**
-     * Dispatches a `PointerEvent` to the editor. The target element for `evt` must have the same top left
-     * as the content of the editor.
-     */
-    handleHTMLPointerEvent(eventType: 'pointerdown' | 'pointermove' | 'pointerup' | 'pointercancel', evt: PointerEvent): boolean;
-    private isEventSink;
-    private handlePaste;
-    /**
-     * Forward pointer events from `elem` to this editor. Such that right-click/right-click drag
-     * events are also forwarded, `elem`'s contextmenu is disabled.
-     *
-     * @example
-     * ```ts
-     * const overlay = document.createElement('div');
-     * editor.createHTMLOverlay(overlay);
-     *
-     * // Send all pointer events that don't have the control key pressed
-     * // to the editor.
-     * editor.handlePointerEventsFrom(overlay, (event) => {
-     *   if (event.ctrlKey) {
-     *     return false;
-     *   }
-     *   return true;
-     * });
-     * ```
-     */
-    handlePointerEventsFrom(elem: HTMLElement, filter?: HTMLPointerEventFilter): void;
-    /** Adds event listners for keypresses to `elem` and forwards those events to the editor. */
-    handleKeyEventsFrom(elem: HTMLElement): void;
-    /** `apply` a command. `command` will be announced for accessibility. */
-    dispatch(command: Command, addToHistory?: boolean): void | Promise<void>;
-    /**
-     * Dispatches a command without announcing it. By default, does not add to history.
-     * Use this to show finalized commands that don't need to have `announceForAccessibility`
-     * called.
-     *
-     * Prefer `command.apply(editor)` for incomplete commands. `dispatchNoAnnounce` may allow
-     * clients to listen for the application of commands (e.g. `SerializableCommand`s so they can
-     * be sent across the network), while `apply` does not.
-     *
-     * @example
-     * ```
-     * const addToHistory = false;
-     * editor.dispatchNoAnnounce(editor.viewport.zoomTo(someRectangle), addToHistory);
-     * ```
-     */
-    dispatchNoAnnounce(command: Command, addToHistory?: boolean): void | Promise<void>;
-    /**
-     * Apply a large transformation in chunks.
-     * If `apply` is `false`, the commands are unapplied.
-     * Triggers a re-render after each `updateChunkSize`-sized group of commands
-     * has been applied.
-     */
-    asyncApplyOrUnapplyCommands(commands: Command[], apply: boolean, updateChunkSize: number): Promise<void>;
-    asyncApplyCommands(commands: Command[], chunkSize: number): Promise<void>;
-    asyncUnapplyCommands(commands: Command[], chunkSize: number, unapplyInReverseOrder?: boolean): Promise<void>;
-    private announceUndoCallback;
-    private announceRedoCallback;
-    private nextRerenderListeners;
-    private rerenderQueued;
-    /**
-     * Schedule a re-render for some time in the near future. Does not schedule an additional
-     * re-render if a re-render is already queued.
-     *
-     * @returns a promise that resolves when re-rendering has completed.
-     */
-    queueRerender(): Promise<void>;
-    isRerenderQueued(): boolean;
-    /**
-     * Re-renders the entire image.
-     *
-     * @see {@link Editor.queueRerender}
-     */
-    rerender(showImageBounds?: boolean): void;
-    /**
-     * Draws the given path onto the wet ink renderer. The given path will
-     * be displayed on top of the main image.
-     *
-     * @see {@link Display.getWetInkRenderer} {@link Display.flatten}
-     */
-    drawWetInk(...path: RenderablePathSpec[]): void;
-    /**
-     * Clears the wet ink display.
-     *
-     * @see {@link Display.getWetInkRenderer}
-     */
-    clearWetInk(): void;
-    /**
-     * Focuses the region used for text input/key commands.
-     */
-    focus(): void;
-    /**
-     * Creates an element that will be positioned on top of the dry/wet ink
-     * renderers.
-     *
-     * This is useful for displaying content on top of the rendered content
-     * (e.g. a selection box).
-     */
-    createHTMLOverlay(overlay: HTMLElement): {
-        remove: () => void;
-    };
-    addStyleSheet(content: string): HTMLStyleElement;
-    sendKeyboardEvent(eventType: InputEvtType.KeyPressEvent | InputEvtType.KeyUpEvent, key: string, ctrlKey?: boolean, altKey?: boolean): void;
-    /**
-     * Dispatch a pen event to the currently selected tool.
-     * Intended primarially for unit tests.
-     *
-     * @deprecated
-     * @see {@link sendPenEvent} {@link sendTouchEvent}
-     */
-    sendPenEvent(eventType: InputEvtType.PointerDownEvt | InputEvtType.PointerMoveEvt | InputEvtType.PointerUpEvt, point: Point2, allPointers?: Pointer[]): void;
-    addAndCenterComponents(components: AbstractComponent[], selectComponents?: boolean): Promise<void>;
-    toDataURL(format?: 'image/png' | 'image/jpeg' | 'image/webp'): string;
-    toSVG(): SVGElement;
-    /**
-     * Load editor data from an `ImageLoader` (e.g. an {@link SVGLoader}).
-     *
-     * @see loadFromSVG
-     */
-    loadFrom(loader: ImageLoader): Promise<void>;
-    private getTopmostBackgroundComponent;
-    /**
-     * Set the background color of the image.
-     */
-    setBackgroundColor(color: Color4): Command;
-    /**
-     * @returns the average of the colors of all background components. Use this to get the current background
-     * color.
-     */
-    estimateBackgroundColor(): Color4;
-    getImportExportRect(): Rect2;
-    setImportExportRect(imageRect: Rect2): Command;
-    /**
-     * Alias for loadFrom(SVGLoader.fromString).
-     *
-     * This is particularly useful when accessing a bundled version of the editor,
-     * where `SVGLoader.fromString` is unavailable.
-     */
-    loadFromSVG(svgData: string, sanitize?: boolean): Promise<void>;
-}
-export default Editor;