@neo4j-ndl/react/lib/types/icon-button-base/IconButtonBase.d.ts

React implementation of Neo4j Design System

/**
 *
 *  Copyright (c) "Neo4j"
 *  Neo4j Sweden AB [http://neo4j.com]
 *
 *  This file is part of Neo4j.
 *
 *  Neo4j is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import type React from 'react';
import { type PolymorphicCommonProps, type TooltipObjectProps } from '../_common/types';
import { type ButtonSizes } from '../button';
/**
 *
 *
 * Types
 *
 *
 */
export type IconButtonBaseProps = {
    children?: React.ReactNode;
    /** If the icon button is in disabled state */
    isDisabled?: boolean;
    /** If the button is doing something Async, it will display a loading spinner   */
    isLoading?: boolean;
    /** Size of button */
    size?: ButtonSizes;
    /** If the button is in floating state */
    isFloating?: boolean;
    /** Active - used for open context menus for example */
    isActive?: boolean;
    /** A string that will be shown as a tooltip when hovering over the button  it also acts as an aria-label- {@link https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label} */
    description: string | null;
    /** Variant of the button */
    variant?: 'neutral' | 'danger';
    /** Variant of the button */
    iconButtonVariant?: 'default' | 'clean';
    /**
     * Props for the tooltip component.
     */
    tooltipProps?: TooltipObjectProps;
    /** Click handler */
    onClick?: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
};
export declare const IconButtonBase: <T extends React.ElementType = "button">({ children, as, iconButtonVariant, isLoading, isDisabled, size, isFloating, isActive, description, tooltipProps, className, style, variant, htmlAttributes, onClick, ref, ...restProps }: PolymorphicCommonProps<T, IconButtonBaseProps>) => import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=IconButtonBase.d.ts.map