tharikida-ui
Version:
A modern, lightweight React UI component library with built-in theming, accessibility, and full TypeScript support. Create beautiful, responsive, and customizable web apps faster with ready-to-use components for any project.
165 lines (164 loc) • 6.9 kB
TypeScript
/**
* `LoadingButton` is a customizable button component that shows loading and done states, with theming and custom styles.
*
* @param {object} props - The properties to customize the `LoadingButton` component.
* @param {React.ReactNode} [props.icon] - Optional icon to display at the start of the button.
* @param {"primary" | "secondary"} [props.type='primary'] - The button style variant.
* - `primary`: Uses the theme's primary color.
* - `secondary`: Uses the theme's secondary color.
* @param {string} [props.initialText='Submit'] - The text to display when idle.
* @param {string} [props.loadingText='Loading...'] - The text to display while loading.
* @param {string} [props.doneText='Done!'] - The text to display when done.
* @param {number} [props.loadingDuration=1500] - How long to show the loading state (ms).
* @param {React.CSSProperties} [props.styles] - Custom styles for the button.
* @param {() => void} [props.onClick] - Click handler for the button.
* @param {string} [props.className] - Custom class name for the button.
* @param {React.ReactNode} [props.children] - Additional content inside the button.
* @param {number} [props.cornerRadius] - Custom border radius for the button. Overrides theme.cornerRadius if provided.
* @param {string} [props.backgroundColor] - Custom background color. Overrides theme.backgroundColor if provided.
* @param {string} [props.textColor] - Custom text color. Overrides theme.textColor if provided.
* @param {string} [props.borderColor] - Custom border color. Overrides theme.borderColor if provided.
* @param {string} [props.shadowColor] - Custom shadow color. Overrides theme.shadowColor if provided.
* @param {string} [props.borderWidth] - Custom border width. Overrides theme.borderWidth if provided.
* @param {string} [props.borderStyle] - Custom border style. Overrides theme.borderStyle if provided.
* @param {string} [props.fontWeight] - Custom font weight. Overrides theme.fontWeight if provided.
* @param {string} [props.lineHeight] - Custom line height. Overrides theme.lineHeight if provided.
* @param {string} [props.letterSpacing] - Custom letter spacing. Overrides theme.letterSpacing if provided.
* @param {string} [props.transitionDuration] - Custom transition duration. Overrides theme.transitionDuration if provided.
* @param {string} [props.padding] - Custom padding. Overrides theme.padding if provided.
* @param {string} [props.margin] - Custom margin. Overrides theme.margin if provided.
* @param {string} [props.shadowOffsetX] - Custom shadow offset X. Overrides theme.shadowOffsetX if provided.
* @param {string} [props.shadowOffsetY] - Custom shadow offset Y. Overrides theme.shadowOffsetY if provided.
* @param {string} [props.shadowBlur] - Custom shadow blur. Overrides theme.shadowBlur if provided.
* @param {string} [props.shadowSpread] - Custom shadow spread. Overrides theme.shadowSpread if provided.
* @param {boolean} [props.shadowInset] - Custom shadow inset. Overrides theme.shadowInset if provided.
* @param {string} [props.hoverColor] - Custom hover color. Overrides theme.hoverColor if provided.
*
* @returns {JSX.Element} A styled button element with loading and done states.
*/
import React from "react";
export interface LoadingButtonProps {
/**
* Optional icon to display at the start of the button.
*/
icon?: React.ReactNode;
/**
* The button style variant.
* @default 'primary'
*/
type?: "primary" | "secondary";
/**
* The text to display when idle.
* @default 'Submit'
*/
initialText?: string;
/**
* The text to display while loading.
* @default 'Loading...'
*/
loadingText?: string;
/**
* The text to display when done.
* @default 'Done!'
*/
doneText?: string;
/**
* How long to show the loading state (ms).
* @default 1500
*/
loadingDuration?: number;
/**
* Custom styles for the button.
*/
styles?: React.CSSProperties;
/**
* Click handler for the button.
*/
onClick?: () => void;
/**
* Custom class name for the button.
*/
className?: string;
/**
* Additional content inside the button.
*/
children?: React.ReactNode;
/**
* Custom border radius for the button. Overrides theme.cornerRadius if provided.
*/
cornerRadius?: number;
/**
* Custom background color. Overrides theme.backgroundColor if provided.
*/
backgroundColor?: string;
/**
* Custom text color. Overrides theme.textColor if provided.
*/
textColor?: string;
/**
* Custom border color. Overrides theme.borderColor if provided.
*/
borderColor?: string;
/**
* Custom shadow color. Overrides theme.shadowColor if provided.
*/
shadowColor?: string;
/**
* Custom border width. Overrides theme.borderWidth if provided.
*/
borderWidth?: string;
/**
* Custom border style. Overrides theme.borderStyle if provided.
*/
borderStyle?: string;
/**
* Custom font weight. Overrides theme.fontWeight if provided.
*/
fontWeight?: string;
/**
* Custom line height. Overrides theme.lineHeight if provided.
*/
lineHeight?: string;
/**
* Custom letter spacing. Overrides theme.letterSpacing if provided.
*/
letterSpacing?: string;
/**
* Custom transition duration. Overrides theme.transitionDuration if provided.
*/
transitionDuration?: string;
/**
* Custom padding. Overrides theme.padding if provided.
*/
padding?: string;
/**
* Custom margin. Overrides theme.margin if provided.
*/
margin?: string;
/**
* Custom shadow offset X. Overrides theme.shadowOffsetX if provided.
*/
shadowOffsetX?: string;
/**
* Custom shadow offset Y. Overrides theme.shadowOffsetY if provided.
*/
shadowOffsetY?: string;
/**
* Custom shadow blur. Overrides theme.shadowBlur if provided.
*/
shadowBlur?: string;
/**
* Custom shadow spread. Overrides theme.shadowSpread if provided.
*/
shadowSpread?: string;
/**
* Custom shadow inset. Overrides theme.shadowInset if provided.
*/
shadowInset?: boolean;
/**
* Custom hover color. Overrides theme.hoverColor if provided.
*/
hoverColor?: string;
}
declare const LoadingButton: ({ icon, type, initialText, loadingText, doneText, loadingDuration, styles, onClick, className, children, cornerRadius, backgroundColor, textColor, borderColor, shadowColor, borderWidth, borderStyle, fontWeight, lineHeight, letterSpacing, transitionDuration, padding, margin, shadowOffsetX, shadowOffsetY, shadowBlur, shadowSpread, shadowInset, hoverColor, }: LoadingButtonProps) => import("react/jsx-runtime").JSX.Element;
export default LoadingButton;