Speed Dial

SpeedDial is a floating button with a popup menu.

Import #


import { SpeedDialModule } from 'primeng/speeddial';

Linear #

SpeedDial items are defined with the model property based on MenuModel API. Default orientation of the items is linear and direction property is used to define the position of the items related to the button.


<p-speedDial [model]="items" direction="up" />
<p-speedDial [model]="items" direction="down" />
<p-speedDial [model]="items" direction="left" />
<p-speedDial [model]="items" direction="right" />

Circle #

Items can be displayed around the button when type is set to circle. Additional radius property defines the radius of the circle.


<p-speedDial 
    [model]="items" 
    type="circle" 
    [radius]="80" 
    buttonClassName="p-button-warning" />

Semi Circle #

When type is defined as semi-circle, items are displayed in a half-circle around the button.


<p-speedDial 
    [model]="items" 
    direction="up" 
    [radius]="80" 
    type="semi-circle" />
<p-speedDial 
    [model]="items" 
    direction="down" 
    [radius]="80" 
    type="semi-circle" />
<p-speedDial 
    [model]="items" 
    direction="left" 
    [radius]="80" 
    type="semi-circle" />
<p-speedDial 
    [model]="items"
    direction="right" 
    [radius]="80" 
    type="semi-circle" />

Quarter Circle #

When type is defined as quarter-circle, items are displayed in a half-circle around the button.


<p-speedDial 
    [model]="items" 
    radius="120"
    direction="up-left" 
    type="quarter-circle" 
    buttonClassName="p-button-success" />
<p-speedDial 
    [model]="items" 
    radius="120" 
    direction="up-right"
    type="quarter-circle" 
    buttonClassName="p-button-success" />
<p-speedDial 
    [model]="items" 
    radius="120" 
    direction="down-left" 
    type="quarter-circle" 
    buttonClassName="p-button-success" />
<p-speedDial 
    [model]="items" 
    radius="120" 
    direction="down-right" 
    type="quarter-circle" 
    buttonClassName="p-button-success" />

Tooltip #

Items display a tooltip on hover when a standalone Tooltip is present with a target that matches the items.


<p-speedDial 
    [model]="leftTooltipItems" 
    className="speeddial-right" 
    direction="up" />
<p-speedDial 
    [model]="tooltipItems" 
    className="speeddial-left" 
    direction="up" />

Mask #

Adding mask property displays a modal layer behind the popup items.


<p-speedDial 
    [model]="items" 
    direction="up" 
    [mask]="true" />

Custom #

SpeedDial sample with an outlined button, custom icons and transitionDelay.


<p-speedDial 
    [model]="items" 
    direction="up" 
    transitionDelay="80" 
    showIcon="pi pi-bars" 
    hideIcon="pi pi-times" 
    buttonClassName="p-button-outlined" />

Style #

Following is the list of structural style classes, for theming classes visit theming page.

Name	Element
p-speeddial	Container element.
p-speed-dial-button	Button element of speeddial.
p-speed-dial-mask	Mask element of speeddial.
p-speed-dial-list	List of the actions.
p-speed-dial-item	Each action item of list.

Accessibility #

Screen Reader

SpeedDial component renders a native button element that implicitly includes any passed prop. Text to describe the button can be defined with the aria-labelledby or aria-label props. Addititonally the button includes includes aria-haspopup, aria-expanded for states along with aria-controls to define the relation between the popup and the button.

The popup overlay uses menu role on the list and each action item has a menuitem role with an aria-label as the menuitem label. The id of the menu refers to the aria-controls of the button.


<p-speedDial aria-label="Options" />

Menu Button Keyboard Support

Key	Function
enter	Toggles the visibility of the menu.
space	Toggles the visibility of the menu.
down arrow	Opens the menu and moves focus to the first item.
up arrow	Opens the menu and moves focus to the last item.

Menu Keyboard Support

Key	Function
enter	Activates the menuitem, closes the menu and sets focus on the menu button.
escape	Closes the menu and sets focus on the menu button.
arrow keys	Navigates between the menu items.
home	Moves focus to the first item.
end	Moves focus to the last item.

Speed Dial API

API defines helper props, events and others for the PrimeNG Speed Dial module.

SpeedDial #

When pressed, a floating action button can display multiple primary actions that can be performed on a page.

Properties #

Defines the input properties of the component.

name	type	default	description
id	string	null	List of items id.
model	MenuItem[]	null	MenuModel instance to define the action items.
visible	boolean	null	Specifies the visibility of the overlay.
style	Object	null	Inline style of the element.
className	string	null	Style class of the element.
transitionDelay	number	30	Transition delay step for each action item.
type	"linear" \| "circle" \| "semi-circle" \| "quarter-circle"	linear	Specifies the opening type of actions.
radius	number	0	Radius for *circle types.
mask	boolean	false	Whether to show a mask element behind the speeddial.
disabled	boolean	false	Whether the component is disabled.
hideOnClickOutside	boolean	true	Whether the actions close when clicked outside.
buttonStyle	Object	null	Inline style of the button element.
buttonClassName	string	null	Style class of the button element.
maskStyle	Object	null	Inline style of the mask element.
maskClassName	string	null	Style class of the mask element.
showIcon	string	null	Show icon of the button element.
hideIcon	string	null	Hide icon of the button element.
rotateAnimation	boolean	true	Defined to rotate showIcon when hideIcon is not present.
ariaLabel	string	null	Defines a string value that labels an interactive element.
ariaLabelledBy	string	null	Identifier of the underlying input element.

Emitters #

Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.

name	parameters	description
onVisibleChange	value : boolean	Fired when the visibility of element changed.
visibleChange	value : boolean	Fired when the visibility of element changed.
onClick	event : MouseEvent	Fired when the button element clicked.
onShow	event : Event	Fired when the actions are visible.
onHide	event : Event	Fired when the actions are hidden.

Templates #

Defines the templates used by the component.

name	parameters	description
item	context : { $implicit: MenuItem, // Data of the item. index: number, // Index of the item. }	Custom template of item.
button		Custom template of button.