@geneui/components/lib/molecules/Copy/Copy.d.ts

The Gene UI components library designed for BI tools

import { RefObject, FC } from 'react';
import './Copy.scss';
interface ICopyProps {
    /**
     * Size of the icon: 'small', 'medium', 'big',
     */
    size?: 'small' | 'medium' | 'big';
    /**
     * Additional CSS class name(s) to apply to the icon for styling
     */
    className?: string;
    /**
     * Reference to the content you want to copy
     */
    contentRef?: RefObject<HTMLElement>;
    /**
     * Determines whether the copy icon is displayed only on hover.
     */
    showOnHover?: boolean;
    /**
     * Tooltip text to display when the copy action is available. It will be shown when the user hovers over the copy icon.
     */
    copyTooltipText?: string;
    /**
     * Tooltip text to display when the copy action has been performed. It will be shown when the user clicks on the copy icon.
     */
    copiedTooltipText?: string;
    /**
     * The value to copy. If specified, this will be copied instead of the content referenced by contentRef.
     */
    value?: string;
    /**
     * Determines the visibility state of the copy icon. If true, the icon is visible regardless of hover or controlled visibility.
     */
    isVisible?: boolean;
}
declare const Copy: FC<ICopyProps>;
export { ICopyProps, Copy as default };