Skip to content

Latest commit

 

History

History
245 lines (163 loc) · 11.5 KB

CHANGELOG.md

File metadata and controls

245 lines (163 loc) · 11.5 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.0.1 - 2026-02-21

Fixed

  • Fix bug where selected text becomes invisible in textarea when plain mode is enabled

1.0.0 - 2026-02-21

Added

  • Added ListManager to handle automatic continuation of ordered lists (1.), unordered lists (-, *), and task lists ([x])
  • mode: Introduced hybrid (rendered styles) and plain (raw text) modes; plain remains the default
  • image tool: Added client-side validation to ensure required Alt text is provided before initiating server requests
  • Added support for custom upload parameters in image.fileInput.params (e.g., _token, user_id, folder)

Changed

  • The options object now ships with a fully pre-defined default configuration for a faster, zero-config setup. The toolbar array specifically now defaults to a "Minimal Essentials" set, removing the requirement to manually define tools or other option keys unless you want to customize the behavior. You can just do this const editor = new MarkdownEditor('#editor');
  • Refreshed Markdown editor toolbar icons for improved design and consistency
  • IndentManager now initialized by passing the editor instance (this) instead of separate arguments
  • Updated the toolbar and preview pane to dynamically support current and custom themes by removing hard-coded backgrounds in favor of theme-defined color inheritance
  • image tool: Moved file uploading from the change event to the "Apply" button click for a unified async flow
  • image tool: Improved altInput to support both boolean and object-based ({ required: true }) configurations
  • image tool: Standardized response handling to require { success: true } for successful uploads.
  • image tool: Improved error reporting by standardizing alert handling to support error responses with either { error: "..." } or { message: "..." } object keys
  • [Breaking] Renamed request field image to image_file
  • [Breaking] Renamed response field path to image_path

Fixed

  • Build (Production): Added sourceMap: true to CSS loaders to ensure .map files are generated, preventing deployment crashes
  • Build Paths: Standardized output paths using __dirname for cross-environment stability
  • theme: Aligned Tailwind CSS prose colors in the preview to match the selected editor theme palette
  • image tool: Resolved issue where files would upload even if mandatory Alt text was missing

0.5.0 - 2026-02-04

Added

  • Added copyright notice to output files
  • Official stable support for the undo/redo tools
  • New indent and outdent tools
  • Implemented a complete history system using diff-chars to minimize memory usage by storing only changes rather than full-text snapshots
  • Added automatic insertion of closing pairs {}, [], (), <>, "", and ''
  • Typing a pair character while text is selected now wraps the text instead of replacing it
  • If a user types a closing character that is already present at the cursor, the cursor simply jumps forward
  • Hitting Enter between {} now creates a triple-line expansion with a nested indent. Standard Enter now carries over the indentation level of the previous line
  • Deleting an opening bracket also removes the adjacent closing bracket
  • Support for custom upload parameters in ImageTool via the fileInput.params configuration object. This allows passing additional data like CSRF tokens, user IDs, or folder destinations during the upload request

Changed

  • Disabled Tailwind css Preflight
  • Created separate Webpack build files for development and production
  • Added a 1000ms debounce for standard typing and immediate saving for "boundary" characters (spaces, punctuation, etc.)
  • Refactored to handle both \t and 4-space indentation patterns during the outdent process
  • Undo and Redo now perfectly restore both the text content and the exact selection range/cursor position
  • Integrated Ctrl+Z, Ctrl+Y, and Ctrl+Shift+Z to trigger the custom history manager
  • [Breaking] Renamed the upload request parameter from image to image_file for better clarity and to avoid naming collisions.
  • [Breaking] Renamed the response parameter path to image_path to align with standardized naming conventions.

Fixed

  • Fix keyboard undo/redo to follow the same behavior as the undo/redo tools
  • Resolved an issue where highlighted text was not saved to the undo stack before being replaced
  • Fixed potential state corruption by ensuring _restoreState correctly updates the lastValue reference
  • Ensured the textarea regains focus immediately after undo/redo operations for a seamless typing experience
  • Implemented maxStackSize: 100 to prevent memory leaks during long editing sessions
  • The manager now skips processing if the text value has not changed between saves

0.4.0 - 2025-08-06

Added

  • Introduced beta support for undo/redo functionality using a granular diff-based system
    • Built to handle large documents efficiently, with no impact on performance
    • Tracks changes with smart save points on word boundaries, paste, enter, backspace, delete, blur, and debounce events
    • Optimized for handling huge markdown content efficiently

Changed

  • Prefixed all Tailwind CSS and Frutjam classes by utilizing Frutjam’s new component prefixing support (e.g., for components like .modal), to avoid design conflicts with other frameworks such as Bootstrap
  • Refactored folder hierarchy: reorganized the folder structure to separate files based on functionality
  • Replaced fixed Tailwind background and text color classes with Frutjam Surface component to ensure theme consistency across all Frutjam themes

0.3.0 - 2025-05-12

Added

  • Added altInput configuration to the image tool, allowing developers to customize the alt text input behavior in the markdown editor
  • Introduced a required option inside altInput:
    • When required is true (default), alt text is mandatory, supporting better SEO and accessibility
    • When set to false, validation for alt text is disabled
  • This configuration enables flexible validation rules across different editor instances

Fixed

  • Resolved an issue in the image modal where a selectedText is not defined error could occur when applying changes without selecting text

0.2.1 - 2025-05-12

Fixed

  • Resolved an issue where the preview tool's background color did not render correctly in dark mode
  • Fixed a bug causing the preview pane to not update in response to user input, due to the this.preview reference being unintentionally overridden
  • Updated modal element ID selectors to avoid naming conflicts with other projects

0.2.0 - 2025-05-12

Added

  • Integrated the Fruitjam UI library for a cleaner, more modern, and intuitive user interface.
  • Updated the link tool to use the Fruitjam UI modal, providing a more intuitive and visually consistent user experience.
  • Introduced a fully configurable image tool with support for:
    • fileInput configuration:
      • accept: Array of allowed image file types (e.g., 'webp', 'avif')
      • uploadUrl: Endpoint for uploading image files
    • Automatic URL field population after successful upload
    • Fallback to URL and alt text fields when fileInput is not configured

Fixed

  • Resolved a critical error where removing the preview option from the toolbar would crash the editor.

0.1.5 - 2025-03-03

Changed

  • Upgraded to Tailwind CSS v4

0.1.4 - 2025-02-24

Fixed

  • Resolved UI glitch for a smoother user experience.

0.1.3 - 2025-02-18

Changed

  • Production-ready minified CSS

Fixed

  • Bug fixes

0.1.2 - 2025-02-17

Added

  • New Tools Added: You can now easily add Headings, Links, and Blockquotes to your content!
  • Sleek New UI: Enjoy a fresh, improved design that makes your experience smoother and more intuitive than ever!

0.1.1 - 2025-02-16

Added

  • Implemented scrolling to the view of newly inserted text in the textarea when a toolbar tool is clicked.

Changed

  • Disabled toolbar tools in mobile view when preview mode is active to improve UX.
  • Improved UI

Fixed

  • Bug fixes

0.1.0 - 2025-02-15

Added

  • Ordered List Tool: Introduced a new tool for creating ordered (numbered) lists. This allows users to easily organize and present information in a step-by-step format.
  • Unordered List Tool: Added a tool for creating unordered (bulleted) lists. This enhances document formatting by making it easier to list items without specific order.
  • Checklist Tool: A new checklist tool has been added, allowing users to create interactive checklists. This feature is perfect for tasks, to-do lists, or tracking progress in projects.

Changed

  • Document Update: Updated the documentation to reflect new features and provide clear instructions on how to use the newly added list tools.

0.0.21-beta.3 - 2025-02-15

Added

  • Added RTL Support: Enhanced user experience by adding Right-to-Left text support.

Changed

  • UI Enhancements: Improved the overall user interface for a more polished experience.
  • Local Development Improvements: Made significant changes to improve the local development workflow.

Fixed

  • Fixed Page Reload Issue: Resolved the issue where the page was reloading upon clicking the tool.

0.0.21-beta.2 - 2025-01-20

Fixed

  • Bug Fix: Resolved MarkdownEditor undefined issue for CDN usage. The library now correctly exposes the MarkdownEditor global variable in browsers.

0.0.20-beta.2 - 2025-01-19

Changed

  • Changed markdownEditor to MarkdownEditor class import.
  • Several improvements to enhance functionality.
  • Updated README.md with clearer usage instructions.

0.0.2-beta.1 - 2025-01-15

Added

  • Initial release