ant-design/components/button/index.en-US.md

2.2 KiB

category type title
Components General Button

To trigger an operation.

When To Use

A button means an operation (or a series of operations). Clicking a button will trigger corresponding business logic.

API

To get a customized button, just set type/shape/size/loading/disabled.

Property Description Type Default
disabled disabled state of button boolean false
ghost make background transparent and invert text and border colors, added in 2.7 boolean false
href redirect url of link button string -
htmlType set the original html type of button, see: MDN string button
icon set the icon of button, see: Icon component string -
loading set the loading status of button boolean | { delay: number } false
shape can be set to circle, round or omitted string -
size can be set to small large or omitted string default
target same as target attribute of a, works when href is specified string -
type can be set to primary ghost dashed danger(added in 2.7) or omitted (meaning default) string default
onClick set the handler to handle click event (event) => void -
block option to fit button width to its parent width boolean false

It accepts all props which native button support.

<Button>Hello world!</Button> will be rendered into <button><span>Hello world!</span></button>, and all the properties which are not listed above will be transferred to the <button> tag.

<Button href="http://example.com">Hello world!</Button> will be rendered into <a href="http://example.com"><span>Hello world!</span></a>.

FAQ

How to remove space between 2 chinese characters

Use ConfigProvider to set autoInsertSpaceInButton as false.