mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
a397b981f5
* WIP: moving to a static .d.ts types file * fixing named exports for getImage and getPicture * removing the exports.astro map for now * WIP: adding readme docs for component attributes * Adding docs for getImage and getPicture * leaning fully on TSC to build .d.ts files * finally found the solution for proper ESM import types * adding a note to the README for tsconfig updates * chore: add changesets * typo * docs: removing the "Images in Markdown" example * removing the need for publishing src to NPM * fix: make type re-export explicit * updating image module defs to match InputFormat * using astro syntax highlighting for README code blocks * nit: missing backtick in README * make sure Astro component directives aren't recommended twice
46 lines
1.3 KiB
Text
46 lines
1.3 KiB
Text
---
|
|
import { getPicture } from '../dist/index.js';
|
|
import type { ImgHTMLAttributes, HTMLAttributes } from './index.js';
|
|
import type { ImageMetadata, OutputFormat, TransformOptions } from '../dist/index.js';
|
|
|
|
interface LocalImageProps extends
|
|
Omit<HTMLAttributes, 'src' | 'width' | 'height'>,
|
|
Omit<TransformOptions, 'src'>,
|
|
Pick<astroHTML.JSX.ImgHTMLAttributes, 'loading' | 'decoding'> {
|
|
src: ImageMetadata | Promise<{ default: ImageMetadata }>;
|
|
alt?: string;
|
|
sizes: HTMLImageElement['sizes'];
|
|
widths: number[];
|
|
formats?: OutputFormat[];
|
|
}
|
|
|
|
interface RemoteImageProps extends
|
|
Omit<HTMLAttributes, 'src' | 'width' | 'height'>,
|
|
TransformOptions,
|
|
Pick<ImgHTMLAttributes, 'loading' | 'decoding'> {
|
|
src: string;
|
|
alt?: string;
|
|
sizes: HTMLImageElement['sizes'];
|
|
widths: number[];
|
|
aspectRatio: TransformOptions['aspectRatio'];
|
|
formats?: OutputFormat[];
|
|
}
|
|
|
|
export type Props = LocalImageProps | RemoteImageProps;
|
|
|
|
const { src, alt, sizes, widths, aspectRatio, formats = ['avif', 'webp'], loading = 'lazy', decoding = 'async', ...attrs } = Astro.props as Props;
|
|
|
|
const { image, sources } = await getPicture({ src, widths, formats, aspectRatio });
|
|
---
|
|
|
|
<picture {...attrs}>
|
|
{sources.map(attrs => (
|
|
<source {...attrs} {sizes}>))}
|
|
<img {...image} {loading} {decoding} {alt} />
|
|
</picture>
|
|
|
|
<style>
|
|
img {
|
|
content-visibility: auto;
|
|
}
|
|
</style>
|