fix: use @component comments for deprecation notices

This commit is contained in:
Eric Liu 2022-02-19 18:40:33 -08:00
commit d349492b46
6 changed files with 27 additions and 34 deletions

View file

@ -1,10 +1,4 @@
<script> <script>
/**
* @deprecated
* This component will be removed in version 1.0.0.
* Use icons from "carbon-icons-svelte" instead
*/
/** /**
* @extends {"./IconSkeleton.svelte"} IconSkeletonProps * @extends {"./IconSkeleton.svelte"} IconSkeletonProps
* @restProps {svg} * @restProps {svg}
@ -22,6 +16,11 @@
import IconSkeleton from "./IconSkeleton.svelte"; import IconSkeleton from "./IconSkeleton.svelte";
</script> </script>
<!-- @component
@deprecated This component is deprecated.
Use icons from "carbon-icons-svelte" instead.
-->
{#if skeleton} {#if skeleton}
<IconSkeleton <IconSkeleton
{...$$restProps} {...$$restProps}

View file

@ -1,13 +1,12 @@
<script> <script>
/**
* @deprecated
* This component will be removed in version 1.0.0.
*/
/** Set the size of the icon */ /** Set the size of the icon */
export let size = 16; export let size = 16;
</script> </script>
<!-- @component
@deprecated This component is deprecated.
-->
<!-- svelte-ignore a11y-mouse-events-have-key-events --> <!-- svelte-ignore a11y-mouse-events-have-key-events -->
<div <div
class:bx--icon--skeleton="{true}" class:bx--icon--skeleton="{true}"

View file

@ -1,9 +1,4 @@
<script> <script>
/**
* @deprecated
* This component will be removed in version 1.0.0.
*/
/** /**
* Set the type of notification * Set the type of notification
* @type {"toast" | "inline"} * @type {"toast" | "inline"}
@ -20,6 +15,10 @@
export let caption = "Caption"; export let caption = "Caption";
</script> </script>
<!-- @component
@deprecated This component is deprecated.
-->
{#if notificationType === "toast"} {#if notificationType === "toast"}
<div class:bx--toast-notification__details="{true}"> <div class:bx--toast-notification__details="{true}">
<h3 class:bx--toast-notification__title="{true}">{title}</h3> <h3 class:bx--toast-notification__title="{true}">{title}</h3>

View file

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

View file

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

View file

@ -1,10 +1,4 @@
<script> <script>
/**
* @deprecated
* This component will be removed in version 1.0.0.
* Use `HeaderSearch` instead
*/
/** /**
* @event {{ action: "search"; textInput: string; }} inputSearch * @event {{ action: "search"; textInput: string; }} inputSearch
*/ */
@ -64,6 +58,10 @@
}}" }}"
/> />
<!-- @component
@deprecated
This component is deprecated. Use `HeaderSearch` instead.
-->
<div <div
bind:this="{elTypeSearch}" bind:this="{elTypeSearch}"
role="search" role="search"