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

39 lines
1.4 KiB
Markdown
Raw Normal View History

2016-04-20 18:51:31 +08:00
---
category: Components
type: General
title: Button
2016-04-20 18:51:31 +08:00
---
To trigger an operation.
2016-05-25 09:43:26 +08:00
## When To Use
2016-11-29 17:13:24 +08:00
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
-----|-----|-----|------
type | can be set to `primary` `dashed` `danger`(added in 2.7) or omitted | string | 'default'
htmlType | to set the original `type` of `button`, see: [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type) | string | `button`
icon | set the icon of button, see: Icon component | string | -
shape | can be set to `circle` or omitted | string | -
2016-04-25 12:10:31 +08:00
size | can be set to `small` `large` or omitted | string | `default`
2017-01-21 22:35:42 +08:00
loading | to set the loading status of button | boolean | `false`
onClick | set the handler to handle `click` event | function | -
ghost | make background transparent and invert text and border color, added in 2.7 | boolean | false
2016-04-25 11:04:56 +08:00
`<Button>Hello world!</Button>` will be rendered into `<button>Hello world!</button>`, and all the properties which are not listed above will be transferred to the `<button>` tag.
<style>
[id^=components-button-demo-] .ant-btn {
margin-right: 8px;
margin-bottom: 12px;
}
[id^=components-button-demo-] .ant-btn-group > .ant-btn {
margin-right: 0;
}
</style>