vuetning
Version:
<p align="center"> <img width="160"src="https://s3.amazonaws.com/arcthos.com/vuetning/logo.svg"> </p>
209 lines (208 loc) • 6.07 kB
TypeScript
declare const _default: import("vue").DefineComponent<{
/**
* The alternative text used to describe the icon.
* This text should describe what happens when you click the button, for example 'Upload File', not what the
* icon looks like, 'Paperclip'.
*/
alternativeText: StringConstructor;
/**
* The alternative text used to describe the icon.
* This text should describe what happens when you click the button,
* for example 'Upload File', not what the icon looks like, 'Paperclip'.
*/
assistiveText: StringConstructor;
/**
* Indicates whether the icon has the brand variant.
*/
brand: BooleanConstructor;
/**
* Indicates whether to change the fill of an icon to match the current color of its parent
*/
currentColor: BooleanConstructor;
/**
* Indicates whether the icon has the error theme.
*/
error: BooleanConstructor;
/**
* The class names to be passed to the icon.
*/
iconClass: (StringConstructor | ArrayConstructor)[];
/**
* The Lightning Design System name of the icon.
* Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed.
*/
iconName: {
type: StringConstructor;
required: true;
};
/**
* Indicates whether the icon has the inverse theme.
*/
inverse: BooleanConstructor;
/**
* Indicates whether the icon uses the large size.
*/
large: BooleanConstructor;
/**
* Indicates whether the icon has the light theme.
*/
light: BooleanConstructor;
/**
* Indicates whether the icon uses the medium size.
* If no other size is set, this one will be used by default.
*/
medium: BooleanConstructor;
/**
* Indicates whether the icon uses the small size.
*/
small: BooleanConstructor;
/**
* Indicates whether the icon uses the standard icon format.
*/
standardFormat: BooleanConstructor;
/**
* Indicates whether the icon has the success theme.
*/
success: BooleanConstructor;
/**
* Indicates whether the icon uses the xSmall size.
*/
xSmall: BooleanConstructor;
/**
* Indicates whether the icon uses the xxSmall size.
*/
xxSmall: BooleanConstructor;
/**
* The icon title.
*/
title: StringConstructor;
/**
* Indicates whether the icon has the warning theme.
*/
warning: BooleanConstructor;
}, unknown, {
/**
* Parsed background class.
*/
backgroundClass: string;
/**
* Icon category.
*/
category: string;
/**
* Icon name.
*/
name: string;
}, {
/**
* The CSS class names for the icon container element.
*/
iconContainerClassNames(): string;
/**
* The CSS class names for the icon element.
*/
iconClassNames(): string;
}, {
/**
* Parses the background class from the icon name.
* @param iconName The icon name.
*/
parseBackground(iconName: string): void;
}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* The alternative text used to describe the icon.
* This text should describe what happens when you click the button, for example 'Upload File', not what the
* icon looks like, 'Paperclip'.
*/
alternativeText: StringConstructor;
/**
* The alternative text used to describe the icon.
* This text should describe what happens when you click the button,
* for example 'Upload File', not what the icon looks like, 'Paperclip'.
*/
assistiveText: StringConstructor;
/**
* Indicates whether the icon has the brand variant.
*/
brand: BooleanConstructor;
/**
* Indicates whether to change the fill of an icon to match the current color of its parent
*/
currentColor: BooleanConstructor;
/**
* Indicates whether the icon has the error theme.
*/
error: BooleanConstructor;
/**
* The class names to be passed to the icon.
*/
iconClass: (StringConstructor | ArrayConstructor)[];
/**
* The Lightning Design System name of the icon.
* Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed.
*/
iconName: {
type: StringConstructor;
required: true;
};
/**
* Indicates whether the icon has the inverse theme.
*/
inverse: BooleanConstructor;
/**
* Indicates whether the icon uses the large size.
*/
large: BooleanConstructor;
/**
* Indicates whether the icon has the light theme.
*/
light: BooleanConstructor;
/**
* Indicates whether the icon uses the medium size.
* If no other size is set, this one will be used by default.
*/
medium: BooleanConstructor;
/**
* Indicates whether the icon uses the small size.
*/
small: BooleanConstructor;
/**
* Indicates whether the icon uses the standard icon format.
*/
standardFormat: BooleanConstructor;
/**
* Indicates whether the icon has the success theme.
*/
success: BooleanConstructor;
/**
* Indicates whether the icon uses the xSmall size.
*/
xSmall: BooleanConstructor;
/**
* Indicates whether the icon uses the xxSmall size.
*/
xxSmall: BooleanConstructor;
/**
* The icon title.
*/
title: StringConstructor;
/**
* Indicates whether the icon has the warning theme.
*/
warning: BooleanConstructor;
}>>, {
small: boolean;
brand: boolean;
error: boolean;
success: boolean;
warning: boolean;
standardFormat: boolean;
large: boolean;
inverse: boolean;
xSmall: boolean;
xxSmall: boolean;
currentColor: boolean;
light: boolean;
medium: boolean;
}, {}>;
export default _default;