Détail du package

starlight-image-zoom

HiDeoo19.6kMIT0.13.0

Starlight plugin adding zoom capabilities to your documentation images.

starlight, image, zoom, documentation

readme

starlight-image-zoom 🕵️

Starlight plugin adding zoom capabilities to your documentation images.

Getting Started

Want to get started immediately? Check out the getting started guide or check out the demo to see the plugin in action.

Features

A Starlight plugin adding zoom capabilities to your documentation images.

  • Lightweight UI based on the <dialog> element
  • No client-side third-party dependencies
  • Markdown and MDX images support: Markdown syntax, HTML syntax, and the <Image> or <Picture> components
  • Alternate text displayed as a caption
  • Accessible buttons to trigger zoom

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.

changelog

starlight-image-zoom

0.13.0

Minor Changes

  • #44 eba0382 Thanks @HiDeoo! - Adds a new <Zoom> component to wrap images or SVG components and make them zoomable.

    This can be useful for advanced use cases where the plugin cannot automatically apply zoom functionality, such as rendering images in a loop of an Astro component or using SVG components. Learn more in the “Zoom component” guide.

0.12.0

Minor Changes

  • #39 837e543 Thanks @HiDeoo! - Adds a new data-zoom-id attribute to zoomed images matching the id of the original image if it exists.

    This can be useful if you are relying on the id attribute to customize the appearance of images using CSS and also want to apply the same styles to zoomed images.

0.11.1

Patch Changes

  • #34 58dcce6 Thanks @DaniFoldi! - Moves mdast-util-mdx-jsx package to non-dev dependencies to prevent issues in monorepos with hoisting disabled.

0.11.0

Minor Changes

  • #32 02a52df Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.32.0.

    Please use the @astrojs/upgrade command to upgrade your project:

    npx @astrojs/upgrade

0.10.1

Patch Changes

  • #30 98ae50e Thanks @HiDeoo! - Fixes an issue where SVG images were not being properly identified as SVGs when running in development mode.

0.10.0

Minor Changes

  • #27 e716c66 Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.

    ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0.

    Please follow the upgrade guide to update your project.