-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(wrappers): move wrappers docs to public repo
- Loading branch information
Showing
308 changed files
with
13,919 additions
and
33 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 |
---|---|---|
@@ -1,44 +1,139 @@ | ||
# Kendo Validator Vue Wrapper Documentation | ||
# Kendo Vue Wrappers Documentation | ||
|
||
### Kendo Popups Vue Wrapper | ||
|
||
- [Overview](kendo-popups-vue-wrapper/index.md) | ||
- [Notification Wrapper](kendo-popups-vue-wrapper/notification-wrapper/index.md) | ||
- [Overview](kendo-popups-vue-wrapper/notification-wrapper/index.md) | ||
- [Notification Types](kendo-popups-vue-wrapper/notification-wrapper/notification-types.md) | ||
- [Hidden State](kendo-popups-vue-wrapper/notification-wrapper/hidden-state.md) | ||
- [Position](kendo-popups-vue-wrapper/notification-wrapper/position.md) | ||
- [Templates](kendo-popups-vue-wrapper/notification-wrapper/templates.md) | ||
- [RTL Support](kendo-popups-vue-wrapper/notification-wrapper/rtl-support.md) | ||
- [Tooltip Wrapper](kendo-popups-vue-wrapper/tooltip-wrapper/index.md) | ||
- [Overview](kendo-popups-vue-wrapper/tooltip-wrapper/index.md) | ||
- [Setting Main Properties](kendo-popups-vue-wrapper/tooltip-wrapper/setting-main-properties.md) | ||
- [Multiple Targets](kendo-popups-vue-wrapper/tooltip-wrapper/multiple-targets.md) | ||
- [Loading Content with AJAX](kendo-popups-vue-wrapper/tooltip-wrapper/loading-content-wth-ajax.md) | ||
- [Referencing Existing Instances](kendo-popups-vue-wrapper/tooltip-wrapper/referencing-existing-instances.md) | ||
- [Templates](kendo-popups-vue-wrapper/tooltip-wrapper/templates.md) | ||
- [API](kendo-popups-vue-wrapper/api) | ||
|
||
**[Notification Examples](kendo-popups-vue-wrapper/examples/notification)** | ||
|
||
**[Tooltip Examples](kendo-popups-vue-wrapper/examples/tooltip)** | ||
|
||
### Kendo Scheduler Vue Wrapper | ||
|
||
- [Overview](kendo-scheduler-vue-wrapper/index.md) | ||
- [Data Binding](kendo-scheduler-vue-wrapper/data-binding.md) | ||
- [Resources](kendo-scheduler-vue-wrapper/resources.md) | ||
- [Basics](kendo-scheduler-vue-wrapper/resources.md) | ||
- [Grouping](kendo-scheduler-vue-wrapper/resources/grouping.md) | ||
- [Selection](kendo-scheduler-vue-wrapper/selection.md) | ||
- [Templates](kendo-scheduler-vue-wrapper/templates.md) | ||
- [Restrictions](kendo-scheduler-vue-wrapper/restrictions.md) | ||
- [Moving and Resizing](kendo-scheduler-vue-wrapper/snap-move-resize.md) | ||
- [PDF Export](kendo-scheduler-vue-wrapper/pdf-export.md) | ||
- [Keyboard Navigation](kendo-scheduler-vue-wrapper/resources) | ||
- [RTL Support](kendo-scheduler-vue-wrapper/rtl-support.md) | ||
- [Adaptive Rendering](kendo-scheduler-vue-wrapper/adaptive-rendering.md) | ||
- [API](kendo-scheduler-vue-wrapper/api) | ||
|
||
**[Scheduler Examples](kendo-scheduler-vue-wrapper/examples)** | ||
|
||
### Kendo ScrollView Vue Wrapper | ||
|
||
- [Overview](kendo-scrollview-vue-wrapper/index.md) | ||
- [API](kendo-scrollview-vue-wrapper/api) | ||
|
||
**[ScrollView Examples](kendo-scrollview-vue-wrapper/examples)** | ||
|
||
### Kendo Spreadsheet Vue Wrapper | ||
|
||
- [Overview](kendo-spreadsheet-vue-wrapper/index.md) | ||
- [Data Binding](kendo-spreadsheet-vue-wrapper/data-binding.md) | ||
- [Sorting and Filtering](kendo-spreadsheet-vue-wrapper/sorting-filtering.md) | ||
- [Disabled Cells](kendo-spreadsheet-vue-wrapper/disabled-cells.md) | ||
- [Custom Editors](kendo-spreadsheet-vue-wrapper/custom-editors.md) | ||
- [Validation](kendo-spreadsheet-vue-wrapper/validation.md) | ||
- [Cell Comments](kendo-spreadsheet-vue-wrapper/cell-comments.md) | ||
- [API](kendo-spreadsheet-vue-wrapper/api) | ||
|
||
**[Spreadsheet Examples](kendo-spreadsheet-vue-wrapper/examples)** | ||
|
||
### Kendo TreeList Vue Wrapper | ||
|
||
- [Overview](kendo-treelist-vue-wrapper/index.md) | ||
- [Data Binding](kendo-treelist-vue-wrapper/data-binding.md) | ||
- [Editing](kendo-treelist-vue-wrapper/editing.md) | ||
- [Drag and Drop](kendo-treelist-vue-wrapper/drag-and-drop.md) | ||
- [Columns](kendo-treelist-vue-wrapper/columns.md) | ||
- [Aggregates](kendo-treelist-vue-wrapper/aggregates.md) | ||
- [Export Options](kendo-treelist-vue-wrapper/export) | ||
- [Excel Export](kendo-treelist-vue-wrapper/export/excel-export.md) | ||
- [PDF Export](kendo-treelist-vue-wrapper/export/pdf-export.md) | ||
- [Keyboard Navigation](kendo-treelist-vue-wrapper/keyboard-navigation.md) | ||
- [API](kendo-treelist-vue-wrapper/api) | ||
|
||
**[TreeList Examples](kendo-treelist-vue-wrapper/examples)** | ||
|
||
### Kendo TreeMap Vue Wrapper | ||
|
||
- [Overview](kendo-treemap-vue-wrapper/index.md) | ||
- [Data Binding](kendo-treemap-vue-wrapper/data-binding.md) | ||
- [API](kendo-treemap-vue-wrapper/api) | ||
|
||
**[TreeMap Examples](kendo-treemap-vue-wrapper/examples)** | ||
|
||
### Kendo TreeView Vue Wrapper | ||
|
||
- [Overview](kendo-treeview-vue-wrapper/index.md) | ||
- [Data Binding](kendo-treeview-vue-wrapper/data-binding.md) | ||
- [Drag and Drop](kendo-treeview-vue-wrapper/drag-and-drop.md) | ||
- [Animation Effects](kendo-treeview-vue-wrapper/animation-effects.md) | ||
- [Icons](kendo-treeview-vue-wrapper/icons.md) | ||
- [Checkboxes](kendo-treeview-vue-wrapper/checkboxes.md) | ||
- [Templates](kendo-treeview-vue-wrapper/templates.md) | ||
- [Keyboard Navigation](kendo-treeview-vue-wrapper/keyboard-navigation.md) | ||
- [RTL Support](kendo-treeview-vue-wrapper/rtl-support.md) | ||
- [API](kendo-treeview-vue-wrapper/api) | ||
|
||
**[TreeView Examples](kendo-treeview-vue-wrapper/examples)** | ||
|
||
### Kendo Upload Vue Wrapper | ||
|
||
- [Overview](kendo-upload-vue-wrapper/index.md) | ||
- [Initial Files](kendo-upload-vue-wrapper/initial-files.md) | ||
- [Validation](kendo-upload-vue-wrapper/validation.md) | ||
- [Templates](kendo-upload-vue-wrapper/templates.md) | ||
- [Chunk Upload](kendo-upload-vue-wrapper/chunk-upload.md) | ||
- [Directory Upload](kendo-upload-vue-wrapper/directory-upload.md) | ||
- [Custom Drop Zone](kendo-upload-vue-wrapper/custom-drop-zone.md) | ||
- [RTL Support](kendo-upload-vue-wrapper/rtl-support.md) | ||
- [API](kendo-upload-vue-wrapper/api) | ||
|
||
**[Upload Examples](kendo-upload-vue-wrapper/examples)** | ||
|
||
### Kendo Validator Vue Wrapper | ||
|
||
## Root Directory | ||
- [Overview](kendo-validator-vue-wrapper/index.md) | ||
- [Custom Validation](kendo-validator-vue-wrapper/custom-validation.md) | ||
- [Examples](kendo-validator-vue-wrapper/examples) | ||
- [API](kendo-validator-vue-wrapper/api) | ||
|
||
<details> | ||
<summary>## API Directory</summary> | ||
<ul> | ||
<li><a href="kendo-validator-vue-wrapper/api/index.md">index.md</a></li> | ||
<li><a href="kendo-validator-vue-wrapper/api/Validator.md">Validator.md</a></li> | ||
</ul> | ||
</details> | ||
|
||
**[Validator Examples](kendo-validator-vue-wrapper/examples)** | ||
|
||
# Kendo Window Vue Wrapper Documentation | ||
### Kendo Window Vue Wrapper | ||
|
||
## Root Directory | ||
- [Actions](kendo-window-vue-wrapper/actions.md) | ||
- [RTL Support](kendo-window-vue-wrapper/rtl-support.md) | ||
- [Overview](kendo-window-vue-wrapper/index.md) | ||
- [Constrain Movement](kendo-window-vue-wrapper/constrain-movement.md) | ||
- [Keyboard Navigation](kendo-window-vue-wrapper/keyboard-navigation.md) | ||
- [Animation Effects](kendo-window-vue-wrapper/animation-effects.md) | ||
- [Dimensions](kendo-window-vue-wrapper/dimensions.md) | ||
- [Loading Content with AJAX](kendo-window-vue-wrapper/loading-content-with-ajax.md) | ||
- [Position](kendo-window-vue-wrapper/position.md) | ||
- [Loading Content with AJAX](kendo-window-vue-wrapper/loading-content-with-ajax.md) | ||
- [Actions](kendo-window-vue-wrapper/actions.md) | ||
- [Animation Effects](kendo-window-vue-wrapper/animation-effects.md) | ||
- [Constrain Movement](kendo-window-vue-wrapper/constrain-movement.md) | ||
- [Keyboard Navigation](kendo-window-vue-wrapper/keyboard-navigation.md) | ||
- [RTL Support](kendo-window-vue-wrapper/rtl-support.md) | ||
- [API](kendo-window-vue-wrapper/api) | ||
|
||
<details> | ||
<summary>## Examples Directory</summary> | ||
<ul> | ||
<li><a href="kendo-window-vue-wrapper/examples/actions">actions</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/animation">animation</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/dimensions">dimensions</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/overview">overview</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/rtl">rtl</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/ajax">ajax</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/constrain">constrain</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/keyboard-navigation">keyboard-navigation</a></li> | ||
<li><a href="kendo-window-vue-wrapper/examples/position">position</a></li> | ||
</ul> | ||
</details> | ||
**[Window Examples](kendo-window-vue-wrapper/examples)** |
15 changes: 15 additions & 0 deletions
15
vue-wrappers-documentation/kendo-popups-vue-wrapper/api/index.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,15 @@ | ||
--- | ||
title: Popups API | ||
page_title: Popups API - Components - Kendo UI for Vue | ||
description: "List of API members in the @progress/kendo-popups-vue-wrapper package, part of Kendo UI for Vue." | ||
slug: api_popups_wrapper | ||
api_reference: true | ||
position: 1 | ||
--- | ||
|
||
# Popups API | ||
|
||
## Components | ||
|
||
* [`kendo-notification`]({% slug api_notificationcomponent_wrapper %}) | ||
* [`kendo-tooltip`]({% slug api_tooltipcomponent_wrapper %}) |
96 changes: 96 additions & 0 deletions
96
...rappers-documentation/kendo-popups-vue-wrapper/api/notification/Notification.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,96 @@ | ||
--- | ||
title: Notification API | ||
description: "API Index | Notification" | ||
api_reference: true | ||
slug: api_notificationcomponent_wrapper | ||
canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/notification/api/" | ||
--- | ||
|
||
# Notification | ||
|
||
## Directive | ||
|
||
`kendo-notification` | ||
|
||
## Props | ||
|
||
### allow-hide-after `Number` | ||
|
||
The period (in milliseconds) after which the user can dismiss (hide) a Notification ([`allowhideafter` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/allowhideafter)). | ||
|
||
### animation `Object | Boolean` | ||
|
||
Defines the custom showing and hiding animations through a Kendo UI `Animation` object ([`animation` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/animation)). Setting `animation` to `false` disables the animations. | ||
|
||
### append-to `String | jQuery` | ||
|
||
The element to which the Notification will be appended or prepended depending on the stacking direction ([`appendTo` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/appendto)). | ||
|
||
### auto-hide-after `Number` | ||
|
||
The period (in milliseconds) after which a Notification disappears automatically ([`autoHideAfter` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/autohideafter)). Setting a zero value disables this behavior. | ||
|
||
### button `Boolean` | ||
|
||
(Works with the built-in templates only) Determines whether the Notification will render a **Hide** button ([`button` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/button)). | ||
|
||
### height `Number | String` | ||
|
||
The height of the Notifications ([`height` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/height)). Numbers are treated as pixels. | ||
|
||
### hide-on-click `Boolean` | ||
|
||
Determines whether the Notification will hide when the user randomly clicks their content ([`hideOnClick` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/hideonclick)). | ||
|
||
### position `Object` | ||
|
||
Applies to popup Notifications only when `appendTo` is not set ([`position` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/position)). Determines the position of the first Notification on the screen and whether the Notifications will move together with the page content during scrolling. `top` takes precedence over `bottom` and `left` takes precedence over `right`. The supported composite props are available in [`PositionProps`]({% slug api_notification_positionprops_wrapper %}). | ||
|
||
### stacking `String` | ||
|
||
The direction in which multiple Notifications will stack (arrange) in relation to the first one ([`stacking` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/stacking)). | ||
|
||
The supported values are: | ||
|
||
* `up` | ||
* `right` | ||
* `down` | ||
* `left` | ||
* `default`—Takes into consideration the applied position settings. Evaluated to `up` or `down`. | ||
|
||
### templates `Array` | ||
|
||
Describes the HTML markup of the different Notification types as Kendo UI template strings ([`templates` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/templates)). | ||
|
||
The supported built-in types are: | ||
|
||
* `info` | ||
* `success` | ||
* `warning` | ||
* `error` | ||
|
||
The supported composite props are available in [`TemplatesProps`]({% slug api_notification_templatesprops_wrapper %}). | ||
|
||
### width `Number | String` | ||
|
||
The width of the Notifications ([`width` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/width)). Numbers are treated as pixels. | ||
|
||
## Events | ||
|
||
### hide: `Function` | ||
|
||
Fires when the hiding animation of a Notification starts ([`hide` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/events/hide)). | ||
|
||
### show: `Function` | ||
|
||
Fires when the showing animation of a Notification starts ([`show` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/events/show)). | ||
|
||
## Methods | ||
|
||
For more details about the methods available in the component's API please check [its Kendo UI for jQuery API documentation](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification#methods). | ||
|
||
### kendoWidget | ||
|
||
##### returns | ||
|
||
Returns the Kendo UI Notification instance. |
32 changes: 32 additions & 0 deletions
32
...appers-documentation/kendo-popups-vue-wrapper/api/notification/PositionProps.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,32 @@ | ||
--- | ||
title: positionProps API | ||
description: "API Index | positionProps" | ||
api_reference: true | ||
slug: api_notification_positionprops_wrapper | ||
--- | ||
|
||
# PositionProps | ||
|
||
### position-bottom `Number` | ||
|
||
The pixel position of the first popup Notification as related to the bottom edge of the viewport. | ||
|
||
### position-left `Number` | ||
|
||
The pixel position of the first popup Notification as related to the left edge of the viewport. | ||
|
||
### position-pinned `Boolean` | ||
|
||
Determines whether the popup Notifications will move together with the other page content during scrolling. | ||
|
||
### position-right `Number` | ||
|
||
The pixel position of the first popup Notification as related to the right edge of the viewport. | ||
|
||
### position-top `Number` | ||
|
||
The position of the first popup Notification as related to the top edge of the viewport. Numeric values are treated as pixels. | ||
|
||
## Suggested Links | ||
|
||
* [`Position` in Kendo UI Notification for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/position) |
20 changes: 20 additions & 0 deletions
20
...ppers-documentation/kendo-popups-vue-wrapper/api/notification/TemplatesProps.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,20 @@ | ||
--- | ||
title: templatesProps API | ||
description: "API Index | templatesProps" | ||
api_reference: true | ||
slug: api_notification_templatesprops_wrapper | ||
--- | ||
|
||
# TemplatesProps | ||
|
||
### templates-template-type `String` | ||
|
||
(Mandatory) A specified unique identifier for retrieving the correct template when a Notification of this type is displayed. | ||
|
||
### templates-template-template `String` | ||
|
||
A Kendo UI template that will be use with the corresponding Notification type. | ||
|
||
## Suggested Links | ||
|
||
* [`Templates` in Kendo UI Notification for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/notification/configuration/templates) |
28 changes: 28 additions & 0 deletions
28
vue-wrappers-documentation/kendo-popups-vue-wrapper/api/tooltip/AnimationProps.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,28 @@ | ||
--- | ||
title: animationProps API | ||
description: "API Index | animationProps" | ||
api_reference: true | ||
slug: api_tooltip_animationprops_wrapper | ||
--- | ||
|
||
# AnimationProps | ||
|
||
### animation-close-effects `String` | ||
|
||
The effect that will be used when the Tooltip is closing. | ||
|
||
### animation-close-duration `Number` | ||
|
||
The duration (in milliseconds) of the animation. | ||
|
||
### animation-open-effects `String` | ||
|
||
The effect that will be used when the Tooltip is opening. | ||
|
||
### animation-open-duration `Number` | ||
|
||
The duration (in milliseconds) of the animation. | ||
|
||
## Suggested Links | ||
|
||
* [`Animation` in Kendo UI Tooltip for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/tooltip/configuration/animation) |
16 changes: 16 additions & 0 deletions
16
vue-wrappers-documentation/kendo-popups-vue-wrapper/api/tooltip/ContentProps.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,16 @@ | ||
--- | ||
title: contentProps API | ||
description: "API Index | contentProps" | ||
api_reference: true | ||
slug: api_tooltip_contentprops_wrapper | ||
--- | ||
|
||
# ContentProps | ||
|
||
### content-url `String` | ||
|
||
The URL or request options from which the Tooltip will load its content. | ||
|
||
## Suggested Links | ||
|
||
* [`Content` in Kendo UI Tooltip for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/tooltip/configuration/content) |
Oops, something went wrong.