@yamada-ui/close-button
Version:
Yamada UI close button component
50 lines (47 loc) • 1.25 kB
TypeScript
import * as _yamada_ui_core from '@yamada-ui/core';
import { HTMLUIProps, ThemeProps } from '@yamada-ui/core';
interface CloseButtonOptions {
/**
* If `true`, the button is disabled.
*
* @default false
*/
disabled?: boolean;
/**
* If `true`, disable ripple effects when pressing a element.
*
* @default false
*/
disableRipple?: boolean;
/**
* If true, the button is full rounded.
*
* @default false
*/
fullRounded?: boolean;
/**
* If `true`, the button is disabled.
*
* @default false
*
* @deprecated Use `disabled` instead.
*/
isDisabled?: boolean;
/**
* If true, the button is full rounded.
*
* @default false
*
* @deprecated Use `fullRounded` instead.
*/
isRounded?: boolean;
}
interface CloseButtonProps extends HTMLUIProps<"button">, ThemeProps<"CloseButton">, CloseButtonOptions {
}
/**
* `CloseButton` is a component used primarily to trigger the close functionality of a component.
*
* @see Docs https://yamada-ui.com/components/other/close-button
*/
declare const CloseButton: _yamada_ui_core.Component<"button", CloseButtonProps>;
export { CloseButton, type CloseButtonProps };