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. |
Usage
<!-- Default -->
<ion-button>Default</ion-button>
<!-- Anchor -->
<ion-button href="#">Anchor</ion-button>
<!-- Colors -->
<ion-button color="primary">Primary</ion-button>
<ion-button color="secondary">Secondary</ion-button>
<ion-button color="tertiary">Tertiary</ion-button>
<ion-button color="success">Success</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="medium">Medium</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>
<!-- Round -->
<ion-button shape="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 shape="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>
<!-- Default -->
<ion-button>Default</ion-button>
<!-- Anchor -->
<ion-button href="#">Anchor</ion-button>
<!-- Colors -->
<ion-button color="primary">Primary</ion-button>
<ion-button color="secondary">Secondary</ion-button>
<ion-button color="tertiary">Tertiary</ion-button>
<ion-button color="success">Success</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="medium">Medium</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>
<!-- Round -->
<ion-button shape="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 shape="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 | |
---|---|
Description | The type of button. |
Attribute | button-type |
Type | string |
color | |
Description | The color to use from your application's color palette.
Default options are: |
Attribute | color |
Type | string | undefined |
disabled | |
Description | If |
Attribute | disabled |
Type | boolean |
expand | |
Description | Set to |
Attribute | expand |
Type | "block" | "full" | undefined |
fill | |
Description | Set to |
Attribute | fill |
Type | "clear" | "default" | "outline" | "solid" | undefined |
href | |
Description | Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. |
Attribute | href |
Type | string | undefined |
mode | |
Description | The mode determines which platform styles to use. |
Attribute | mode |
Type | "ios" | "md" |
routerDirection | |
Description | When using a router, it specifies the transition direction when navigating to
another page using |
Attribute | router-direction |
Type | "back" | "forward" | "root" |
shape | |
Description | The button shape. |
Attribute | shape |
Type | "round" | undefined |
size | |
Description | The button size. |
Attribute | size |
Type | "default" | "large" | "small" | undefined |
strong | |
Description | If |
Attribute | strong |
Type | boolean |
type | |
Description | The type of the button. |
Attribute | type |
Type | "button" | "reset" | "submit" |
Events
Name | Description |
---|---|
ionBlur | Emitted when the button loses focus. |
ionFocus | Emitted when the button has focus. |
CSS Custom Properties
Name | Description |
---|---|
--background | Background of the button |
--background-activated | Background of the button when activated |
--background-focused | Background of the button when focused |
--border-color | Border color of the button |
--border-radius | Border radius of the button |
--border-style | Border style of the button |
--border-width | Border width of the button |
--box-shadow | Box shadow of the button |
--color | Text color of the button |
--color-activated | Text color of the button when activated |
--color-focused | Text color of the button when focused |
--opacity | Opacity of the button |
--padding-bottom | Padding bottom of the button |
--padding-end | Padding end of the button |
--padding-start | Padding start of the button |
--padding-top | Padding top of the button |
--ripple-color | Color of the button ripple effect |
--transition | Transition of the button |
Slots
Name | Description |
---|---|
Content is placed between the named slots if provided without a slot. | |
"end" | Content is placed to the right of the button text in LTR, and to the left in RTL. |
"icon-only" | Should be used on an icon in a button that has no text. |
"start" | Content is placed to the left of the button text in LTR, and to the right in RTL. |