@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
49 lines (48 loc) • 2.12 kB
TypeScript
/**
*
* 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 CommonProps, type TooltipObjectProps } from '../_common/types';
type SelectIconButtonProps = {
/** Content displayed in the button */
children?: React.ReactNode;
/** Size of button */
size?: 'small' | 'medium' | 'large';
/** If the button is doing something Async, it will display a loading spinner */
isLoading?: boolean;
/** Whether the button is in disabled state */
isDisabled?: boolean;
/** If the button is opened */
isOpen: boolean;
/** Callback function to be called when the button is clicked */
onClick?: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
/**
* 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;
/**
* Props for the tooltip component.
*/
tooltipProps?: TooltipObjectProps;
};
export declare const SelectIconButton: ({ children, size, isDisabled, isLoading, isOpen, className, description, tooltipProps, onClick, style, htmlAttributes, ref, ...restProps }: CommonProps<"button", SelectIconButtonProps>) => import("react/jsx-runtime").JSX.Element;
export {};
//# sourceMappingURL=SelectIconButton.d.ts.map