diff --git a/docs/_includes/svgs/image-comparer.njk b/docs/_includes/svgs/comparer.njk similarity index 100% rename from docs/_includes/svgs/image-comparer.njk rename to docs/_includes/svgs/comparer.njk diff --git a/docs/docs/components/image-comparer.md b/docs/docs/components/comparer.md similarity index 64% rename from docs/docs/components/image-comparer.md rename to docs/docs/components/comparer.md index 95d1ca513..f34e402cb 100644 --- a/docs/docs/components/image-comparer.md +++ b/docs/docs/components/comparer.md @@ -1,14 +1,16 @@ --- -title: Image Comparer -description: Compare visual differences between similar photos with a sliding panel. +title: Comparer +description: Compare visual differences between similar content with a sliding panel. tags: [imagery, niche] -icon: image-comparer +icon: comparer --- -For best results, use images that share the same dimensions. The slider can be controlled by dragging or pressing the left and right arrow keys. (Tip: press shift + arrows to move the slider in larger intervals, or home + end to jump to the beginning or end.) +This is especially useful for comparing images, but can be used for comparing any type of content (for an example of using it to compare entire UIs, check out our [theme pages](/docs/themes/default/)). +For best results, use content that shares the same dimensions. +The slider can be controlled by dragging or pressing the left and right arrow keys. (Tip: press shift + arrows to move the slider in larger intervals, or home + end to jump to the beginning or end.) ```html {.example} - + Color version of kittens in a basket looking around. - + ``` ## Examples @@ -29,7 +31,7 @@ For best results, use images that share the same dimensions. The slider can be c Use the `position` attribute to set the initial position of the slider. This is a percentage from `0` to `100`. ```html {.example} - + A person sitting on a yellow curb tying shoelaces on a boot. - + ``` diff --git a/docs/docs/resources/changelog.md b/docs/docs/resources/changelog.md index 3f41e2267..724cf2053 100644 --- a/docs/docs/resources/changelog.md +++ b/docs/docs/resources/changelog.md @@ -12,6 +12,10 @@ Components with the Experimental bad During the alpha period, things might break! We take breaking changes very seriously, but sometimes they're necessary to make the final product that much better. We appreciate your patience! ::: +## Next + +- 🚨 BREAKING: Renamed `` to `` and improved compatibility for non-image content. + ## 3.0.0-alpha.12 ### Enhancements diff --git a/docs/docs/themes/demo.njk b/docs/docs/themes/demo.njk index 018e4cb9a..0bf216615 100644 --- a/docs/docs/themes/demo.njk +++ b/docs/docs/themes/demo.njk @@ -26,14 +26,14 @@ eleventyComputed: {% include 'theme-showcase.njk' %} {% endset %} - + - +