@wonderflow/react-components
Version:
UI components from Wonderflow's Wanda design system
46 lines • 2.19 kB
TypeScript
import { SymbolNames } from '@wonderflow/symbols';
import { TokensTypes } from '@wonderflow/tokens/platforms/web';
import { ReactElement, SVGAttributes } from 'react';
export declare type SymbolProps = SVGAttributes<SVGElement | SVGSVGElement> & {
/**
* Set the icon name to display. Icon names are defined in
* the `SymbolNames` enum and are part of Wanda's symbols system.
*
* Available icons: https://design.wonderflow.ai/get-started/symbols
*/
source: SymbolNames | ReactElement<HTMLOrSVGElement>;
/**
* Set the size of the icon. To improve readability at any size, the style of the icon
* is automatically defined based on the dimension.
*/
dimension?: TokensTypes['icon']['size'];
/**
* Set the weight of the icon.
* The default weight is `outline` if `dimension` is greather than `12` or `undefined`.
* If `dimension` is set to `12`, the weight is ignored and the icon forced to use
* the `solid` style to improve the readability.
*/
weight?: 'solid' | 'outline' | 'duotone';
};
export declare const Symbol: import("react").ForwardRefExoticComponent<SVGAttributes<SVGElement | SVGSVGElement> & {
/**
* Set the icon name to display. Icon names are defined in
* the `SymbolNames` enum and are part of Wanda's symbols system.
*
* Available icons: https://design.wonderflow.ai/get-started/symbols
*/
source: SymbolNames | ReactElement<HTMLOrSVGElement>;
/**
* Set the size of the icon. To improve readability at any size, the style of the icon
* is automatically defined based on the dimension.
*/
dimension?: 16 | "16" | 24 | "24" | 32 | "32" | 40 | "40" | 48 | "48" | 56 | "56" | 12 | "12" | 18 | "18" | undefined;
/**
* Set the weight of the icon.
* The default weight is `outline` if `dimension` is greather than `12` or `undefined`.
* If `dimension` is set to `12`, the weight is ignored and the icon forced to use
* the `solid` style to improve the readability.
*/
weight?: "solid" | "outline" | "duotone" | undefined;
} & import("react").RefAttributes<SVGSVGElement>>;
//# sourceMappingURL=symbol.d.ts.map