mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-15 02:11:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix(types): use @component comments for deprecation notices (#1111)

Browse source 
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.
This commit is contained in:
metonym 2022-02-19 18:50:25 -08:00 • committed by GitHub
commit df4ed9d75a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 61 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

4
types/Icon/Icon.svelte.d.ts vendored
View file

@ -18,6 +18,10 @@ export interface IconProps
skeleton?: boolean;
}
/**
* @deprecated This component is deprecated.
* Use icons from "carbon-icons-svelte" instead.
*/
export default class Icon extends SvelteComponentTyped<
IconProps,
{

3
types/Icon/IconSkeleton.svelte.d.ts vendored
View file

@ -10,6 +10,9 @@ export interface IconSkeletonProps
size?: number;
}
/**
* @deprecated This component is deprecated.
*/
export default class IconSkeleton extends SvelteComponentTyped<
IconSkeletonProps,
{

3
types/Notification/NotificationTextDetails.svelte.d.ts vendored
View file

@ -27,6 +27,9 @@ export interface NotificationTextDetailsProps {
caption?: string;
}
/**
* @deprecated This component is deprecated.
*/
export default class NotificationTextDetails extends SvelteComponentTyped<
NotificationTextDetailsProps,
{},

4
types/ToggleSmall/ToggleSmall.svelte.d.ts vendored
View file

@ -46,6 +46,10 @@ export interface ToggleSmallProps
name?: string;
}
/**
* @deprecated This component is deprecated.
* Use`<Toggle size="sm" />` instead.
*/
export default class ToggleSmall extends SvelteComponentTyped<
ToggleSmallProps,
{

4
types/ToggleSmall/ToggleSmallSkeleton.svelte.d.ts vendored
View file

@ -16,6 +16,10 @@ export interface ToggleSmallSkeletonProps
id?: string;
}
/**
* @deprecated This component is deprecated.
* Use`<ToggleSkeleton size="sm" />` instead.
*/
export default class ToggleSmallSkeleton extends SvelteComponentTyped<
ToggleSmallSkeletonProps,
{

4
types/UIShell/GlobalHeader/HeaderActionSearch.svelte.d.ts vendored
View file

@ -9,6 +9,10 @@ export interface HeaderActionSearchProps {
searchIsActive?: boolean;
}
/**
* @deprecated
* This component is deprecated. Use `HeaderSearch` instead.
*/
export default class HeaderActionSearch extends SvelteComponentTyped<
HeaderActionSearchProps,
{