Getting Started with the FloatingActionButton

This tutorial explains how to set up a basic Telerik UI for ASP.NET Core FloatingActionButton and highlights the major steps in the configuration of the component.

You will initialize a FloatingActionButton control with three items. Next, you will handle the FloatingActionButton events and display messages in the browser console. Finally, you can run the sample code in Telerik REPL and continue exploring the components.

Prerequisites

To successfully complete the tutorial, you need a project that is already configured to use the Telerik UI for ASP.NET Core components:

• You can use the Telerik REPL playground and skip installing the components on your system and configuring a project.

• You can prepare a Visual Studio project by following either of these guides:

  • Creating a new pre-configured project for the Telerik UI for ASP.NET Core components from a project template.

  • Manually configuring an existing project as described in the First Steps on Windows or First Steps on Mac articles.

1. Prepare the CSHTML File

The first step is to add the required directives at the top of the .cshtml document:

• To use the Telerik UI for ASP.NET Core HtmlHelpers:

  @using Kendo.Mvc.UI
  

• To use the Telerik UI for ASP.NET Core TagHelpers:

  @addTagHelper *, Kendo.Mvc
  

Optionally, you can structure the document by adding the desired HTML elements like headings, divs, paragraphs, and apply some basic styles.

2. Initialize the FloatingActionButton

Use the FloatingActionButton HtmlHelper or TagHelper to add the component to a page:

• The Name() configuration method is mandatory as its value is used for the id and the name attributes of the FloatingActionButton element.

• The Align() configuration method specifies the position of the component relative to its container.

    @using Kendo.Mvc.UI

    @(Html.Kendo().FloatingActionButton()
        .Name("fab")
        .Align(FloatingActionButtonAlign.TopCenter)
        .Icon("share"))

    @addTagHelper *, Kendo.Mvc

    <kendo-floatingactionbutton name="fab"
                                align="FloatingActionButtonAlign.TopCenter"
                                icon="share">
    </kendo-floatingactionbutton>

3. Add Items to the FloatingActionButton

Next, use the Items() method to specify the items that you want to render in the component's popup container. Add their labels and icons. When the user selects the FloatingActionButton, this action will open the popup container with the list of items.

    @using Kendo.Mvc.UI

    @(Html.Kendo().FloatingActionButton()
        .Name("fab")
        .Align(FloatingActionButtonAlign.TopCenter)
        .Icon("share")
        .Items(items =>
        {
            items.Add().Label("Download").Icon("download");
            items.Add().Label("Print").Icon("print");
            items.Add().Label("Email").Icon("envelop");
        }))

    @addTagHelper *, Kendo.Mvc

    <kendo-floatingactionbutton name="fab"
                                align="FloatingActionButtonAlign.TopCenter"
                                icon="share">
        <floatingactionbutton-items>
            <floatingactionbutton-item label="Download"
                                        icon="download">
            </floatingactionbutton-item>
            <floatingactionbutton-item label="Print"
                                        icon="print">
            </floatingactionbutton-item>
            <floatingactionbutton-item label="Email"
                                        icon="envelop">
            </floatingactionbutton-item>
        </floatingactionbutton-items>
    </kendo-floatingactionbutton>

4. Customize the FloatingActionButton

To change the appearance of the FloatingActionButton, use any of its built-in styling options, for example, Size() and ThemeColor().

    @using Kendo.Mvc.UI

    @(Html.Kendo().FloatingActionButton()
        .Name("fab")
        .Align(FloatingActionButtonAlign.TopCenter)
        .Icon("share")
        .ThemeColor(FloatingActionButtonThemeColor.Primary)
        .Size(FloatingActionButtonSize.Medium)
        .Items(items =>
        {
            items.Add().Label("Download").Icon("download");
            items.Add().Label("Print").Icon("print");
            items.Add().Label("Email").Icon("envelop");
        }))

    @addTagHelper *, Kendo.Mvc

    <kendo-floatingactionbutton name="fab"
                                align="FloatingActionButtonAlign.TopCenter"
                                theme-color="FloatingActionButtonThemeColor.Primary"
                                size="FloatingActionButtonSize.Medium"
                                icon="share">
        <floatingactionbutton-items>
            <floatingactionbutton-item label="Download"
                                        icon="download">
            </floatingactionbutton-item>
            <floatingactionbutton-item label="Print"
                                        icon="print">
            </floatingactionbutton-item>
            <floatingactionbutton-item label="Email"
                                        icon="envelop">
            </floatingactionbutton-item>
        </floatingactionbutton-items>
    </kendo-floatingactionbutton>

5. Handle the FloatingActionButton Events

The FloatingActionButton exposes the Click(), Expand(), and Collapse() events that you can handle and assign specific functions to the component. In this tutorial, you will use these events to log messages in the browser's console.

    @using Kendo.Mvc.UI

    @(Html.Kendo().FloatingActionButton()
        .Name("fab")
        .Align(FloatingActionButtonAlign.TopCenter)
        .ThemeColor(FloatingActionButtonThemeColor.Primary)
        .Size(FloatingActionButtonSize.Medium)
        .Icon("share")
        .Items(items =>
        {
            items.Add().Label("Download").Icon("download").Click("onItemClick");
            items.Add().Label("Print").Icon("print").Click("onItemClick");
            items.Add().Label("Email").Icon("envelop").Click("onItemClick");
        })
        .Events(ev=>ev.Click("onClick").Collapse("onCollapse").Expand("onExpand"))
        )

    <script>
        function onClick() {
            console.log("event: click");
        };
        function onExpand() {
            console.log("event: expand");
        };
        function onCollapse() {
            console.log("event: collapse");
        };
        function onItemClick(e) {
            console.log($(e.target).text() + " item clicked");
        };
    </script>

    @addTagHelper *, Kendo.Mvc

    <kendo-floatingactionbutton name="fab"
                                on-click="onClick"
                                on-expand="onExpand"
                                on-collapse="onCollapse"
                                align="FloatingActionButtonAlign.TopCenter"
                                theme-color="FloatingActionButtonThemeColor.Primary"
                                size="FloatingActionButtonSize.Medium"
                                icon="share">
        <floatingactionbutton-items>
            <floatingactionbutton-item label="Download"
                                        icon="download"
                                        click="onItemClick">
            </floatingactionbutton-item>
            <floatingactionbutton-item label="Print"
                                        icon="print"
                                        click="onItemClick">
            </floatingactionbutton-item>
            <floatingactionbutton-item label="Email"
                                        icon="envelop"
                                        click="onItemClick">
            </floatingactionbutton-item>
        </floatingactionbutton-items>
    </kendo-floatingactionbutton>

    <script>
        function onClick() {
            console.log("event: click");
        };
        function onExpand() {
            console.log("event: expand");
        };
        function onCollapse() {
            console.log("event: collapse");
        };
        function onItemClick(e) {
            console.log($(e.target).text() + " item clicked");
        };
    </script>

For more examples, refer to the demo on using the events of the FloatingActionButton.

6. (Optional) Reference Existing FloatingActionButton Instances

You can reference the FloatingActionButton instances that you have created and build on top of their existing configuration:

1. Use the id attribute of the component instance to establish a reference.

   <script>
       var floatingActionButtonReference = $("#fab").data("kendoFloatingActionButton"); // floatingActionButtonReference is a reference to the existing instance of the helper.
   </script>
   

2. Use the FloatingActionButton client-side API to control the behavior of the widget. In this example, you will use the enable method to disable the FloatingActionButton.

   <script>
       var floatingActionButtonReference = $("#fab").data("kendoFloatingActionButton"); // floatingActionButtonReference is a reference to the existing instance of the helper.
       floatingActionButtonReference.enable(false); // Disable the FloatingActionButton instance.
   </script>
   

For more information on referencing specific helper instances, see the Methods and Events article.

Explore this Tutorial in REPL

You can continue experimenting with the code sample above by running it in the Telerik REPL server playground:

• Sample code with the FloatingActionButton HtmlHelper
• Sample code with the FloatingActionButton TagHelper

Next Steps

• Using the Item Templates of the FloatingActionButton
• Customizing the Appearance of the FloatingActionButton
• Configuring the position of the FloatingActionButton

See Also

• Using the API of the FloatingActionButton for ASP.NET Core (Demo)
• FloatingActionButton Client-Side API
• Server-Side API of the FloatingActionButton
• Knowledge Base Section