• What is KendoReact
  • Getting Started
  • Unstyled Mode
  • Server Components
  • Components
    • Animation
    • Barcodes
    • Buttons
    • Chart Wizardnew
    • Chartsupdated
    • Common Utilities
    • Conversational UIupdated
    • Data Gridupdated
    • Data Query
    • Data Toolsupdated
    • Date Inputs
    • Date Math
    • Dialogsupdated
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Indicators
    • Inputsupdated
    • Labels
    • Layoutupdated
    • ListBoxupdated
    • ListView
    • Map
    • Notification
    • OrgChart
    • PDF Processing
    • PDF Viewer
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Schedulerupdated
    • ScrollView
    • Sortable
    • Spreadsheet
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeViewupdated
    • Upload
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • Updates
  • Troubleshooting
Components / Date Inputs / API / ToggleButtonProps / 

ToggleButtonProps

Represents the props of the KendoReact Toggle Button component.

NameTypeDefaultDescription

disabled?

boolean

Specifies if the Button is disabled (see example). Defaults to false.

endIcon?

React.ReactNode

Sets an SVG icon or custom element after the content of the Button. For the custom component, we recommend using Phrasing content but there must be no Interactive content.

fillMode?

"null" | "link" | "flat" | "solid" | "outline" | "clear"

solid

Configures the fillMode of the Button.

The available options are:

  • solid
  • outline
  • flat
  • link
  • clear
  • null—Does not set a fillMode className.

icon?

string

Defines the name for an existing icon in a KendoReact theme (see example). The icon is rendered inside the Button by a span.k-icon element.

iconClass?

string

Defines a CSS class—or multiple classes separated by spaces—which are applied to a span element inside the Button (see example). Allows the usage of custom icons.

imageAlt?

string

Defines the alternative text of the image rendered inside the Button component.

imageUrl?

string

Defines a URL which is used as an img element inside the Button (see example). The URL can be relative or absolute. If relative, it is evaluated with relation to the URL of the web page.

rounded?

"null" | "small" | "large" | "medium" | "full"

medium

Configures the roundness of the Button.

The available options are:

  • small
  • medium
  • large
  • full
  • null—Does not set a rounded className.

selected?

boolean

Sets the selected state of the Button. Can be used for controlled state.

size?

"null" | "small" | "large" | "medium"

medium

Configures the size of the Button.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.

startIcon?

React.ReactNode

Sets an SVG icon or custom element before the content of the Button. For the custom component, we recommend using Phrasing content but there must be no Interactive content.

svgIcon?

SVGIcon

themeColor?

"null" | "base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "dark" | "light" | "inverse"

base

Configures the themeColor of the Button.

The available options are:

  • base
  • primary
  • secondary
  • tertiary
  • info
  • success
  • warning
  • error
  • dark
  • light
  • inverse
  • null—Does not set a themeColor className.

title?

string

Sets the title htmlAttribute of the Button.

togglable?

boolean

Provides visual styling that indicates if the Button is selected (see example). Defaults to false.

In this article

Not finding the help you need?

Contact Support