import { TemplateResult } from 'lit'; import { Cre8Element } from '../cre8-element'; /** * * * is a web component, which can be used with any frontend framework and use any svg. * It takes raw svgs as props and renders them. * * **'svg-legacy'** will be **deprecated** in Web Components v0.5.0 * * - [List of new figma @tmorrow/cre8-wc/icons](https:/www.figma.com/file/j1a0rBkoH65XiGKfq7ppWa/Iconography?type=design&node-id=2037-5773&mode=design&t=6ZzC6KH3Gkxf3fj5-4) * - The new `svg` from the svg package: https:/static-dev.esi-memberweb-dev.aws.evernorthcloud.com/svgs/. * * ##Usability Considerations * - If the icon is decorative: set `aria-hidden` to true. * - If the icon is interactive (not decorative): set `aria-hidden` to false and add the `aria-label` * - If the icon is key to functionality from a screen reader perspective, it is required to add `aria-label` * which will describe the icon. * For example, if the icon is a close button, setting `aria-label="Close"`will give * the SVG an aria-label to make it sufficiently accessible. * * [More information on Accessibility with svgs](https:/static-dev.esi-memberweb-dev.aws.evernorthcloud.com/svgs/?path=/story/getting-started-accessibility--page) * * ##How to use * Cre8 Web Components (cre8-wc) includes the `cre8_dev/svgs` package. * If you need to install a newer version than what's included, please see * the [installation instructions for svgs](https:/git.express-scripts.com/ExpressScripts/svgs#installation). * - Import the component (this is the icon container): `import '@cre8_dev/svgs';` * - Import an svg as a string: `import svgInfo from '@tmorrow/cre8-wc/icons/Info.svg?raw';` * * Your import paths may be different depending on your project's build configuration. * Please see [Importing Icons](https:/static-dev.esi-memberweb-dev.aws.evernorthcloud.com/svgs/?path=/story/icon-sets-importing-@tmorrow/cre8-wc/icons--page) * of the `cre8_dev/svgs` documentation for more information. */ export declare class Cre8Icon extends Cre8Element { static styles: import("lit").CSSResult[]; /** * Focusable * * @required */ focusable?: boolean; /** * Icon name (this method of passing in svgs is to be deprecated) * * @required */ name: string; svg?: string; /** * Icon path * 1) This points to the file where the icon sprite lives * 2) This method of pathing will soon be depricated * */ iconUrl?: string; /** * Icon Title, this string is used for the aira-label of the svg * * @required */ iconTitle?: string; /** * Get the path to the @tmorrow/cre8-wc/icons, either by overriding it on the window * or by using the bundled icon path */ getIconPath(): string; render(): TemplateResult<1>; } declare global { interface HTMLElementTagNameMap { 'cre8-icon': Cre8Icon; } interface Window { Cre8_ICON_URL?: string; } } export default Cre8Icon; //# sourceMappingURL=icon.d.ts.map