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

@ -62,13 +62,13 @@ export interface HeaderProps
ref?: null | HTMLAnchorElement;
/**
* 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`
*/
iconMenu?: typeof import("svelte").SvelteComponent;
/**
* 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`
*/
iconClose?: typeof import("svelte").SvelteComponent;

View file

@ -16,12 +16,12 @@ export interface HeaderActionProps
isOpen?: boolean;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;
/**
* Specify the close icon from `carbon-icons-svelte` to render
* Specify the icon to render when the action panel is open
*/
closeIcon?: typeof import("svelte").SvelteComponent;

View file

@ -15,7 +15,7 @@ export interface HeaderActionLinkProps
href?: string;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;

View file

@ -20,7 +20,7 @@ export interface SideNavLinkProps
text?: string;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;

View file

@ -15,7 +15,7 @@ export interface SideNavMenuProps
text?: string;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;