@activecollab/components
Version:
ActiveCollab Components
33 lines • 1.32 kB
TypeScript
import React, { ComponentPropsWithoutRef } from "react";
export interface ButtonProps extends ComponentPropsWithoutRef<"button"> {
/** Types of a button. */
variant?: "primary" | "secondary" | "tertiary" | "option" | "contained" | "outlined" | "text colored" | "text gray" | "dark transparent" | "circle raised";
/** Button size dictates the height. */
size?: "big" | "small" | "medium";
/** Active or pressed state. */
active?: boolean;
}
/**
* @component Button
* @description
* Button component is used to trigger an action or event, such as submitting a form,
* opening a Dialog, canceling an action, or performing a delete operation.
*
* @prop {variant} - adds unique look and feel to button.
* @prop {size} - controls the size of a button.
* @prop {active} - adds active/pressed state to a button.
*
* @example
* return (
* <Button className="mr-2" variant="primary" size="big">
* Save
* </Button>
* )
* @see
* https://system.activecollab.com/?path=/story/components-button-indicators-button--button
* https://design.activecollab.com/docs/components/button
*/
export declare const Button: React.ForwardRefExoticComponent<ButtonProps & {
children?: React.ReactNode | undefined;
} & React.RefAttributes<HTMLButtonElement>>;
//# sourceMappingURL=Button.d.ts.map