ons-speed-dial

Element that displays a Material Design Speed Dialog component. It is useful when there are more than one primary action that can be performed in a page. The Speed dial looks like a <ons-fab> element but will expand a menu when tapped.

Tutorial

Speed dial

The Speed dial is a Material Design component similar to the Floating action button. It is used to display a <ons-fab> element that when clicked displays a menu.

The component is defined using the <ons-speed-dial> element and the items with <ons-speed-dial-item>.

<ons-speed-dial>
  <ons-fab>
    A
  </ons-fab>
  <ons-speed-dial-item>
    B
  </ons-speed-dial-item>
  <ons-speed-dial-item>
    C
  </ons-speed-dial-item>
  <ons-speed-dial-item>
    D
  </ons-speed-dial-item>
</ons-speed-dial>

Changing the position and direction

Just like with the <ons-fab> element the position can be changed using the position attribute. Normally the value is bottom right.

It is also possible to configure the direction in which the menu is displayed with the direction attribute. Possible values are up, down, left and right.

<ons-speed-dial
  position="bottom right"
  direction="up">
  ...
</ons-speed-dial>

See also

Attributes

Name Type Default Value Description
modifier String The appearance of the component. Optional.
ripple If this attribute is defined, the button will have a ripple effect when tapped. Optional.
position String

Specify the vertical and horizontal position of the component. I.e. to display it in the top right corner specify “right top”. Choose from “right”, “left”, “top” and “bottom”.

Optional.
direction String Specify the direction the items are displayed. Possible values are “up”, “down”, “left” and “right”. Optional.
disabled Specify if button should be disabled. Optional.
var String Variable name to refer the speed dial. Optional. Works only during initialization.
ons-open Expression Allows you to specify custom behavior when the “open” event is fired. Optional. Works only during initialization.
ons-close Expression Allows you to specify custom behavior when the “close” event is fired. Optional. Works only during initialization.

Properties

Name Description
disabled Whether the element is disabled or not.
inline Whether the element is inline or not.
visible Whether the element is visible or not.

Methods Summary

Signature Description
show() Show the speed dial.
hide() Hide the speed dial.
showItems() Show the speed dial items.
hideItems() Hide the speed dial items.
isOpen() Returns whether the menu is open or not.
toggle() Toggle visibility.
toggleItems() Toggle item visibility.
once(eventName, listener) Add an event listener that’s only triggered once.
off(eventName, [listener]) Remove an event listener. If the listener is not specified all listeners for the event type will be removed.
on(eventName, listener) Add an event listener.

Events Summary

Name Description
open Fired when the menu items are shown.
close Fired when the menu items are hidden.

Methods

show()

Show the speed dial.

hide()

Hide the speed dial.

showItems()

Show the speed dial items.

hideItems()

Hide the speed dial items.

isOpen()

Returns whether the menu is open or not.

toggle()

Toggle visibility.

toggleItems()

Toggle item visibility.

once(eventName, listener)

Add an event listener that’s only triggered once.

Parameters
Name Type Description
eventName String Name of the event.
listener Function Function to execute when the event is triggered.

off(eventName, [listener])

Remove an event listener. If the listener is not specified all listeners for the event type will be removed.

Parameters
Name Type Description
eventName String Name of the event.
listener Function Function to execute when the event is triggered.

on(eventName, listener)

Add an event listener.

Parameters
Name Type Description
eventName String Name of the event.
listener Function Function to execute when the event is triggered.

Events

open

Fired when the menu items are shown.

Parameters
Name Type Description

close

Fired when the menu items are hidden.

Parameters
Name Type Description

Discussion

Need Help?

If you have any questions, use our Community Forum or talk to us via Gitter chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.