@limetech/lime-elements
Version:
41 lines • 1.06 kB
TypeScript
import { IconSize } from './icon.types';
/**
* :::important
* To install your icon set correctly, please read the [documentation here](#/).
* :::
*
* The size and color of the icon is normally set in CSS, however there are a few
* standard sizes defined that can be used with the `size` property.
*
* @exampleComponent limel-example-icon-name
* @exampleComponent limel-example-icon-size
* @exampleComponent limel-example-icon-color
*/
export declare class Icon {
/**
* Size of the icon
*/
size: IconSize;
/**
* Name of the icon
*/
name: string;
/**
* Set to `true` to give the icon a round background with some padding.
* Only works when the `size` attribute is also set.
*/
badge: boolean;
private host;
componentDidLoad(): void;
render(): any;
protected loadIcon(name: string): Promise<void>;
/**
* Load the SVG data for the icon from the icon cache
*
* @param name - name of the icon
* @returns the icon SVG data
*/
private loadSvg;
private renderSvg;
}
//# sourceMappingURL=icon.d.ts.map