ion-button
Buttons provide a clickable element, which can be used in forms, or anywhere that needs simple, standard button functionality. They may display text, icons, or both. Buttons can be styled with several attributes to look a specific way.
Expand
This attribute lets you specify how wide the button should be. By default, buttons are inline blocks, but setting this attribute will change the button to a full-width block element.
| Value | Details |
|---|---|
block |
Full-width button with rounded corners. |
full |
Full-width button with square corners and no border on the left or right. |
Fill
This attributes determines the background and border color of the button. By default, buttons have a solid background unless the button is inside of a toolbar, in which case it has a transparent background.
| Value | Details |
|---|---|
clear |
Button with a transparent background that resembles a flat button. |
outline |
Button with a transparent background and a visible border. |
solid |
Button with a filled background. Useful for buttons in a toolbar. |
Size
This attribute specifies the size of the button. Setting this attribute will change the height and padding of a button.
| Value | Details |
|---|---|
small |
Button with less height and padding. Default for buttons in an item. |
default |
Button with the default height and padding. Useful for buttons in an item. |
large |
Button with more height and padding. |
<!-- Colors -->
<ion-button>Default</ion-button>
<ion-button color="secondary">Secondary</ion-button>
<ion-button color="warning">Warning</ion-button>
<ion-button color="danger">Danger</ion-button>
<ion-button color="light">Light</ion-button>
<ion-button color="dark">Dark</ion-button>
<!-- Expand -->
<ion-button expand="full">Full Button</ion-button>
<ion-button expand="block">Block Button</ion-button>
<ion-button round>Round Button</ion-button>
<!-- Fill -->
<ion-button expand="full" fill="outline">Outline + Full</ion-button>
<ion-button expand="block" fill="outline">Outline + Block</ion-button>
<ion-button round fill="outline">Outline + Round</ion-button>
<!-- Icons -->
<ion-button>
<ion-icon slot="start" name="star"></ion-icon>
Left Icon
</ion-button>
<ion-button>
Right Icon
<ion-icon slot="end" name="star"></ion-icon>
</ion-button>
<ion-button>
<ion-icon slot="icon-only" name="star"></ion-icon>
</ion-button>
<!-- Sizes -->
<ion-button size="large">Large</ion-button>
<ion-button>Default</ion-button>
<ion-button size="small">Small</ion-button>
Properties
buttonType
string
The type of button.
Possible values are: "button", "bar-button".
color
string
The color to use from your Sass $colors map.
Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark".
For more information, see Theming your App.
disabled
boolean
If true, the user cannot interact with the button. Defaults to false.
expand
Set to "block" for a full-width button or to "full" for a full-width button
without left and right borders.
fill
Set to "clear" for a transparent button, to "outline" for a transparent
button with a border, or to "solid". The default style is "solid" except inside of
a toolbar, where the default is "clear".
goBack
boolean
href
string
Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
mode
The mode determines which platform styles to use.
Possible values are: "ios" or "md".
For more information, see Platform Styles.
round
boolean
If true, activates a button with rounded corners.
size
The button size.
Possible values are: "small", "default", "large".
strong
boolean
If true, activates a button with a heavier font weight.
type
string
The type of the button.
Possible values are: "submit", "reset" and "button".
Default value is: "button"
Attributes
button-type
string
The type of button.
Possible values are: "button", "bar-button".
color
string
The color to use from your Sass $colors map.
Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark".
For more information, see Theming your App.
disabled
boolean
If true, the user cannot interact with the button. Defaults to false.
expand
Set to "block" for a full-width button or to "full" for a full-width button
without left and right borders.
fill
Set to "clear" for a transparent button, to "outline" for a transparent
button with a border, or to "solid". The default style is "solid" except inside of
a toolbar, where the default is "clear".
go-back
boolean
href
string
Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
mode
The mode determines which platform styles to use.
Possible values are: "ios" or "md".
For more information, see Platform Styles.
round
boolean
If true, activates a button with rounded corners.
size
The button size.
Possible values are: "small", "default", "large".
strong
boolean
If true, activates a button with a heavier font weight.
type
string
The type of the button.
Possible values are: "submit", "reset" and "button".
Default value is: "button"
Events
ionBlur
Emitted when the button loses focus.
ionFocus
Emitted when the button has focus.
Built with StencilJS