@nex-ui/react/dist/types/components/icon/types.d.ts

🎉 A beautiful, modern, and reliable React component library.

import { ElementType, ComponentType } from 'react';
import { ClassValue } from 'clsx';
import { CSSObject } from '@nex-ui/system';
import { IconVariants } from '../../theme/recipes/icon.js';
import { OverrideProps, SxProp } from '../../types/utils.js';

interface IconPropsOverrides {
}
type IconOwnProsp<RootComponent extends ElementType> = {
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: SxProp<IconOwnerState<RootComponent>>;
    /**
     * Additional class names to apply to the root element.
     */
    className?: ClassValue;
    /**
     * The width of the icon.
     * @default '1em'
     */
    width?: CSSObject['width'];
    /**
     * The height of the icon.
     * @default '1em'
     */
    height?: CSSObject['height'];
    /**
     * The color of the icon.
     */
    color?: CSSObject['color'];
    /**
     * The component used for the root node.
     */
    as?: ComponentType<any>;
    /**
     * Rotate icon with animation.
     * @default false
     */
    spin?: boolean;
    /**
     * The size of the icon.
     * @default 'md'
     */
    size?: IconVariants['size'];
};
type IconProps<RootComponent extends ElementType = 'svg'> = OverrideProps<RootComponent, IconOwnProsp<RootComponent>, IconPropsOverrides>;
type IconOwnerState<RootComponent extends ElementType = 'svg'> = IconProps<RootComponent> & {
    spin: boolean;
    size: IconVariants['size'];
    width: CSSObject['width'];
    height: CSSObject['height'];
};

export type { IconOwnProsp, IconOwnerState, IconProps, IconPropsOverrides };