js-draw 0.23.0 → 0.24.0

package/CHANGELOG.md

@@ -1,384 +0,0 @@
-# 0.23.0
- * Bug fixes
-   * Fix background disappearing when near maximum zoom in certain images.
-   * Fix default pen size not matching zoom when repeatedly drawing dots.
- * Features/enhancements
-   * Animations for showing/hiding dropdowns in the toolbar.
-   * Lock drawing/selection transformation to the x or y axis when holding `shift`
-
-# 0.22.1
- * Bug fixes
-   * Fix color picker not having keyboard focus on open.
-   * Fix screen readers not reading whether a toggle button was enabled/disabled.
-   * Work around a command serialization/deserialization issue by caching the serialized form of commands in some instances.
-
-# 0.22.0
- * Improved German localization (thanks to @Mr-Kanister)
- * Behavior changes
-   * Closing the color picker:
-     * Don't draw when the user **clicks** on the canvas to close the color picker. Drawing is still done if the user clicks and drags.
- * Bug fixes
-   * Fix eraser flickering while erasing strokes.
-   * Fix in-progress strokes flickering during collaborative editing when incoming strokes are added to the editor.
-
-# 0.21.0
- * Color picker (adjustments to integration of the [Coloris library](https://github.com/melloware/coloris-npm))
-   * Allow the user to start drawing without an extra click when closing the color picker.
-   * Increase the size of sliders' touch targets for easier selection.
- * Adjust stroke smoothing: Strokes should now be closer to user input.
- * Erasing and selecting: Use the edge rather than the center of strokes to determine eraser/selection intersection.
-   * This was previously only the case for filled strokes (as produced by the flat-tip pen).
-
-# 0.20.0
- * Added option for grid-patterned background.
-
-# 0.19.0
- * (Experimental) Sound-based image browsing.
-   - Pressing tab repeatedly shows an "Enable sound-based exploration" button. Clicking this button plays a sound when a user subsequently clicks on the canvas. The sound is based on the color under the cursor.
- * Fixed
-   - Pinch-zooming on a trackpad would zoom in to a point roughly 50px below the cursor.
-   - Buttons accessible only by pressing "tab" repeatedly were hidden behind the editor's canvas in some browsers.
-
-# 0.18.2
- * Fix essential files missing from NPM.
-
-# 0.18.1
- * Fix CommonJS module imports for some usecases.
-   - Adds `@babel/runtime` as a dependency, which seems to be required to process some `require` calls.
-
-# 0.18.0
- * Publish both CommonJS and ES Modules
- * Fix ES module imports.
-
-# 0.17.4
- * Fix `CanvasRenderer` and `SVGRenderer` not exported.
- * Fix pasting images copied from js-draw into some external apps.
-     * Pasting selected items from `js-draw` still doesn't work for many apps.
-
-# 0.17.3
- * Fix `isRestylableComponent` not exported.
- * Add a method to get the `Editor`'s average background color.
-
-# 0.17.2
- * Bug fixes
-   - TextComponent: Fix sub-components not cloning when cloning a parent `TextComponent`
-     - This was causing duplicated `TextComponent`s to have, in part, the same styles as the original, even after attempting to restyle them with the restyle tool.
-   - Find tool: Don't add viewport transformations to the undo stack.
-   - Collaborative editing: Fix changing background size/location not synced between editors.
-   - Upgrades dependencies to latest versions ([see commit for details](https://github.com/personalizedrefrigerator/js-draw/commit/427a64037320ca96232d47f268258206398f3796))
-
-# 0.17.1
- * Bug fixes
-   - [Only partially fixed] Fix restyling duplicated TextComponents also restyling the original.
-   - Fix contents of overflow menu not changing on screen resize if the overflow menu was open.
-
-# 0.17.0
- * Breaking changes
-   - `SerializableCommand::serialize` may no longer serialize accurately when the command to serialize is not on top of the undo/redo stack. (This change was made to improve performance.)
- * Toolbar overflow menu:
-   - Prefer horizontal menu to veritcal for only 1-2 overflow items.
-   - Prefer wrapping to scrolling.
- * Bug fixes
-   - Undo/redo events are now consistently fired after the command is initially applied.
-
-# 0.16.1
- * Bug fixes
-   - Fix editor not shrinking vertically in Chromium-based browsers with its container.
-   - Fixes an issue where (on some devices), `tspan`s could grow in font-size when loading from an SVG.
-   - Fix spacers not added in the correct locations in the toolbar.
-
-# 0.16.0
- * Configurable background color.
- * Toolbar buttons are moved to an overflow menu instead of creating a second (or third) line of buttons.
-   - Buttons are still moved to a second row on tall screens.
-
-# 0.15.2
- * Bug fixes
-   * Don't select/erase objects that have `isSelectable` set to `false`.
-     - Previously, some objects used to store information about the image (e.g. attributes on the root `svg` object) could be selected and erased.
-   * Round points created by rectangle, arrow, and line tools to prevent unnecessary decimal places in the output.
-   * Performance improvement while zooming in on strokes.
-   * Fix view jumping while zooming in/rotating with touchscreen pan tool.
-
-# 0.15.1
- * Bug fixes
-   * Correctly restore the z-index of components on undo.
-   * Fix selection collapsing to a point on two-finger pan gesture.
-   * Move buttons into view when they don't fit on the screen
-
-# 0.15.0
- * Adds a "reformat selection" button that allows changing the color of the selection.
- * Bug fixes:
-   * Fix ctrl+A not selecting when the selection tool isn't active.
-   * Fix ctrl+A selecting text when a toolbar button has focus.
-   * Fix incorrect z-order on undo of many-object transform (e.g. dragging objects on top of a background, then undoing, could leave the objects below the background).
-
-# 0.14.0
- * Adjust default snap distance.
- * Allow selection tool to mirror objects.
- * Bug fixes
-   * Allow the meta key (cmd) to activate keyboard shortcuts. (E.g. cmd+a on MacOS should select all).
-   * Fix extra moveTo command being converted to a string with some strokes.
-   * Increase size of icons in newer versions of Safari (they had decreased in size).
-
-# 0.13.1
- * Touchscreen panning: Rotation snapping
- * Bug fixes
-   * Snap viewport rotation to multiples of 90° when touchscreen panning (and near a multiple of 90°).
-
-# 0.13.0
- * Ctrl key: Snap to grid
- * New pen icons
- * Bug fixes:
-   * Styling in output SVG: Prevent other renderers from collapsing multiple
-     spaces into a single space.
-   * Ends an in-progress stroke and adds it to the redo stack if ctrl+z is pressed while drawing a stroke.
-
-
-# 0.12.0
- * Make the eraser's size adjustable.
- * Bug fixes:
-   * Fixed a regression with the selection tool where pressing `Ctrl+D` while dragging the selection wouldn't duplicate at the selection's current location.
-   * Fixed a regression where, in some browsers (Chrome, but not Firefox), editing a text component would duplicate that component.
-
-# 0.11.3
- * Adjust default pen sizes.
- * Fix arrow/line icons being difficult to see with very thin stroke sizes.
- * Potential fix for content of current text input being discarded when clicking "save".
- * Loading images: Minor performance improvement.
-
-# 0.11.2
- * Fix eraser regression: Erasing multiple strokes, one after another, caused strokes to un-erase.
-
-# 0.11.1
- * Performance: Faster eraser and selection tools.
- * Bug fixes
-   * Selection tool: Don't allow components to be in the selection multiple times.
-
-# 0.11.0
- * Added a dialog for inserting images and changing existing image alt text.
- * Inertial scrolling: Workaround issue on some devices on touch gesture cancel.
-
-# 0.10.3
- * Inertial scrolling: Don't start inertial scroll if a gesture was, in total, shorter than roughly 30 ms. Such gestures can be caused accidentally. For example, by resting/lifting a hand from a device screen.
-
-# 0.10.2
- * Performance improvements
-
-# 0.10.1
- * Different icons for rounded pens.
- * Bug fixes
-   * Different pen types, for the same size, previously had different actual widths.
-   * Inertial touchscreen scrolling previously sometimes started even if the initiating gesture was, just before stopping, stationary for several seconds.
-
-# 0.10.0
- * Inertial touchscreen scrolling.
- * Bug fixes
-   * Fixed keyboard shortcuts broken when undo/redo buttons are selected.
-   * Fixed text objects saving with duplicate properties.
-   * Fixed blank lines disappearing from text objects when attempting to edit a loaded-from-file text object.
- * Breaking changes
-   * `HTMLToolbar::addActionButton` no longer takes a `parent` argument and returns a `BaseWidget`.
-
-# 0.9.3
- * Decrease amount text shifts by when editing.
- * Text toolbar widget: Added a font size option.
-
-# 0.9.2
- * Added a find dialog that can be opened with `ctrl+f`
-
-# 0.9.1
- * Bug fixes:
-  * Fix line tool producing an open shape. This caused issues with erasing and zooming in on these shapes.
-  * Export SVG images with `fill='none'` instead of `fill='#00000000'` — some SVG readers ignore the transparency encoded in `#00000000`.
-
-# 0.9.0
- * Allow saving toolbar widget state (see `HTMLToolbar#serializeState` and `HTMLToolbar#deserializeState`).
-  * Breaking change: Toolbar widgets now require an `id`. As such, the order and number of parameters to `BaseWidget` has changed.
- * Add rotation lock button to hand toolbar widget.
- * Bug fixes
-   * Fixed colors of color picker previews not matching value of the input (and thus not matching the actual color of the tool).
-   * Fixed `Path::fromRect` producing an open shape. This caused issues with collision detection (for erasing and determining whether the rectangles should be visible).
-
-# 0.8.0
- * Use non-pressure-sensitive strokes by default for most tools
-   * These strokes should be have fewer bugs/issues than the pressure sensitive strokes.
-
-# 0.7.2
- * Bug fixes
-   * Fix multi-line text displaying in wrong position in exported SVGs.
-   * Fix editing a different text node sometimes changing the color/font of the previous text node.
-
-# 0.7.1
- * Fix scrollbars in text tool appearing when they should not (mostly in Chrome).
-
-# 0.7.0
- * Text tool
-   * Edit existing text.
-   * Shift+enter to insert a new line.
-   * Preserve multi-line text when loading/saving
- * Pen
-   * Decrease smoothing amount for thick strokes.
-
-# 0.6.0
- * Selection tool:
-   * Shift+click extends a selection
-   * `ctrl+d` duplicates selected objects
-   * `ctrl+r` resizes the image to the selected region
-   * `ctrl+a` selects everything (when the selection tool is enabled)
- * Panning tool: Toggle all device panning by clicking on the hand button.
- * `HandToolWidget` now expects, but does not require, a primary hand tool to work properly. See `ToolController#addPrimaryTool`.
- * **Breaiking changes:**
-   * Icons are no longer accessible through `import {makeFooIcon} from '...'`. Use `editor.icons.makeFooIcon` instead.
-
-# 0.5.0
- * Increase contrast between selection box/background
- * Keyboard shortcuts
-   * `Ctrl+1` through `Ctrl+9`: Switch pen drawing mode.
-     * For this to work, the `ToolbarShortcutHandler` must be loaded (and the toolbar must also be loaded).
- * Bug fixes
-   * Fix text shifting away from strokes on paste.
-
-# 0.4.1
- * Bug fixes
-   * Fix in-progress strokes occasionally flickering and disappearing.
-     * This was caused by a division-by-zero error.
-   * Increase contrast between disabled and enabled buttons.
-   * Copy selected text objects as text.
-
-# 0.4.0
- * Moved the selection tool rotate handle to the top, added resize horizontally and resize vertically handles.
- * Selection-tool-related bug fixes
-   * Reduced increase in file size after rotating/resizing selected objects.
-   * Fix "resize to selection" button disabled when working with selections created by pasting.
- * Other bug fixes
-   * Fix occasional stroke distortion when saving.
-
-# 0.3.2
- * Embedded PNG/JPEG image loading
- * Copy and paste
- * Open images when dropped into editor
- * Keyboard shortcuts:
-   * `Delete`/`Backspace` deletes selected content.
-   * `Ctrl+C`, `Ctrl+V` for copy/paste.
-
-# 0.3.1
- * Keyboard shortcuts:
-   * Press `Ctrl+1` to select the first pen, `Ctrl+2` to select the second, etc.
-   * When a pen is active, press `+` to increase a pen's size, `-` to decrease it.
- * Performance:
-   * Cache `Path::toString` results for faster saving to SVG.
-
-# 0.3.0
- * Pen-related bug fixes
- * API: Allow creating custom tools and tool widgets.
-
-# 0.2.3
- * Fix lines with thickness set to small numbers self-intersecting many times.
-
-# 0.2.2
- * Fix custon toolbar action buttons having wrong height.
-
-# 0.2.1
- * German localization.
-
-# 0.2.0
- * Export `Mat33`, `Vec3`, `Vec2`, and `Color4`.
- * [Documentation](https://personalizedrefrigerator.github.io/js-draw/typedoc/index.html)
- * Bug fixes:
-   * After using up all blocks in the rendering cache, a single block was repeatedly re-allocated, leading to slow performance.
-
-# 0.1.12
- * Add icons to the selection menu.
- * Screen-reader-related bug fixes.
- * Fix bug where parent cache nodes were not fully re-rendered after erasing a stroke and replacing it with more, larger strokes.
- * Generate strokes with single paths, instead of one path for each segment.
-   * This should make new strokes take less space when saving to SVG because we don't need to store the edges for each part of the stroke.
-
-# 0.1.11
- * Fix 'Enter' key not toggling toolbar buttons.
- * Add zoom limits.
- * Add a reset zoom button.
-
-# 0.1.10
- * Keyboard shortcuts for the selection tool.
- * Scroll the selection into view while moving it with the keyboard/mouse.
- * Fix toolbar buttons not activating when focused and enter/space is pressed.
- * Partial Spanish localization.
-
-# 0.1.9
- * Fix regression -- color picker hides just after clicking it.
- * Allow toggling the pipette tool.
-
-# 0.1.8
- * Don't render if the screen has a size of 0x0.
-   * This was breaking the cache data structure's invariant -- cache blocks weren't dividing when they had zero size.
- * Fix rectangles drawn with the pen's rectangle mode not having edges parallel to the viewport.
-
-# 0.1.7
- * Show the six most recent color selections in the color palette.
- * Switch from checkboxes to togglebuttons in the dropdown for the hand tool.
- * Adds a "duplicate selection" button.
- * Add a pipette (select color from screen) tool.
- * Make `Erase`, `Duplicate`, `AddElement`, `TransformElement` commands serializable.
-
-# 0.1.6
- * Fix loading text in SVG images in Chrome.
-
-# 0.1.5
- * Add a text-only renderer (only renders text objects at present) that can be activated with a screen reader.
- * Make new text objects parallel to screen's horizontal axis.
- * Fix pinch zoom off center when embedded in larger page.
-
-# 0.1.4
- * Option to enable pan gestures only if the editor has focus
- * Text tool bug fixes and improvements.
- * Defocus/blur editor when `Esc` key is pressed.
-
-# 0.1.3
- * Very minimalistic text tool.
- * Ability to load and save text.
- * Fix a rounding bug where small strokes could be stretched/moved to the wrong locations.
-
-# 0.1.2
- * Replace 'touch drawing' with a hand tool.
- * Bug fixes related to importing SVGs from other applications.
-
-# 0.1.1
- * Avoid using the cache if working with smaller numbers of strokes.
- * Attempt to prevent stroke width being zero at some locations in thin strokes.
-
-# 0.1.0
- * Zoom to import/export region just after importing.
- * Rendered strokes are cached if possible for better performance.
-
-# 0.0.10
- * Prefer higher quality rendering except during touchscreen gestures and large groups of commands.
- * Add a "delete selection" button.
-
-# 0.0.8
- * Map `ctrl+z` to undo, `ctrl+shift+Z` to redo.
-
-# 0.0.7
- * Preserve SVG global attributes when loading/saving images.
-    * This fixes a bug where lost information (e.g. a missing namespace) broke SVGs on export.
-
-# 0.0.6
- * Fixes a bug that caused saved images to grow in size after loading them, then re-saving.
- * Stops the pressure decrease on pen-up events from preventing line/arrow objects from having variable width.
-
-# 0.0.5
- * Configuration options:
-   - Ability to disable touch panning
-   - The `new Editor(container, ...)` constructor now takes a configuration object as its second argument.
- * A pre-bundled version of `js-draw` is now distributed.
-
-# 0.0.4
- * Preset shapes
-   * Arrow
-   * Filled rectangle
-   * Outlined rectangle
-   * Line
-
-# 0.0.2
- * Adjust default editor colors based on system theme.

package/CONTRIBUTING.md

@@ -1,75 +0,0 @@
-# Building and testing
-`js-draw` uses `yarn` as its build system and to manage dependencies. Thus, to install dependencies and build the project for the first time,
-```bash
-# After cloning the project,
-bash$ cd path/to/js-draw
-
-# Install dependencies
-bash$ yarn install
-
-# Run tests
-bash$ yarn test
-
-# Run tests/re-run tests when files change
-bash$ yarn test --watch
-
-# Build documentation
-bash$ yarn doc
-```
-
-## Running/building the example projects
-First, switch to the `docs` directory:
-```console
-bash$ cd path/to/js-draw/
-bash$ cd docs/
-```
-
-Next, `cd` to one of the example projects.
-
-### Main example project
-```bash
-bash$ cd example/
-
-# Install dependencies for the example project
-bash$ yarn install
-
-# Re-build when files change
-bash$ yarn watch
-```
-
-In a separate terminal, run a local web-server. Use the web-server to open the `example.html` file.
-```bash
-bash$ python3 -m http.server
-```
-
-### Collaborative editing project
-```bash
-bash$ cd example-collaborative/
-
-# Re-build when files change
-bash$ yarn watch
-```
-
-and in a separate terminal,
-```bash
-# Start the example project's server
-bash$ python3 server.py
-```
-
-# Notable files and directories
-> If this list is outdated, please open an issue.
-
-- [`src/localizations`](https://github.com/personalizedrefrigerator/js-draw/tree/main/src/localizations) and [`getLocalizationTable.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/src/localizations/getLocalizationTable.ts).
-- [Stroke smoothing and geometric shape builders: `src/components/builders`](https://github.com/personalizedrefrigerator/js-draw/tree/main/src/components/builders)
-- [Main app entrypoint: `src/Editor.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/src/Editor.ts)
-- [Default tools and sending events to them: `src/tools/ToolController.ts`](https://github.com/personalizedrefrigerator/js-draw/blob/main/src/tools/ToolController.ts)
-
-# Code style
-
-The coding style is, for the most part, enforced by a pre-commit hook.
-
-Because `js-draw` was originally created as a part of a pull request for the Joplin note-taking app,
-[it mostly follows Joplin's style guide](https://github.com/laurent22/joplin/blob/dev/readme/coding_style.md),
-with the exception that TypeDoc-style comments (`/** */`) are permitted for documentation.
-
-Note that `//`-style comments can also be used for documentation.

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Henry Heino
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.