@geneui/components/lib/atoms/Image/Image.d.ts

The Gene UI components library designed for BI tools

import { FC, HTMLAttributes, ReactNode } from 'react';
import './Image.scss';
export interface IImageProps extends HTMLAttributes<HTMLDivElement> {
    /**
     * Image path to display
     */
    src: string;
    /**
     * Will add a border when set to "true"
     */
    withBorder: boolean;
    /**
     * The property will add a checkbox and an overlay over the image.
     */
    selectMode: boolean;
    /**
     * Customize checkbox(will be rendered only when "selectMode" is set to "true").
     */
    checkboxProps?: {};
    /**
     * Customize image tag with this property.
     */
    imageProps?: HTMLAttributes<HTMLImageElement>;
    /**
     * The property will render "actions" when "selectMode" is not setted to "true". Any valid React node
     */
    actions?: ReactNode;
    /**
     * Will add a title to the top of Image atom. Any valid React node
     */
    title?: string;
    /**
     * Title for 'Tooltip'. <br>
     * Possible values: `string | ReactNode`
     */
    tooltipTitle?: string | ReactNode;
    /**
     * Additional className
     */
    className?: string;
    /**
     * Image atom also can be included in "Form" organism. It can be validated as other "Form" elements
     */
    isValid: boolean;
    /**
     * Empty state text for component
     */
    emptyText?: string;
}
declare const Image: FC<IImageProps>;
export default Image;