@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
45 lines • 1.69 kB
TypeScript
import { CanvasIcon, CanvasIconTypes } from '@workday/design-assets-types';
import { BoxProps } from '@workday/canvas-kit-react/layout';
export interface SvgProps extends BoxProps {
src: CanvasIcon;
type: CanvasIconTypes;
/**
* If set to `true`, transform the SVG's x-axis to mirror the graphic. Use this if you want to
* always mirror the icon regardless of the content direction. If the SVG should mirror only when
* in an right-to-left language, use `shouldMirrorInRTL` instead.
* @default false
*/
shouldMirror?: boolean;
/**
* If set to `true`, transform the SVG's x-axis to mirror the graphic when the content direction
* is `rtl`. Icons don't have enough context to know if they should be mirrored in all cases.
* Setting this to `true` indicates the icon should be mirrored in right-to-left languages.
* @default false
*/
shouldMirrorInRTL?: boolean;
}
export declare const svgStencil: import("@workday/canvas-kit-styling").Stencil<{
shouldMirror: {
true: {
transform: string;
};
};
shouldMirrorInRTL: {
true: {
'&:dir(rtl)': {
transform: string;
};
};
};
}, {}, {
/** sets width of svg element */
width: string;
/** sets height of svg element */
height: string;
/** sets width and height of svg element */
size: string;
}, never, never>;
/** @deprecated */
export declare const transformColorNameToToken: (color?: string) => string | undefined;
export declare const Svg: import("@workday/canvas-kit-react/common").ElementComponent<"span", SvgProps>;
//# sourceMappingURL=Svg.d.ts.map