Skip to main content
Version: v6

ion-button

shadow

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.

Basic Usage

Expand

This property lets you specify how wide the button should be. By default, buttons are inline blocks, but setting this property will change the button to a full-width block element.

Shape

This property lets you specify the shape of the button. By default, buttons are rectangular with a small border radius, but setting this to "round" will change the button to a rounded element.

Fill

This property 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.

Size

This property specifies the size of the button. Setting this property will change the height and padding of a button.

Icons

Theming

Colors

CSS Custom Properties

Properties

buttonType

DescriptionThe type of button.
Attributebutton-type
Typestring
Default'button'

color

DescriptionThe color to use from your application's color palette. Default options are: "primary", "secondary", "tertiary", "success", "warning", "danger", "light", "medium", and "dark". For more information on colors, see theming.
Attributecolor
Type"danger" ๏ฝœ "dark" ๏ฝœ "light" ๏ฝœ "medium" ๏ฝœ "primary" ๏ฝœ "secondary" ๏ฝœ "success" ๏ฝœ "tertiary" ๏ฝœ "warning" ๏ฝœ string & Record<never, never> ๏ฝœ undefined
Defaultundefined

disabled

DescriptionIf true, the user cannot interact with the button.
Attributedisabled
Typeboolean
Defaultfalse

download

DescriptionThis attribute instructs browsers to download a URL instead of navigating to it, so the user will be prompted to save it as a local file. If the attribute has a value, it is used as the pre-filled file name in the Save prompt (the user can still change the file name if they want).
Attributedownload
Typestring ๏ฝœ undefined
Defaultundefined

expand

DescriptionSet to "block" for a full-width button or to "full" for a full-width button with square corners and no left or right borders.
Attributeexpand
Type"block" ๏ฝœ "full" ๏ฝœ undefined
Defaultundefined

fill

DescriptionSet to "clear" for a transparent button that resembles a flat button, to "outline" for a transparent button with a border, or to "solid" for a button with a filled background. The default fill is "solid" except inside of a toolbar, where the default is "clear".
Attributefill
Type"clear" ๏ฝœ "default" ๏ฝœ "outline" ๏ฝœ "solid" ๏ฝœ undefined
Defaultundefined

href

DescriptionContains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
Attributehref
Typestring ๏ฝœ undefined
Defaultundefined

mode

DescriptionThe mode determines which platform styles to use.
Attributemode
Type"ios" ๏ฝœ "md"
Defaultundefined

rel

DescriptionSpecifies the relationship of the target object to the link object. The value is a space-separated list of link types.
Attributerel
Typestring ๏ฝœ undefined
Defaultundefined

routerAnimation

DescriptionWhen using a router, it specifies the transition animation when navigating to another page using href.
Attributeundefined
Type((baseEl: any, opts?: any) => Animation) ๏ฝœ undefined
Defaultundefined

routerDirection

DescriptionWhen using a router, it specifies the transition direction when navigating to another page using href.
Attributerouter-direction
Type"back" ๏ฝœ "forward" ๏ฝœ "root"
Default'forward'

shape

DescriptionSet to "round" for a button with more rounded corners.
Attributeshape
Type"round" ๏ฝœ undefined
Defaultundefined

size

DescriptionSet to "small" for a button with less height and padding, to "default" for a button with the default height and padding, or to "large" for a button with more height and padding. By default the size is unset, unless the button is inside of an item, where the size is "small" by default. Set the size to "default" inside of an item to make it a standard size button.
Attributesize
Type"default" ๏ฝœ "large" ๏ฝœ "small" ๏ฝœ undefined
Defaultundefined

strong

DescriptionIf true, activates a button with a heavier font weight.
Attributestrong
Typeboolean
Defaultfalse

target

DescriptionSpecifies where to display the linked URL. Only applies when an href is provided. Special keywords: "_blank", "_self", "_parent", "_top".
Attributetarget
Typestring ๏ฝœ undefined
Defaultundefined

type

DescriptionThe type of the button.
Attributetype
Type"button" ๏ฝœ "reset" ๏ฝœ "submit"
Default'button'

Events

NameDescription
ionBlurEmitted when the button loses focus.
ionFocusEmitted when the button has focus.

Methods

No public methods available for this component.

CSS Shadow Parts

NameDescription
nativeThe native HTML button or anchor element that wraps all child elements.

CSS Custom Properties

NameDescription
--backgroundBackground of the button
--background-activatedBackground of the button when pressed. Note: setting this will interfere with the Material Design ripple.
--background-activated-opacityOpacity of the button when pressed
--background-focusedBackground of the button when focused with the tab key
--background-focused-opacityOpacity of the button when focused with the tab key
--background-hoverBackground of the button on hover
--background-hover-opacityOpacity of the background on hover
--border-colorBorder color of the button
--border-radiusBorder radius of the button
--border-styleBorder style of the button
--border-widthBorder width of the button
--box-shadowBox shadow of the button
--colorText color of the button
--color-activatedText color of the button when pressed
--color-focusedText color of the button when focused with the tab key
--color-hoverText color of the button when hover
--opacityOpacity of the button
--padding-bottomBottom padding of the button
--padding-endRight padding if direction is left-to-right, and left padding if direction is right-to-left of the button
--padding-startLeft padding if direction is left-to-right, and right padding if direction is right-to-left of the button
--padding-topTop padding of the button
--ripple-colorColor of the button ripple effect
--transitionTransition of the button

Slots

NameDescription
``Content is placed between the named slots if provided without a slot.
endContent is placed to the right of the button text in LTR, and to the left in RTL.
icon-onlyShould be used on an icon in a button that has no text.
startContent is placed to the left of the button text in LTR, and to the right in RTL.