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

18
docs/src/COMPONENT_API.json
View file

@ -4608,7 +4608,8 @@
{ "type": "dispatched", "name": "focusInputSearch" },
{ "type": "dispatched", "name": "focusOutInputSearch" }
],
"typedefs": []
"typedefs": [],
"componentComment": "\n@deprecated\nThis component is deprecated. Use `HeaderSearch` instead."
},
{
"moduleName": "HeaderGlobalAction",
@ -4991,7 +4992,8 @@
"extends": {
"interface": "IconSkeletonProps",
"import": "\"./IconSkeleton.svelte\""
}
},
"componentComment": "\n@deprecated This component is deprecated.\nUse icons from \"carbon-icons-svelte\" instead."
},
{
"moduleName": "IconSkeleton",
@ -5017,7 +5019,8 @@
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
"rest_props": { "type": "Element", "name": "div" },
"componentComment": "\n@deprecated This component is deprecated."
},
{
"moduleName": "ImageLoader",
@ -6985,7 +6988,8 @@
],
"slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
"events": [],
"typedefs": []
"typedefs": [],
"componentComment": "\n@deprecated This component is deprecated."
},
{
"moduleName": "NumberInput",
@ -12716,7 +12720,8 @@
{ "type": "forwarded", "name": "blur", "element": "input" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
"rest_props": { "type": "Element", "name": "div" },
"componentComment": "\n@deprecated This component is deprecated.\nUse`<Toggle size=\"sm\" />` instead."
},
{
"moduleName": "ToggleSmallSkeleton",
@ -12753,7 +12758,8 @@
{ "type": "forwarded", "name": "mouseleave", "element": "div" }
],
"typedefs": [],
"rest_props": { "type": "Element", "name": "div" }
"rest_props": { "type": "Element", "name": "div" },
"componentComment": "\n@deprecated This component is deprecated.\nUse`<ToggleSkeleton size=\"sm\" />` instead."
},
{
"moduleName": "Toolbar",