mcp/carbon-components-svelte
1
0
Fork 0
mirror of https://github.com/carbon-design-system/carbon-components-svelte.git synced 2025-09-14 18:01:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
* 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
Download patch file Download diff file Expand all files Collapse all files

2
types/Button/Button.svelte.d.ts vendored
View file

@ -45,7 +45,7 @@ export interface ButtonProps
hasIconOnly?: boolean;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;

2
types/ContextMenu/ContextMenuOption.svelte.d.ts vendored
View file

@ -22,7 +22,7 @@ export interface ContextMenuOptionProps
indented?: boolean;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* Icon is rendered to the left of the label text
*/
icon?: typeof import("svelte").SvelteComponent;

2
types/Icon/Icon.svelte.d.ts vendored
View file

@ -6,7 +6,7 @@ export interface IconProps
extends IconSkeletonProps,
svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["svg"]> {
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
render?: typeof import("svelte").SvelteComponent;

2
types/Link/Link.svelte.d.ts vendored
View file

@ -20,7 +20,7 @@ export interface LinkProps
inline?: boolean;
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
* `inline` must be `false`
*/
icon?: typeof import("svelte").SvelteComponent;

2
types/Notification/NotificationButton.svelte.d.ts vendored
View file

@ -10,7 +10,7 @@ export interface NotificationButtonProps
notificationType?: "toast" | "inline";
/**
* Specify the icon from `carbon-icons-svelte` to render
* Specify the icon to render
*/
icon?: typeof import("svelte").SvelteComponent;

2
types/OverflowMenu/OverflowMenu.svelte.d.ts vendored
View file

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

2
types/Search/Search.svelte.d.ts vendored
View file

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

2
types/Tag/Tag.svelte.d.ts vendored
View file

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

2
types/Tooltip/Tooltip.svelte.d.ts vendored
View file

@ -28,7 +28,7 @@ export interface TooltipProps
hideIcon?: boolean;
/**
* 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`)
*/
icon?: typeof import("svelte").SvelteComponent;

2
types/TooltipIcon/TooltipIcon.svelte.d.ts vendored
View file

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

4
types/UIShell/GlobalHeader/Header.svelte.d.ts vendored
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;

4
types/UIShell/GlobalHeader/HeaderAction.svelte.d.ts vendored
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;

2
types/UIShell/GlobalHeader/HeaderActionLink.svelte.d.ts vendored
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;

2
types/UIShell/SideNav/SideNavLink.svelte.d.ts vendored
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;

2
types/UIShell/SideNav/SideNavMenu.svelte.d.ts vendored
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;