All docs
V19.2
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
A newer version of this page is available. Switch to the current version.

jQuery SpeedDialAction Options

This section describes options that configure the SpeedDialAction widget's contents, behavior, and appearance.

See Also

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: false

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#speedDialActionContainer").dxSpeedDialAction({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-speed-dial-action ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-speed-dial-action>
import { DxSpeedDialActionModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSpeedDialActionModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxSpeedDialAction ...
        :element-attr="speedDialActionAttributes">
    </DxSpeedDialAction>
</template>

<script>
import DxSpeedDialAction from 'devextreme-vue/speed-dial-action';

export default {
    components: {
        DxSpeedDialAction
    },
    data() {
        return {
            speedDialActionAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import SpeedDialAction from 'devextreme-react/speed-dial-action';

class App extends React.Component {
    speedDialActionAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <SpeedDialAction ...
                elementAttr={this.speedDialActionAttributes}>
            </SpeedDialAction>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

icon

Specifies the icon the FAB or speed dial action button displays.

Type:

String

Default Value: ''

index

Allows you to reorder action buttons in the speed dial menu.

Type:

Number

Default Value: 0

The smaller the index, the closer the action button is to the FAB when the speed dial menu is open.

label

Specifies the text label displayed inside the FAB or near the speed dial action button.

Type:

String

Default Value: ''

onClick

A function that is executed when the FAB or speed dial action button is clicked or tapped.

Type:

Function

Function parameters:
e:

Object

Information about the event that caused the function execution.

Object structure:
Name Type Description
actionElement

HTMLElement | jQuery

A DOM element that contains the rendered FAB or speed dial action. It is an HTML Element or a jQuery Element when you use jQuery.

component

SpeedDialAction

The widget's instance.

element

HTMLElement | jQuery

A DOM element in which the widget is initialized. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event that caused the function execution.

Object structure:
Name Type Description
element

HTMLElement | jQuery

A DOM element in which the widget is initialized. It is an HTML Element or a jQuery Element when you use jQuery.

component

SpeedDialAction

The widget's instance.

actionElement

HTMLElement | jQuery

A DOM element that contains the rendered FAB or speed dial action. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

SpeedDialAction

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the widget instance.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

SpeedDialAction

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

See Also

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model

Object

Model data. Available only if you use Knockout.

fullName

String

The path to the modified option that includes all parent options.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

SpeedDialAction

The widget's instance.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified option's new value.

Default Value: null

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

visible

Allows you to hide the FAB from the view or the action from the speed dial menu.

Type:

Boolean

Default Value: true