mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
7fdc2ef7f0* chore(deps-dev): upgrade `sveld` to v0.18.1 * Run "yarn build:docs" * test: assert that `data-*` attributes are valid
61 lines
1.3 KiB
TypeScript
61 lines
1.3 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface ImageLoaderProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["img"]> {
|
|
/**
|
|
* Specify the image source
|
|
* @default ""
|
|
*/
|
|
src?: string;
|
|
|
|
/**
|
|
* Specify the image alt text
|
|
* @default ""
|
|
*/
|
|
alt?: string;
|
|
|
|
/**
|
|
* Specify the aspect ratio for the image wrapper
|
|
* @default undefined
|
|
*/
|
|
ratio?: "2x1" | "16x9" | "4x3" | "1x1" | "3x4" | "3x2" | "9x16" | "1x2";
|
|
|
|
/**
|
|
* Set to `true` when `loaded` is `true` and `error` is false
|
|
* @default false
|
|
*/
|
|
loading?: boolean;
|
|
|
|
/**
|
|
* Set to `true` when the image is loaded
|
|
* @default false
|
|
*/
|
|
loaded?: boolean;
|
|
|
|
/**
|
|
* Set to `true` if an error occurs when loading the image
|
|
* @default false
|
|
*/
|
|
error?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to fade in the image on load
|
|
* The duration uses the `fast-02` value following Carbon guidelines on motion
|
|
* @default false
|
|
*/
|
|
fadeIn?: boolean;
|
|
|
|
[key: `data-${string}`]: any;
|
|
}
|
|
|
|
export default class ImageLoader extends SvelteComponentTyped<
|
|
ImageLoaderProps,
|
|
{ load: CustomEvent<null>; error: CustomEvent<null> },
|
|
{ error: {}; loading: {} }
|
|
> {
|
|
/**
|
|
* Method invoked to load the image provided a `src` value
|
|
*/
|
|
loadImage: (url?: string) => void;
|
|
}
|