mirror of
https://github.com/shoelace-style/webawesome.git
synced 2026-01-12 20:19:13 +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
124 lines
2.8 KiB
Markdown
124 lines
2.8 KiB
Markdown
# Animated Image
|
|
|
|
[component-header:sl-animated-image]
|
|
|
|
```html preview
|
|
<sl-animated-image
|
|
src="https://shoelace.style/assets/images/walk.gif"
|
|
alt="Animation of untied shoes walking on pavement"
|
|
></sl-animated-image>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlAnimatedImage } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlAnimatedImage
|
|
src="https://shoelace.style/assets/images/walk.gif"
|
|
alt="Animation of untied shoes walking on pavement"
|
|
/>
|
|
);
|
|
```
|
|
|
|
?> This component uses `<canvas>` to draw freeze frames, so images are subject to [cross-origin restrictions](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image).
|
|
|
|
## Examples
|
|
|
|
### WEBP Images
|
|
|
|
Both GIF and WEBP images are supported.
|
|
|
|
```html preview
|
|
<sl-animated-image
|
|
src="https://shoelace.style/assets/images/tie.webp"
|
|
alt="Animation of a shoe being tied"
|
|
></sl-animated-image>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlAnimatedImage } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlAnimatedImage src="https://shoelace.style/assets/images/tie.webp" alt="Animation of a shoe being tied" />
|
|
);
|
|
```
|
|
|
|
### Setting a Width and Height
|
|
|
|
To set a custom size, apply a width and/or height to the host element.
|
|
|
|
```html preview
|
|
<sl-animated-image
|
|
src="https://shoelace.style/assets/images/walk.gif"
|
|
alt="Animation of untied shoes walking on pavement"
|
|
style="width: 150px; height: 200px;"
|
|
>
|
|
</sl-animated-image>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlAnimatedImage } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const App = () => (
|
|
<SlAnimatedImage
|
|
src="https://shoelace.style/assets/images/walk.gif"
|
|
alt="Animation of untied shoes walking on pavement"
|
|
style={{ width: '150px', height: '200px' }}
|
|
/>
|
|
);
|
|
```
|
|
|
|
### Customizing the Control Box
|
|
|
|
You can change the appearance and location of the control box by targeting the `control-box` part in your styles.
|
|
|
|
```html preview
|
|
<sl-animated-image
|
|
src="https://shoelace.style/assets/images/walk.gif"
|
|
alt="Animation of untied shoes walking on pavement"
|
|
class="animated-image-custom-control-box"
|
|
></sl-animated-image>
|
|
|
|
<style>
|
|
.animated-image-custom-control-box::part(control-box) {
|
|
top: auto;
|
|
right: auto;
|
|
bottom: 1rem;
|
|
left: 1rem;
|
|
background-color: deeppink;
|
|
border: none;
|
|
color: pink;
|
|
}
|
|
</style>
|
|
```
|
|
|
|
```jsx react
|
|
import { SlAnimatedImage } from '@shoelace-style/shoelace/dist/react';
|
|
|
|
const css = `
|
|
.animated-image-custom-control-box::part(control-box) {
|
|
top: auto;
|
|
right: auto;
|
|
bottom: 1rem;
|
|
left: 1rem;
|
|
background-color: deeppink;
|
|
border: none;
|
|
color: pink;
|
|
}
|
|
`;
|
|
|
|
const App = () => (
|
|
<>
|
|
<SlAnimatedImage
|
|
className="animated-image-custom-control-box"
|
|
src="https://shoelace.style/assets/images/walk.gif"
|
|
alt="Animation of untied shoes walking on pavement"
|
|
/>
|
|
|
|
<style>{css}</style>
|
|
</>
|
|
);
|
|
```
|
|
|
|
[component-metadata:sl-animated-image]
|