Skip to content
@spuxx/jslibs

Button

Interfaces

ButtonProps

Defined in: button.types.ts:8

The Button component properties.

Extends

  • unknown<JSX.ButtonHTMLAttributes<HTMLInputElement>>.unknown

Properties

color?

optional color: any

Defined in: button.types.ts:25

The color of the button.

Default
'primary';
disabled?

optional disabled: boolean

Defined in: button.types.ts:44

Whether the button is disabled.

Default
false;
icon?

optional icon: any

Defined in: button.types.ts:30

The icon that should be rendered to the left of the button’s content. Supports both an icon name and JSX.Element.

loader?

optional loader: Element

Defined in: button.types.ts:54

An alternative loader to be displayed instead of the default loading indicator.

Default
undefined;
loading?

optional loading: boolean

Defined in: button.types.ts:49

Whether the button is loading. This will display a loading indicator and disable the button.

Default
false;
onClick()?

optional onClick: (event) => void

Defined in: button.types.ts:59

A callback that will be called when the button is clicked.

Parameters
event

MouseEvent

The click event.

Returns

void

rounded?

optional rounded: boolean

Defined in: button.types.ts:39

If enabled, the icon will be rounded and no content besides the icon will be displayed.

Default
false;
size?

optional size: ControlSize

Defined in: button.types.ts:15

The size of the button.

Default
undefined;
title?

optional title: string

Defined in: button.types.ts:34

The title of the button.

variant?

optional variant: "contained" | "outlined" | "colored"

Defined in: button.types.ts:20

The variant of the button.

Default
'contained';

Variables

Button

const Button: Component<ButtonProps>

Defined in: button.component.tsx:11

A flexible button component.

Param

ButtonProps

Returns

The button component.