Skip to content

Commit

Permalink
docs(wrappers): test wrappers docs index
Browse files Browse the repository at this point in the history
  • Loading branch information
PekoPPT committed Jan 24, 2025
1 parent d180ecb commit 38d98fe
Show file tree
Hide file tree
Showing 119 changed files with 3,723 additions and 33 deletions.
83 changes: 50 additions & 33 deletions vue-wrappers-documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,61 @@
# Kendo Validator Vue Wrapper Documentation
# Kendo Vue Wrappers Documentation

### Kendo TreeView Vue Wrapper

- [Animation](kendo-treeview-vue-wrapper/examples/animation)
- [Data Binding](kendo-treeview-vue-wrapper/examples/data-binding)
- [Icons](kendo-treeview-vue-wrapper/examples/icons)
- [Overview](kendo-treeview-vue-wrapper/examples/overview)
- [Templates](kendo-treeview-vue-wrapper/examples/templates)
- [Checkboxes](kendo-treeview-vue-wrapper/examples/checkboxes)
- [Dragging and Dropping](kendo-treeview-vue-wrapper/examples/dragging-and-dropping)
- [Keyboard Navigation](kendo-treeview-vue-wrapper/examples/keyboard-navigation)
- [RTL](kendo-treeview-vue-wrapper/examples/rtl)
- [API](kendo-treeview-vue-wrapper/api)

<summary>
<a href="kendo-treeview-vue-wrapper/examples" style="color:#ff7f50">TreeView Examples</a>
</summary>

### 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)

<summary>
<a href="kendo-upload-vue-wrapper/examples" style="color:#ff7f50">Upload Examples</a>
</summary>

### 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>

<summary>
<a href="kendo-validator-vue-wrapper/examples" style="color:#ff7f50">Validator Examples</a>
</summary>

# 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>
<summary>
<a href="kendo-window-vue-wrapper/examples" style="color:#ff7f50">Window Examples</a>
</summary>
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: TreeMap API
description: "API Index | TreeMap"
api_reference: true
slug: api_treemapcomponent
---

# TreeMap

## Directive

`kendo-treemap`

## Props

### data-source `Object | Array`

The data source of the TreeMap for rendering the titles and tiles ([`dataSource` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/datasource)).

You can set `data-source` to:

* A JavaScript object which represents any valid data source configuration.
* A JavaScript array.
* An existing `kendo.data.HierarchicalDataSource` instance.

If the `dataSource` option is set to a JavaScript object or an array, the TreeMap will initialize a new `kendo.data.HierarchicalDataSource` instance by using that value as a data source configuration. If the `dataSource` option is an existing `kendo.data.HierarchicalDataSource` instance, the TreeMap will use that instance and will not initialize a new one.

### auto-bind `Boolean`

If `auto-bind` is set to `false`, the TreeMap will not bind to the data source during initialization ([`autoBind` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/autobind)). In such scenarios data binding will occur when the `change` event of the `dataSource` instance is fired. By default, `auto-bind` is set to `true` and the TreeMap will bind to the data source that is specified in the configuration.

### type `String`

The layout type for the TreeMap ([`type` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/type)).

The supported values are:

* `squarified`
* `horizontal`
* `vertical`

### theme `String`

The theme of the TreeMap ([`theme` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/theme)).

### value-field `String`

The data item field which contains the tile value ([`valueField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/valuefield)).

### color-field `String`

The data item field which contains the tile color ([`colorField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/colorfield)).

### text-field `String`

The data item field which contains the tile title ([`textField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/textfield))

### template `String | Function`

The template for rendering the tile content of the TreeMap ([`template` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/template)).

The template supports the following fields:

* `dataItem`&mdash;The original data item for constructing the point.
* `text`&mdash;The original text of the tile.

### colors `Array`

The default colors for the tiles of the TreeMap ([`colors` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/configuration/colors)). Accepts an array of specific colors or an array of color ranges.

## Events

### itemcreated: `Function`

Fired when a tile has been created ([`itemCreated` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/events/itemcreated).

### databound: `Function`

Fired when the widget is bound to data from its dataSource ([`dataBound` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap/events/databound).

## 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/dataviz/ui/treemap).

### kendoWidget

##### returns

Returns the Kendo UI TreeMap instance.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: TreeMap API
page_title: TreeMap API - Components - Kendo UI for Vue
description: "List of API members in the @progress/kendo-treemap-vue-wrapper package, part of Kendo UI for Vue."
slug: api_treemap
api_reference: true
position: 1
---

# TreeMap API

## Components

* [`kendo-treemap`]({% slug api_treemapcomponent %})
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Data Binding
page_title: Data Binding - TreeMap - Kendo UI for Vue
description: "Bind the Kendo UI TreeMap wrapper for Vue to local data arrays."
slug: databinding_treemap
position: 1
---

<div><WrapperBanner></WrapperBanner></div>

# Data Binding

The TreeList provides support for binding it to local data arrays.

To populate the TreeMap with local data:
1. Define the local data array in the `data` object of the Vue application.
2. Refer it in the TreeMap initialization through the `:data-source` or `:data-source-ref` props.

{% meta height:450 %}
{% embed_file data-binding/main.vue preview %}
{% embed_file data-binding/main.js %}
{% endmeta %}

## Suggested Links

* [Kendo UI DataSource Component](https://docs.telerik.com/kendo-ui/api/javascript/data/datasource)
* [Kendo UI TreeMap for jQuery](https://docs.telerik.com/kendo-ui/controls/charts/treemap/overview)
* [API Reference of TreeMap Widget](https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/treemap)
Loading

0 comments on commit 38d98fe

Please sign in to comment.