New to Kendo UI for Vue? Start a free 30-day trial

Represents the Kendo UI for Vue FloatingActionButton component. Accepts properties of type FloatingActionButtonProps. Use the FloatingActionButton to show the main action of a page in a button that floats above the content.

Definition

Package:@progress/kendo-vue-buttons

Properties Interface:FloatingActionButtonProps

Syntax:

vue
<FloatingActionButton :svg-icon="plusIcon" :text="'Add'" :theme-color="'primary'" />

Properties

Sets the accesskey of the main button.

Sets the horizontal and vertical alignment of the Floating Action Button in relation to the container see example.

Centering the Floating Action Button in both dimensions is not a typical use case. Still, you can get such a layout with the right offsets. The Floating Action Button does not support horizontal: "center" and vertical: "middle" at the same time.

The possible keys are:

  • horizontal— Sets the horizontal alignment of the Floating Action Button.
    • start—Uses the start point of the container.
    • center—Uses the center point of the container.
    • end(Default)—Uses the end point of the container.
  • vertical— Sets the vertical alignment of the Floating Action Button.
    • top—Uses the top point of the container.
    • middle—Uses the middle point of the container.
    • bottom(Default)—Uses the bottom point of the container.
Default:

{ vertical: 'bottom', horizontal: 'end' }

Sets the horizontal and vertical offset of the Floating Action Button see example.

By default, the Floating Action Button sits next to the boundaries of its container with an offset of 16px.

Positive offsets move a button in a corner further from that corner. Positive offsets move a button that is not in a corner along the boundary of the container or towards its center.

Use a negative offset to make the button overflow the boundaries of its container.

The possible keys are:

  • x—Sets the horizontal offset of the Floating Action Button.
  • y—Sets the vertical offset of the Floating Action Button.

Sets a list of CSS classes that the Floating Action Button adds to its element.

dir?

string

Sets the dir HTML attribute. Use it to switch from LTR to RTL see example.

disabled?

boolean

Sets whether the Floating Action Button is disabled see example. Defaults to false.

Default:

false

fillMode?

"solid" | "outline" | "flat" | "link"

Sets the fill style of the Floating Action Button.

The available options are:

  • solid
  • outline
  • flat
  • link
Default:

undefined

icon?

string

Sets the icon of the Floating Action Button see example.

Sets a CSS class or multiple classes separated by spaces that the Floating Action Button applies to a span element inside it. Use it to show custom icons.

id?

string

Sets the id property of the main button. The popup list of items uses it as its label.

Overrides the default component that renders a single item see example.

The default component is: FloatingActionButtonItem.

Sets the collection of items that the Floating Action Button renders see example.

Fires when the Floating Action Button loses the focus see example. The event name is blur.

Fires when the user clicks the Floating Action Button. The event name is click.

Fires when the popup with the items closes see example. The event name is close.

Fires when the Floating Action Button gets the focus see example. The event name is focus.

Fires when the user clicks a Floating Action Button item see example. The event name is itemclick.

Fires when the user presses a key while the Floating Action Button has the focus see example. The event name is keydown.

Fires when the user presses a mouse button over the Floating Action Button see example. The event name is mousedown.

Fires when the user releases a mouse button over the Floating Action Button see example. The event name is mouseup.

Fires when the popup with the items opens see example. The event name is open.

opened?

boolean

Sets whether the Floating Action Button is opened. When you set it, you control the open state.

Sets additional props that the Floating Action Button passes to its inner Popup see example.

Default:

{}

Sets the position mode of the Floating Action Button see example. It is based on the CSS position rule.

  • The possible values are:
  • 'fixed' (Default)
  • 'absolute'

rounded?

"small" | "medium" | "large" | "none" | "full"

Sets the border radius of the Floating Action Button.

The available options are:

  • none
  • small
  • medium
  • large
  • circle
  • full
Default:

undefined

Sets the size of the Floating Action Button see example.

The possible values are:

  • small—Applies half of the default padding, for example 8px.
  • medium (Default)—Applies the default padding, for example 16px.
  • large—Applies one and one half of the default padding, for example 24px.

svgIcon?

SVGIcon

Sets the SVGIcon of the Floating Action Button.

tabIndex?

number

Sets the tabindex of the main button.

text?

string

Sets the text of the Floating Action Button see example.

Sets the theme color of the Floating Action Button see example.

The possible values are:

    • base (Default)—Applies base coloring.
    • primary—Applies coloring based on the primary theme color.
  • secondary—Applies coloring based on the secondary theme color.
  • tertiary— Applies coloring based on the tertiary theme color.

References

The FloatingActionButton ref.