Releases: avalynx/avalynx-lightbox
Release list
1.0.6
Release 1.0.6 – Changelog Summary
Documentation and tooling maintenance release that aligns the README, JSDoc, and project-wide conventions across the Avalynx library family. No runtime or API changes.
- Project-Wide README Alignment
Harmonised the section order, badges, and wording ofREADME.mdandREADME.de.mdwith the rest of the Avalynx packages.
Provides a consistent reading experience and makes cross-package navigation predictable. - JSDoc Style Standardisation
Brought the class-level description (AvalynxLightbox is …) and@paramblocks in line with the conventions documented inAGENTS.md.
No behaviour changes; only the documented contract. - Centralised AI Agent Instructions
Replaced per-tool guidelines (.junie/guidelines.md,.github/copilot-instructions.md) with a unifiedAGENTS.md(Docker workflow, 100 % coverage gate, code-style rules).
Ensures every package receives the same build and documentation expectations. - Version Bump Across Assets
Updated distributed files, headers, package metadata, and CDN snippets to 1.0.6.
Keeps npm, jsDelivr, and Packagist references in lockstep with the new tag.
Compatibility: Backward compatible
Full Changelog: 1.0.5...1.0.6
1.0.5
Release 1.0.5 – Changelog Summary
This release focuses on a small but important visual fix to improve layering behavior of the lightbox, along with version consistency updates across the project. It ensures more reliable rendering in real-world layouts.
-
Improved Z-Index Handling
Added az-indexrule to the lightbox container.
This ensures the lightbox reliably appears above other elements, avoiding display issues in complex layouts. -
Consistent Version Updates
Updated version references across source files, build output, and documentation.
Keeps all distributed assets aligned and avoids confusion when integrating via CDN or local builds. -
Documentation Sync
Updated CDN links in README files to reflect the new version.
Ensures users copy correct, up-to-date integration snippets.
Compatibility: Backward compatible
Full Changelog: 1.0.4...1.0.5
1.0.4
Release 1.0.4 – Changelog Summary
This release focuses on build process refinements and packaging improvements, ensuring cleaner distribution and easier integration. It enhances how CSS is handled and improves overall package metadata for better compatibility with modern tooling.
-
Improved Build Process
The build pipeline has been reorganized to better separate JavaScript and CSS steps.
This results in more predictable outputs and smoother integration into automated workflows. -
Enhanced CSS Packaging
CSS is now handled later in the build process and explicitly included in distribution files.
Users benefit from more reliable styling availability when installing via package managers or CDNs. -
Added
styleField in package.json
Astyleentry now points directly to the distributed CSS file.
This improves compatibility with bundlers and tooling that automatically detect styles. -
Refined Distribution Files सूची
CSS files are now explicitly listed in thefilesarray.
Ensures all required assets are included when publishing or installing the package. -
Version Reference Updates
All source, distribution, and documentation files now consistently reference version 1.0.4.
Reduces confusion and guarantees alignment across environments. -
Documentation CDN Update
Updated examples to use the latest version via GitHub-linked CDN references.
Helps users quickly adopt the newest release without manual version adjustments.
Compatibility: Backward compatible
Full Changelog: 1.0.3...1.0.4
1.0.3
Release 1.0.3 – Changelog Summary
This release introduces major new features including a fully functional gallery mode and background scroll prevention. It also shifts styling to a dedicated CSS file for better customization and provides comprehensive project guidelines for developers.
- Gallery Mode: Added support for navigating through multiple images using on-screen navigation buttons or keyboard arrow keys.
Users can now browse through image sets with automatic wrap-around functionality. - Background Scroll Prevention: Implemented a feature to lock background scrolling while the lightbox is open, including automatic scrollbar width compensation.
This ensures a stable viewing experience without content jumping when the lightbox is toggled. - Dedicated CSS Styling: Migrated lightbox styling from inline JavaScript to an external CSS file (
avalynx-lightbox.css).
This allows for easier theme customization and cleaner JavaScript code. - Enhanced Configuration: Introduced new options for
galleryandallowBackgroundScrolling, plus customizable labels for navigation buttons.
Provides developers with more control over the lightbox behavior and internationalization. - Keyboard Accessibility: Expanded keyboard support to include
ArrowRightandArrowLeftfor gallery navigation andEscapefor closing.
Improves usability for power users and ensures better accessibility compliance. - Project Guidelines: Added new documentation files (
AGENTS.md,.junie/guidelines.md, etc.) to standardize development workflows and quality requirements.
Ensures consistent code quality and 100% test coverage for all future contributions. - Expanded Examples: Created new example pages for gallery mode and background scroll prevention to demonstrate the new capabilities.
Helps developers quickly understand and implement the new features in their own projects.
Compatibility: Backward compatible (Note: You must now include the avalynx-lightbox.css file in your project).
Full Changelog: 1.0.2...1.0.3
1.0.2
Release 1.0.2 – Changelog Summary
Version 1.0.2 focuses on polish and project hardening: cleaner constructor code, improved packaging/export behavior, and a more reliable test/coverage pipeline. It also expands documentation (including a German README) to make adoption easier across teams.
-
Version Bump & Metadata Updates
All version references were updated to 1.0.2 across the project.
Helps consumers and tooling consistently pick up the correct release. -
Constructor Readability Cleanup
Refactored theAvalynxLightboxconstructor to reduce noise and improve clarity.
Makes the codebase easier to maintain and safer to extend. -
Improved Module Packaging (CommonJS Export)
Added a guardedmodule.exportspath (and excluded it from coverage via Istanbul ignore).
Improves compatibility for environments that still rely on CommonJS imports. -
CI Test Pipeline via GitHub Actions
Introduced atests.ymlworkflow to run tests on pushes/PRs using Node.js 20 andnpm ci.
Gives users higher confidence that releases stay stable over time. -
Coverage Reporting & Quality Gates
Added Jest coverage collection and strict global thresholds (100%) with lcov/html outputs and Codecov upload.
Ensures regressions are caught early and encourages high-quality contributions. -
Dependency Locking for Reproducibility
Addedpackage-lock.jsonand adjusted.gitignoreto keep it tracked while ignoring coverage output.
Makes installs deterministic across machines and CI environments. -
Documentation Enhancements (EN + DE)
AddedREADME.de.mdand refreshed badges/links and versioned jsDelivr snippet inREADME.md.
Improves onboarding and makes it easier to adopt the library correctly. -
Example Source Usage Update
Updated the example page to reference the local source file instead of a pinned CDN version.
Makes local development/testing against the repo code more straightforward.
Compatibility: Backward compatible
Full Changelog: 1.0.1...1.0.2
1.0.1
Release 1.0.1 – Changelog Summary
A stability and DX-focused update: adds a comprehensive Jest test suite, hardens option/language handling, and streamlines builds and local development. Minor housekeeping keeps the repo tidy and examples in sync.
-
Comprehensive Test Suite
Added 40+ Jest tests with jsdom environment and Babel transform.
Improves reliability, prevents regressions, and gives contributors fast feedback. -
Stronger Input Validation
Gracefully handlesnull/non-objectoptionsandlanguagearguments.
Prevents runtime errors and makes the API more forgiving in real-world usage. -
Bootstrap Integration
ESM build now imports Bootstrap explicitly; dependency declared in package metadata.
Ensures consistent behavior when bundling and avoids missing peer issues. -
Build Script Refinements
ESM output is cleaned up (explicit import, removed CommonJS footer); UMD keepsmodule.exports.
Produces clearer, purpose-specific bundles for modern and legacy consumers. -
Developer Environment Upgrades
Docker image updated to PHP 8.3 with Node 18 and Yarn; utility tools added.
Speeds up local setup and aligns the stack with current tooling. -
Project Hygiene
Added.gitignoreentries and removedpackage-lock.json.
Reduces noise in diffs and avoids accidental lockfile churn. -
Documentation & Examples Synced
README and example HTML now reference1.0.1CDN URLs.
Lowers copy-paste mistakes and guarantees users load the latest build. -
NPM Scripts & Config
Introducednpm testwithjest.config.js.
Makes running the suite a one-liner for contributors and CI.
Compatibility: Backward compatible.
Full Changelog: 1.0.0...1.0.1
1.0.0
Release 1.0.0 – Changelog Summary
This milestone marks the first stable release of AvalynxLightbox, bringing version alignment, documentation improvements, and expanded installation options. The focus is on clarity, integration flexibility, and overall project maturity.
-
Stable 1.0.0 Release
Promotes AvalynxLightbox to a stable release for production use.
Ensures consistent behavior and versioning across all distributed files. -
Symfony AssetComposer Integration
Added installation instructions for Symfony AssetComposer users.
Simplifies integration into Symfony projects and asset-managed environments. -
Documentation Enhancements
Expanded README with clearer setup examples and new installation paths.
Helps developers quickly configure the library regardless of their tech stack. -
Version Synchronization
Updated all references (source headers, package metadata, examples, CDN URLs) to1.0.0.
Guarantees users load the correct build everywhere. -
Changelog Cleanup
Removed the legacyCHANGELOG.mdfile to streamline repository maintenance.
Encourages use of release-based changelogs for consistency.
Compatibility: Backward compatible.
Full Changelog: 0.0.4...1.0.0
0.0.4
Release 0.0.4 – Changelog Summary
A small packaging & distribution update focused on cleaner installs and version consistency. Adds Composer/asset metadata and aligns docs, examples, and bundles to 0.0.4 for a smoother drop-in experience.
-
Composer Package Metadata
Introducescomposer.jsonforavalynx/avalynx-lightbox.
Enables straightforward PHP ecosystem installs and better dependency management. -
Asset Composer Manifest
Addsassetscomposer.jsonlisting distributable and dev files.
Improves build/publish flows and keeps delivered artifacts minimal and predictable. -
Documentation Version Sync
Updates README CDN snippet to0.0.4.
Reduces copy-paste errors and ensures users pull the latest build by default. -
Example Update
Demo page now references0.0.4on jsDelivr.
Guarantees the example reflects current behavior out of the box. -
Version Bumps Across the Project
Increments headers and package metadata (package.json, lockfile, dist/src banners) to0.0.4.
Keeps tooling, scripts, and distributed files in lockstep.
Compatibility: Backward compatible.
Full Changelog: 0.0.3...0.0.4
0.0.3
Release 0.0.3 – Changelog Summary
A focused quality update that improves how the lightbox opens and integrates into real-world markup. You’ll get smoother clicks (including on links), small refactors for consistency, and a cleaner repo.
-
Anchor Support
Now opens images when clicking<a href="...">wrappers, not just<img>elements.
Makes it easier to use thumbnails that link to full-size media. -
Safer Click Handling
Clicks on matched elements callpreventDefault()before opening the lightbox.
Prevents accidental page navigation and ensures a reliable lightbox experience. -
Refined Listener Setup
Event binding generalized from image-only to any matched elements.
Improves compatibility with different HTML structures and reduces selector fragility. -
Internal Refactor
Code style and naming streamlined across ESM and UMD builds.
Easier to read and maintain with no behavioral changes to the public API. -
Version Bump
Library version updated to0.0.3in source and distributed bundles.
Clearer dependency tracking and package management. -
Repository Cleanup
Removed the.ideadirectory from version control.
Keeps the repository tidy and avoids editor-specific noise.
Compatibility: Backward compatible.
Full Changelog: 0.0.2...0.0.3
0.0.2
Full Changelog: https://github.com/avalynx/avalynx-lightbox/commits/0.0.2