Components / FloatingActionButton

New to Kendo UI for jQuery? Download free 30-day trial

Appearance

As of Kendo UI R1 2022, the FloatingActionButton component uses brand new rendering.

In this article, you will find information about the new rendering of the Kendo UI FloatingActionButton.

For additional information regarding the decision behind these changes, visit the Styling Overview article.

For a live example, visit the Appearance Demo of the FloatingActionButton.

Options

The Kendo UI FloatingActionButton supports the following styling options:

  • size—configures the overall size of the component.
  • fillMode—configures how the color is applied to the component.
  • themeColor—configures what color will be applied to the component.
  • rounded—configures the border radius of the component.

Size

The size option controls how big or small the rendered FloatingActionButton looks. The structure of the class is k-fab-{size}.

The following values are available for the size option:

  • sm—small size
  • md—medium size
  • lg—large size
  • none—unset

The following example demonstrates how to configure the size of the component through the component configuration:

<button id="fab"></button>
<script>
$("#fab").kendoFloatingActionButton({
    size: "large"
});
</script>

The default size value is medium and it is applied to the wrapping span element through the k-fab-md class.

<button class="k-fab k-fab-sm">
</button>

FillMode

The fillMode option controls the way the color is applied to the rendered FloatingActionButton. The structure of the class is k-fab-{fillMode}.

You can set the fillMode either to solid or to null.

The following example demonstrates how to configure the fillMode of the component through the component configuration:

<input id="fab" />
<script>
$("#fab").kendoFloatingActionButton({
    fillMode: null
});
</script>

The default fillMode value is solid and it is applied to the button element through the k-fab-solid class.

<button class="k-fab k-fab-solid" >
</button>

ThemeColor

The themeColor option controls the color that will be applied to the rendered FloatingActionButton. As applying themeColor is closely related to the fillMode, the structure of the class name for the themeColor is composite - k-fab-{fillMode}-{themeColor}.

The following values are available for the themeColor option:

  • primary
  • secondary
  • tertiary
  • info
  • success
  • warning
  • error
  • dark
  • light
  • inverse
  • none

The default themeColor value is primary. A FloatingActionButton with default fillMode and themeColor will have k-fab-solid-primary class applied.

<!-- FloatingActionButton with default fillMode and themeColor -->
<button class="k-fab k-fab-solid-primary k-fab-solid" >
</button>

<!-- FloatingActionButton with 'primary' themeColor and fillMode set to null -->
<button class="k-fab" >
</button>

<!-- FloatingActionButton with `solid` fillMode and `success` themeColor -->
<button class="k-fab k-fab-solid-success k-fab-solid" >
</button>

Rounded

The rounded option controls how much border radius is applied to the rendered FloatingActionButton. The structure of the class is k-rounded-{size}.

The following values are available for the rounded option:

  • sm—small border radius
  • md—medium border radius
  • lg—large border radius
  • full—largest border radius
  • none—unset

The example below demonstrates how to configure the rounded of the component through the component configuration:

<input id="fab" />
<script>
$("#fab").kendoFloatingActionButton({
    rounded: "large"
});
</script>

The default rounded value is full and it is applied to the button element through the k-rounded-full class.

<button class="k-fab k-rounded-full" >
</button>

Old vs New Rendering

  • Previously the themeColor of the FloatingActionButton was applied using the k-fab-{themeColor} class.
 <!-- OLD -->
<button id="fab" class="k-fab k-fab-primary k-fab-lg k-fab-pill">
    <span class="k-fab-icon k-icon k-i-home"></span>
    <span class="k-fab-text">Home</span>
</button>
  • Currently, the themeColor is applied using the k-fab-{fillMode}-{themeColor} class. Additionally, classes for fillMode and rounded are applied to the button element.
<!-- NEW -->
<button id="fab" class="k-fab k-fab-solid-primary k-fab-solid k-fab-md k-rounded-full">
    <span class="k-fab-icon k-icon k-i-home"></span>
    <span class="k-fab-text">Home</span>
</button>

Visual Backwards Compatibility

To achieve the same look and feel as the old rendering, you must update the element references.

When you use a LESS theme, the new styling and rendering supports only the default options.

The following example showcases how to customize the styles of the FloatingActionButton depending on the selected themeColor in both the new, and the old rendering:

    <!-- Open the example in Dojo and select version prior to 2022 R1 to see the difference in the appearance -->
    <button id="fab-primary"></button>
    <button id="fab-secondary"></button>
    <button id="fab-tertiary"></button>

    <script>
      $('#fab-primary').kendoFloatingActionButton({
        themeColor: 'primary',
        icon: 'home',
        align: 'top start'
      });
      $('#fab-secondary').kendoFloatingActionButton({
        themeColor: 'secondary',
        icon: 'home',
        align: 'top center'
      });
      $('#fab-tertiary').kendoFloatingActionButton({
        themeColor: 'tertiary',
        icon: 'home',
        align: 'top end'
      });
    </script>

    <style>
      /*  NEW RENDERING */
      /*  The style below will works with versions R1 2022 and later */      

      #fab-primary.k-fab-solid-primary{ /* applies border to primary FAB in the new rendering */
        border: 2px solid yellow !important;
      }

      #fab-secondary.k-fab-solid-secondary{ /* applies border to secondary FAB in the new rendering */
        border: 2px solid fuchsia !important;
      }

      #fab-tertiary.k-fab-solid-tertiary{ /* applies border to tertiary FAB in the new rendering */
        border: 2px solid lime !important;
      }


      /*  OLD RENDERING */
      /*  The style below will works with versions prior to R1 2022 */

      #fab-primary.k-fab-primary{ /* applies border to primary FAB in the old rendering */
        border: 2px solid red !important;
      }

      #fab-secondary.k-fab-secondary{ /* applies border to secondary FAB in the old rendering */
        border: 2px solid blue !important;
      }

      #fab-tertiary.k-fab-tertiary{ /* applies border to tertiary FAB in the old rendering */
        border: 2px solid green !important;
      }
    </style>

Best Practices

The Material Design guidelines dictate that:

  • When you configure the FloatingActionButton to display additional related actions (speed dial actions), you should configure only an icon for the button, without a label. Use labels to display additional information for the related actions.

  • If the application requires an icon and a label for the Kendo UI FloatingActionButton, consider omitting the additional actions.

    <div id="fab"></div>

    <script>
        $(document).ready(function () {
            $("#fab").kendoFloatingActionButton({
                icon:"plus",
                text: "Add To Cart"
            });
        });
    </script>

Icons

The icon configuration option specifies the name of an icon. The selected icon must be available in the Kendo UI theme that is rendered by the FloatingActionButton. For more details on the available Web Font icons see the Web Font Icons article.

    <div id="fab"></div>

    <script>
        $(document).ready(function () {
            $("#fab").kendoFloatingActionButton({
                icon:"plus",
                items:[
                    {icon:"star",label:"Add Rating"},
                    {icon: "pencil", label:"Add Comment"}
                ]
            });
        });
    </script>

See Also

In this article
Related articles
Not finding the help you need? Improve this article