Omit explicit "from carbon-icons-svelte" from icon prop definitions (#866)

* fix(types): update description for icon props #865

* docs(component-api): remove hardcoded Carbon Svelte icon description
This commit is contained in:
Eric Liu 2021-10-20 13:48:52 -07:00 committed by GitHub
commit 7b65a15345
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
36 changed files with 120 additions and 131 deletions

View file

@ -32,7 +32,7 @@
export let hasIconOnly = false;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -12,7 +12,7 @@
export let indented = false;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* Icon is rendered to the left of the label text
* @type {typeof import("svelte").SvelteComponent}
*/

View file

@ -11,7 +11,7 @@
*/
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let render = undefined;

View file

@ -15,7 +15,7 @@
export let inline = false;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* `inline` must be `false`
* @type {typeof import("svelte").SvelteComponent}
*/

View file

@ -6,7 +6,7 @@
export let notificationType = "toast";
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = Close20;

View file

@ -31,7 +31,7 @@
export let menuOptionsClass = undefined;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = OverflowMenuVertical16;

View file

@ -59,7 +59,7 @@
export let labelText = "";
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = Search16;

View file

@ -26,7 +26,7 @@
export let title = "Clear filter";
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -24,7 +24,7 @@
export let hideIcon = false;
/**
* Specify the icon from `carbon-icons-svelte` to render for the tooltip button
* Specify the icon to render for the tooltip button
* Icon size must be 16px (e.g., `Add16`, `Task16`)
* @type {typeof import("svelte").SvelteComponent}
*/

View file

@ -6,7 +6,7 @@
export let tooltipText = "";
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -44,7 +44,7 @@
export let disabled = false;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -15,7 +15,7 @@
export let disabled = false;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -47,14 +47,14 @@
export let ref = null;
/**
* Specify the icon from `carbon-icons-svelte` to render for the closed state
* Specify the icon to render for the closed state
* Defaults to `Menu20`
* @type {typeof import("svelte").SvelteComponent}
*/
export let iconMenu = Menu20;
/**
* Specify the icon from `carbon-icons-svelte` to render for the opened state
* Specify the icon to render for the opened state
* Defaults to `Close20`
* @type {typeof import("svelte").SvelteComponent}
*/

View file

@ -7,13 +7,13 @@
export let isOpen = false;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = AppSwitcher20;
/**
* Specify the close icon from `carbon-icons-svelte` to render
* Specify the icon to render when the action panel is open
* @type {typeof import("svelte").SvelteComponent}
*/
export let closeIcon = Close20;

View file

@ -9,7 +9,7 @@
export let href = undefined;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -9,14 +9,14 @@
export let isOpen = false;
/**
* Specify the icon from `carbon-icons-svelte` to render for the closed state
* Specify the icon to render for the closed state
* Defaults to `Menu20`
* @type {typeof import("svelte").SvelteComponent}
*/
export let iconMenu = Menu20;
/**
* Specify the icon from `carbon-icons-svelte` to render for the opened state
* Specify the icon to render for the opened state
* Defaults to `Close20`
* @type {typeof import("svelte").SvelteComponent}
*/

View file

@ -15,7 +15,7 @@
export let text = undefined;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;

View file

@ -9,7 +9,7 @@
export let text = undefined;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* @type {typeof import("svelte").SvelteComponent}
*/
export let icon = undefined;