mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 12:09:26 +00:00
8121faa1d4
* keep header styles with repositioned description text * `animated-image` move description to component * code style * `avatar` add summary from docs * `badge` add summary from docs * `breadcrumb` add summary from docs * `button` add summary from docs * lead sentence is now part of the header * `button-group` add summary from docs * `card` add summary from docs * `checkbox` add summary from docs * `color-picker` add summary from docs * `details` add summary from docs * `dialog` add summary from docs * `divider` add summary from docs * `drawer` add summary from docs * `dropdown` add summary from docs * `format-bytes` add summary from docs * `format-date` add summary from docs * `format-number` add summary from docs * `icon` add summary from docs * `icon-button` add summary from docs * `image-comparer` add summary from docs * `include` add summary from docs * `input` add summary from docs * `menu` add summary from docs * `menu-item` add summary from docs * `menu-label` add summary from docs * `popup` add summary from docs * `progressbar` add summary from docs * `progress-ring` add summary from docs * `radio` add summary from docs * `radio-button` add summary from docs * `range` add summary from docs * `rating` add summary from docs * `relative-time` add summary from docs * `select` add summary from docs * `skeleton` add summary from docs * `spinner` add summary from docs * `split-panel` add summary from docs * `switch` add summary from docs * `tab-group` add summary from docs * `tag` add summary from docs * `textarea` add summary from docs * `tooltip` add summary from docs * `visually-hidden` add summary from docs * `animation` add summary from docs * `breadcrumb-item` add summary from docs * `mutation-observer` add summary from docs * `radio-group` add summary from docs * `resize-observer` add summary from docs * `tab` add summary from docs * `tab-panel` add summary from docs * `tree` add summary from docs * `tree-item` add summary from docs * remove `title` for further usage of `Sl` classnames in docs * revert: use markdown parser for component summary
82 lines
2.9 KiB
Markdown
82 lines
2.9 KiB
Markdown
# Image Comparer
|
|
|
|
[component-header:sl-image-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.)
|
|
|
|
```html preview
|
|
<sl-image-comparer>
|
|
<img
|
|
slot="before"
|
|
src="https://images.unsplash.com/photo-1517331156700-3c241d2b4d83?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=800&q=80&sat=-100&bri=-5"
|
|
alt="Grayscale version of kittens in a basket looking around."
|
|
/>
|
|
<img
|
|
slot="after"
|
|
src="https://images.unsplash.com/photo-1517331156700-3c241d2b4d83?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=800&q=80"
|
|
alt="Color version of kittens in a basket looking around."
|
|
/>
|
|
</sl-image-comparer>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlImageComparer } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlImageComparer>
|
|
<img
|
|
slot="before"
|
|
src="https://images.unsplash.com/photo-1517331156700-3c241d2b4d83?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=800&q=80&sat=-100&bri=-5"
|
|
alt="Grayscale version of kittens in a basket looking around."
|
|
/>
|
|
<img
|
|
slot="after"
|
|
src="https://images.unsplash.com/photo-1517331156700-3c241d2b4d83?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=800&q=80"
|
|
alt="Color version of kittens in a basket looking around."
|
|
/>
|
|
</SlImageComparer>
|
|
);
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Initial Position
|
|
|
|
Use the `position` attribute to set the initial position of the slider. This is a percentage from `0` to `100`.
|
|
|
|
```html preview
|
|
<sl-image-comparer position="25">
|
|
<img
|
|
slot="before"
|
|
src="https://images.unsplash.com/photo-1520903074185-8eca362b3dce?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1200&q=80"
|
|
alt="A person sitting on bricks wearing untied boots."
|
|
/>
|
|
<img
|
|
slot="after"
|
|
src="https://images.unsplash.com/photo-1520640023173-50a135e35804?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2250&q=80"
|
|
alt="A person sitting on a yellow curb tying shoelaces on a boot."
|
|
/>
|
|
</sl-image-comparer>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlImageComparer } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlImageComparer position={25}>
|
|
<img
|
|
slot="before"
|
|
src="https://images.unsplash.com/photo-1520903074185-8eca362b3dce?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1200&q=80"
|
|
alt="A person sitting on bricks wearing untied boots."
|
|
/>
|
|
<img
|
|
slot="after"
|
|
src="https://images.unsplash.com/photo-1520640023173-50a135e35804?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2250&q=80"
|
|
alt="A person sitting on a yellow curb tying shoelaces on a boot."
|
|
/>
|
|
</SlImageComparer>
|
|
);
|
|
```
|
|
|
|
[component-metadata:sl-image-comparer]
|