/** * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). * * WSO2 LLC. licenses this file to you under the Apache License, * Version 2.0 (the "License"); you may not use this file except * in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import type { IconButtonTypeMap, IconButtonProps as MuiIconButtonProps } from '@mui/material/IconButton'; import type { OverridableComponent } from '@mui/material/OverridableComponent'; import type { ElementType } from 'react'; /** * @deprecated Use the string literal i.e. "contained" or "text" instead. * This will be removed in the next major release (v2.0.0). */ export declare enum IconButtonVariants { CONTAINED = "contained", TEXT = "text" } export type IconButtonProps = { /** * The component used for the root node. Either a string to use a HTML element or a component. */ component?: C; /** * The variant of the icon button. */ variant?: IconButtonVariants | 'contained' | 'text'; } & Omit, 'component'>; /** * The Icon Button component is used to render a button with an icon. * * Demos: * * - [Button (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-button) * - [Button (MUI)](https://mui.com/material-ui/react-button/) * * API: * * - [IconButton API](https://mui.com/material-ui/api/icon-button/) * - inherits [ButtonBase API](https://mui.com/material-ui/api/button-base/) * * @remarks * - ✔️ Props of the native component are also available. * - ✅ `component` prop is supported. * - ✅ The `ref` is forwarded to the root element. * * @template C - The type of the component. * @param props - The props for the IconButton component. * @param ref - The ref to be forwarded to the MuiIconButton component. * @returns The rendered IconButton component. */ declare const IconButton: OverridableComponent>; export default IconButton;