-
Notifications
You must be signed in to change notification settings - Fork 293
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(api): add FloatingActionButton server-side API
- Loading branch information
Showing
7 changed files
with
454 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Telerik.Web.UI.AlignOffset | ||
page_title: Telerik.Web.UI.AlignOffset | ||
description: Telerik.Web.UI.AlignOffset | ||
--- | ||
|
||
# Telerik.Web.UI.AlignOffset | ||
|
||
Specifies the horizontal and vertical offset of the FloatingActionButton. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.AlignOffset : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### X `Double` | ||
|
||
Specifies the initial horizontal offset of the FloatingActionButton. Numeric values are treated as pixels. String values can specify pixels, percentages, ems, or other valid values. | ||
|
||
### Y `Double` | ||
|
||
Specifies the initial vertical offset of the FloatingActionButton. Numeric values are treated as pixels. String values can specify pixels, percentages, ems or other valid values. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.AlignOffsetConverter | ||
page_title: Telerik.Web.UI.AlignOffsetConverter | ||
description: Telerik.Web.UI.AlignOffsetConverter | ||
--- | ||
|
||
# Telerik.Web.UI.AlignOffsetConverter | ||
|
||
Serialization JS converter class for AlignOffset | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.AlignOffsetConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
38 changes: 38 additions & 0 deletions
38
api/server/Telerik.Web.UI/FloatingActionButtonClientEvents.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Telerik.Web.UI.FloatingActionButtonClientEvents | ||
page_title: Telerik.Web.UI.FloatingActionButtonClientEvents | ||
description: Telerik.Web.UI.FloatingActionButtonClientEvents | ||
--- | ||
|
||
# Telerik.Web.UI.FloatingActionButtonClientEvents | ||
|
||
Defines the client events handlers. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.FloatingActionButtonClientEvents : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### OnClick `String` | ||
|
||
Fires when the user clicks on a the FloatingActionButton.**Note: when using items configuration, clicking on the FloatingActionButton will open the speed-dial list popup. | ||
|
||
### OnCollapse `String` | ||
|
||
Fires when the speed-dial popup is closed and its animation is finished.**Note: this event is triggered only when using items configuration. | ||
|
||
### OnExpand `String` | ||
|
||
Fires when the speed-dial popup is opened and its animation is finished.**Note: this event is triggered only when using items configuration. | ||
|
||
### OnInitialize `String` | ||
|
||
Fired when the FloatingActionButton control is initialized. | ||
|
||
### OnLoad `String` | ||
|
||
Fired when the FloatingActionButton control is loaded on the page. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Telerik.Web.UI.FloatingActionButtonItem | ||
page_title: Telerik.Web.UI.FloatingActionButtonItem | ||
description: Telerik.Web.UI.FloatingActionButtonItem | ||
--- | ||
|
||
# Telerik.Web.UI.FloatingActionButtonItem | ||
|
||
Specifies the speed-dial items that will be rendered in a popup container anchored to the FloatingActionButton.**Note: when using the items configuration, clicking on the FloatingActionButton will open the popup containing the speed-dial list. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.FloatingActionButtonItem | ||
|
||
## Properties | ||
|
||
### ClientTemplate `String` | ||
|
||
Specifies the template used to render the contents of the speed-dial item.The fields which can be used inside the template are: text String - the label of the item (if configured). or icon String - the icon specified for this step (if configured).. | ||
|
||
### CssClass `String` | ||
|
||
Specifies a set of CSS classes for the speed-dial item. | ||
|
||
### Enabled `Boolean` | ||
|
||
Specifies whether the Item is enabled or not. By default all items are enabled. | ||
|
||
### Icon `String` | ||
|
||
Specifies the name for an existing icon in a Kendo UI theme that is rendered in the speed-dial item.See the Web Font Icons help article for more details on Kendo UI icons. | ||
|
||
### Label `String` | ||
|
||
Specifies the label for the speed-dial item. | ||
|
||
### OnClientClicked `String` | ||
|
||
Specifies the click event handler of the speed-dial item. | ||
|
||
### Title `String` | ||
|
||
Specifies the label for the speed-dial item that will be read by assistive technologies. | ||
|
41 changes: 41 additions & 0 deletions
41
api/server/Telerik.Web.UI/FloatingActionButtonItemConverter.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.FloatingActionButtonItemConverter | ||
page_title: Telerik.Web.UI.FloatingActionButtonItemConverter | ||
description: Telerik.Web.UI.FloatingActionButtonItemConverter | ||
--- | ||
|
||
# Telerik.Web.UI.FloatingActionButtonItemConverter | ||
|
||
Serialization JS converter class for FloatingActionButtonItem | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.FloatingActionButtonItemConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
Oops, something went wrong.