Skip to content

Commit

Permalink
Sync with Kendo UI Professional
Browse files Browse the repository at this point in the history
  • Loading branch information
kendo-bot committed Apr 29, 2024
1 parent 836b586 commit 7280c27
Show file tree
Hide file tree
Showing 2 changed files with 226 additions and 0 deletions.
226 changes: 226 additions & 0 deletions docs-aspnet/html-helpers/navigation/togglebutton/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
---
title: Getting Started
page_title: Getting Started
description: "Make your first steps with the Telerik UI for {{ site.framework }} ToggleButton component by following a complete step-by-step tutorial."
slug: aspnetcore_togglebutton_getting_started
position: 1
---

# Getting Started with the ToggleButton

This tutorial explains how to set up a basic Telerik UI for {{ site.framework }} ToggleButton and highlights the major steps in the configuration of the component.

You will initialize two buttons, one of them will have an event handler, an icon, and a badge. The other one will be rendered as disabled. {% if site.core %}Finally, you can run the sample code in [Telerik REPL](https://netcorerepl.telerik.com/) and continue exploring the components.{% endif %}

![Sample Telerik UI for {{ site.framework }} ToggleButton](./images/togglebutton-getting-started.png)

@[template](/_contentTemplates/core/getting-started-prerequisites.md#repl-component-gs-prerequisites)

## 1. Prepare the CSHTML File

@[template](/_contentTemplates/core/getting-started-directives.md#gs-adding-directives)

Optionally, you can structure the document by adding the desired HTML elements like headings, divs, paragraphs, and others.

```HtmlHelper
@using Kendo.Mvc.UI
<h4>ToggleButton:</h4>
```
{% if site.core %}
```TagHelper
@addTagHelper *, Kendo.Mvc
<h4>ToggleButton:</h4>
```
{% endif %}


## 2. Initialize the ToggleButton

Use the ToggleButton HtmlHelper {% if site.core %}or TagHelper{% endif %} 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 ToggleButton element.
* The `Content()` configuration specifies the text that is rendered within the button. This option accepts only string values and no HTML.
* The `Enable()` configuration defines if the component is enabled or disabled.
* The `Group()` configuration is to specify a common `data-group` attribute which allows access for multiple ToggleButton instances.
* The `Selected()` configuration defines whether the component will be selected.

```HtmlHelper
<h4>ToggleButton:</h4>
@(Html.Kendo().ToggleButton()
.Name("toggleButton")
.Group("badges")
.Selected(false)
.Enable(true)
.Content("Humidity")
)
```
{% if site.core %}
```TagHelper
@addTagHelper *, Kendo.Mvc
<h4>ToggleButton:</h4>
<kendo-togglebutton name="toggleButton"
group="badges"
selected="false"
enable="true">
Humidity
</kendo-togglebutton>
```
{% endif %}

## 3. Add an Icon and a Badge

The next step is to display an [icon]({% slug icons_togglebutton_aspnetcore %}) and a [badge]({% slug badges_togglebutton_aspnetcore %}) within the ToggleButton. This allows you to bolster the visual rendering of the component.

```HtmlHelper
<h4>ToggleButton:</h4>
@(Html.Kendo().ToggleButton()
.Name("toggleButton")
.Group("badges")
.Selected(false)
.Icon("droplet")
.Badge(badge => badge
.Position(BadgePosition.Edge)
.Align(BadgeAlign.TopEnd)
.Shape(BadgeShape.Rectangle)
.Text("80%")
.ThemeColor(BadgeColor.Success)
)
.Enable(true)
.Content("Humidity")
)
```
{% if site.core %}
```TagHelper
@addTagHelper *, Kendo.Mvc
<h4>ToggleButton:</h4>
<kendo-togglebutton name="toggleButton"
tag="a"
group="badges"
icon="droplet"
selected="false">
<badge position="BadgePosition.Edge"
align="BadgeAlign.TopEnd"
shape="BadgeShape.Rectangle"
text="80%"
theme-color="BadgeColor.Success" />
Humidity
</kendo-togglebutton>
```
{% endif %}

## 4. Handle a ToggleButton Event

The ToggleButton exposes a `Toggle()` event that you can handle and assign specific functions to the component. In this tutorial, you will use the `Toggle()` event to alert for the checked state of the component.

```HtmlHelper
<h4>ToggleButton:</h4>
@(Html.Kendo().ToggleButton()
.Name("toggleButton")
.Group("badges")
.Selected(false)
.Icon("droplet")
.Badge(badge => badge
.Position(BadgePosition.Edge)
.Align(BadgeAlign.TopEnd)
.Shape(BadgeShape.Rectangle)
.Text("80%")
.ThemeColor(BadgeColor.Success)
)
.Events(events => events.Toggle("onToggle"))
.Enable(true)
.Content("Humidity")
)
<script>
function onToggle(e) {
alert("Checked state:" + e.checked);
}
</script>
```
{% if site.core %}
```TagHelper
@addTagHelper *, Kendo.Mvc
<h4>ToggleButton:</h4>
<kendo-togglebutton name="toggleButton"
tag="a"
group="badges"
icon="droplet"
on-toggle="onToggle"
selected="false">
<badge position="BadgePosition.Edge"
align="BadgeAlign.TopEnd"
shape="BadgeShape.Rectangle"
text="80%"
theme-color="BadgeColor.Success" />
Humidity
</kendo-togglebutton>
<script>
function onToggle(e) {
alert("Checked state:" + e.checked);
}
</script>
```
{% endif %}

For more examples, refer to the [demo on using the events of the ToggleButton](https://demos.telerik.com/{{ site.platform }}/togglebutton/events).

## 5. (Optional) Reference Existing ToggleButton Instances

You can reference the ToggleButton 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
<script>
var togglebuttonReference = $("#toggleButton").data("kendoToggleButton"); // togglebuttonReference is a reference to the existing togglebutton instance of the helper.
</script>
```

1. Use the [ToggleButton client-side API](https://docs.telerik.com/kendo-ui/api/javascript/ui/togglebutton#methods) to control the behavior of the widget. In this example, you will use the `enable` method to disable the component. The method is inherited from the Button widget.

```script
<script>
var togglebuttonReference = $("#toggleButton").data("kendoToggleButton"); // togglebuttonReference is a reference to the existing togglebutton instance of the helper.
togglebuttonReference.enable(false)
</script>
```

For more information on referencing specific helper instances, see the [Methods and Events]({% slug methodevents_core %}) article.

{% if site.core %}
## 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 ToggleButton HtmlHelper](https://netcorerepl.telerik.com/cSkIvZaW35sRvYdR06)
* [Sample code with the ToggleButton TagHelper](https://netcorerepl.telerik.com/meOyFXEM347Lklw751)

{% endif %}

## Next Steps

* [Customize the Appearance of the ToggleButton]({% slug togglebutton_appearance %})
* [Configure the ToggleButton's Badge]({% slug badges_togglebutton_aspnetcore %})

## See Also

* [Using the API of the ToggleButton for {{ site.framework }} (Demo)](https://demos.telerik.com/{{ site.platform }}/togglebutton/api)
* [ToggleButton Client-Side API](https://docs.telerik.com/kendo-ui/api/javascript/ui/togglebutton)
* [Server-Side API of the ToggleButton](/api/togglebutton)
{% if site.core %}
* [TagHelper Server-Side API of the ToggleButton](https://docs.telerik.com/aspnet-core/api/taghelpers/togglebutton)
{% endif %}
* [Knowledge Base Section](/knowledge-base)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7280c27

Please sign in to comment.