carbon-components-svelte/types/Icon/Icon.svelte.d.ts
metonym df4ed9d75a
fix(types): use @component comments for deprecation notices (#1111)
The Svelte Language Server allows component-level comments through `<!-- @component ... -->` syntax.

Deprecation notices for components should be moved from the script block to the markup template.
2022-02-19 18:50:25 -08:00

34 lines
847 B
TypeScript

/// <reference types="svelte" />
import { SvelteComponentTyped } from "svelte";
import { IconSkeletonProps } from "./IconSkeleton.svelte";
export interface IconProps
extends IconSkeletonProps,
svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["svg"]> {
/**
* Specify the icon to render
* @default undefined
*/
render?: typeof import("svelte").SvelteComponent;
/**
* Set to `true` to display the skeleton state
* @default false
*/
skeleton?: boolean;
}
/**
* @deprecated This component is deprecated.
* Use icons from "carbon-icons-svelte" instead.
*/
export default class Icon extends SvelteComponentTyped<
IconProps,
{
click: WindowEventMap["click"];
mouseover: WindowEventMap["mouseover"];
mouseenter: WindowEventMap["mouseenter"];
mouseleave: WindowEventMap["mouseleave"];
},
{}
> {}