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.
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

View file

@ -1,10 +1,4 @@
<script>
/**
* @deprecated
* This component will be removed in version 1.0.0.
* Use `<Toggle size="sm" />` instead
*/
/** Set to `true` to toggle the checkbox input */
export let toggled = false;
@ -30,6 +24,11 @@
export let name = undefined;
</script>
<!-- @component
@deprecated This component is deprecated.
Use`<Toggle size="sm" />` instead.
-->
<!-- svelte-ignore a11y-mouse-events-have-key-events -->
<div
class:bx--form-item="{true}"

View file

@ -1,10 +1,4 @@
<script>
/**
* @deprecated
* This component will be removed in version 1.0.0.
* Use `<ToggleSkeleton size="sm" />` instead
*/
/** Specify the label text */
export let labelText = "";
@ -12,6 +6,11 @@
export let id = "ccs-" + Math.random().toString(36);
</script>
<!-- @component
@deprecated This component is deprecated.
Use`<ToggleSkeleton size="sm" />` instead.
-->
<!-- svelte-ignore a11y-mouse-events-have-key-events -->
<div
class:bx--form-item="{true}"