Skip to main content

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​

Fixed​

  • Fixed API documentation headings so inline code titles keep the gradient text treatment without showing an inline-code background.

1.3.1 · 2026-06-05​

Changed​

  • Switched the library version bump scripts to Yarn and removed the root package-lock.json from the repository and future commits.
  • Updated the published package homepage to point to the GitHub Pages documentation site.
  • Restored the Turbo task pipeline and added a dedicated check-types script for the library workspace so CI can run type checks again.
  • Restored the default click-outside behavior so clicking the backdrop closes a modal unless it is explicitly disabled.
  • Added a root LICENSE file so repository and package tooling can detect the MIT license from the monorepo root.

1.3.0 · 2026-06-01​

Changed​

  • Converted the repository to a Turbo monorepo with apps/library, apps/document, and shared TypeScript config packages.
  • Moved the published library source, package metadata, README, license, and security files into apps/library.
  • Replaced the root Prettier setup with a root-level Biome setup and wired lint / format scripts through the workspaces.
  • Added a Docusaurus documentation site in apps/document, including API, guide, getting started, and changelog pages.
  • Added GitHub Pages deployment for the docs site and updated CI workflows to build from the monorepo layout.
  • Renamed store and provider entrypoints to src/stores/modal.ts and src/providers/modal.tsx, and updated public exports accordingly.
  • Renamed type files to shorter names such as base-modal-params.ts, modal-components.ts, and modal-state.ts.
  • Removed the bundled example app source from src/example and the unused example stylesheet from the package source.
  • Extracted modal class-name and body animation helpers into src/utils, and moved modal animation constants and z-index constants into src/configs/constant.ts.
  • Replaced uuid, keyboardjs, and clsx usage with built-in JavaScript and DOM APIs, removing those packages from runtime dependencies.
  • Updated the README install note and examples to reflect the current modalStore API and peer dependency expectations.

1.2.8 · 2026-06-01​

Added​

  • Added GitHub Actions workflows for CI and npm publishing with provenance.
  • Added a SECURITY.md policy and an MIT LICENSE file to document release and security expectations.
  • Added release:check and ci scripts to validate release artifacts and CI builds consistently.
  • Added npm, bundle, type, issue, and Socket badges to the README.

Changed​

  • Documented the trusted publishing release flow in the README.
  • Replaced the manual local publish script with a CI-oriented release verification script.

1.2.6 · 2026-05-31​

Changed​

  • Removed Tailwind CSS and the Tailwind Vite plugin from package dependencies.
  • Replaced the example app Tailwind utilities with plain CSS classes.
  • Moved modal default layout to main.css with zero-specificity selectors so consumer classes can override defaults without !important.
  • Added modal positions: top, top-left, top-right, top-center, left, right, bottom, bottom-left, bottom-right, bottom-center, center, and center-full.
  • Added default position-aware body animations for edge and corner placements.

1.2.5 · 2026-05-30​

Fixed​

  • Removed Tailwind CSS injection from the distributed library build.
  • Moved Tailwind CSS import to the example app only.
  • Replaced internal modal layout Tailwind classes with inline styles to avoid overriding consumer app utilities.

1.2.4 · 2025-05-30​

Changed​

  • Split modal.type.ts into separate files for better maintainability.
  • base-modal-params.type.ts handled base modal parameter types.
  • modal-components.type.ts handled modal component and config types.
  • modal-state.type.ts handled modal state and action types.
  • modal.type.ts re-exported all types for backward compatibility.
  • Bumped dependencies such as motion, zustand, vite, tailwindcss, biome, and playwright.

1.2.3 · 2025-05-30​

Fixed​

  • Fixed ModalParams so it correctly extends ModalDefinition[T] with closeModal.
  • Updated dependencies for stability.

1.2.2 · 2025-11-21​

Added​

  • Enhanced TypeScript documentation with comprehensive JSDoc comments.
  • Added more detailed examples for modal animations and positioning.
  • Improved documentation for the blur effect parameter.
  • Added more complete examples for ModalComponent and ModalConfig.

Changed​

  • Improved type documentation with more realistic usage examples.
  • Expanded Framer Motion animation configuration documentation.
  • Clarified modal positioning options.

Fixed​

  • Type definitions now import required dependencies correctly.
  • Documentation examples now match the current API.