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 5968760
Show file tree
Hide file tree
Showing 167 changed files with 5,984 additions and 33 deletions.
99 changes: 66 additions & 33 deletions vue-wrappers-documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,77 @@
# Kendo Validator Vue Wrapper Documentation
# Kendo Vue Wrappers Documentation

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

# Kendo Window Vue Wrapper Documentation

## 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)**
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Aggregates
page_title: Aggregates - TreeList - Kendo UI for Vue
description: "Group the TreeList data by using aggregates when working with the Kendo UI TreeList wrapper for Vue."
slug: aggregates_treelist_wrapper
canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/aggregates/"
position: 5
---

<div><WrapperBanner link="/kendo-vue-ui/components/treelist/aggregates"></WrapperBanner></div>

# Aggregates

The TreeList enables you to group its data by using column aggregates.

The TreeList displays the total calculated values in its footer item at the end of each level.

The available aggregate functions are:
* `average`
* `count`
* `max`
* `min`
* `sum`

{% meta height:440 %}
{% embed_file aggregates/main.vue preview %}
{% embed_file aggregates/main.js %}
{% endmeta %}

## Suggested Links

* [Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/controls/data-management/treelist/overview)
* [API Reference of the TreeList Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist)
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: columnMenuProps API
description: "API Index | columnMenuProps"
api_reference: true
slug: api_treelist_columnmenuprops_wrapper
---

# ColumnMenuProps

### column-menu-columns `Boolean`

If `column-menu-columns` is set to `true`, the column menu allows the user to select (show and hide) the columns of the TreeList. By default, `column-menu-columns` is enabled.

### column-menu-filterable `Boolean`

If `column-menu-filterable` is set to `true`, the column menu allows the user to filter the TreeList. By default, `column-menu-filterable` is enabled if `filterable` is set to `true`.

### column-menu-sortable `Boolean`

If `column-menu-sortable` is set to `true`, the column menu allows the user to sort the TreeList by a column field. By default, `column-menu-sortable` is enabled if `sortable` is set to `true`.

### column-menu-messages-columns `String`

The text message that is displayed for the column selection menu item.

### column-menu-messages-filter `String`

The text message that is displayed for the filter menu item.

### column-menu-messages-sort-ascending `String`

The text message that is displayed for the menu item which performs the ascending sorting.

### column-menu-messages-sort-descending `String`

The text message that is displayed for the menu item which performs the descending sorting.

### column-menu-messages-settings `String`

The text message that is displayed in the header of the menu.

### column-menu-messages-lock `String`

The text message that is displayed in the column menu for locking a column.

### column-menu-messages-unlock `String`

The text message that is displayed in the column menu for unlocking a column.

## Suggested Links

* [`ColumnMenu` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/columnmenu)
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: editableProps API
description: "API Index | editableProps"
api_reference: true
slug: api_treelist_editableprops_wrapper
---

# EditableProps

### editable-mode `String`

The edit mode that will be used.

The supported edit modes are:

* `inline`
* `popup`
* `incell`

### editable-move `Boolean`

Enables the UI for dragging and dropping of rows between parents.

### editable-template `String | Function`

The template for rendering the popup editor. To indicate to the TreeList which fields have to be updated, the template has to contain elements whose `name` HTML attributes are set as the editable fields. Alternatively, use MVVM bindings to bind HTML elements to the data item fields.

### editable-window `Object`

Configures the Kendo UI Window instance which is used when the TreeList is in the popup edit mode.

## Suggested Links

* [`Editable` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/editable)
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: excelProps API
description: "API Index | excelProps"
api_reference: true
slug: api_treelist_excelprops_wrapper
---

# ExcelProps

### excel-file-name `String`

The file name of the exported Excel file.

### excel-filterable `Boolean`

Enables or disables column filtering in the Excel file. Different from the filtering feature of the TreeList.

### excel-force-proxy `Boolean`

If `excel-force-proxy` is set to `true`, the content will be forwarded to `proxyURL` even if the browser supports the saving of files locally.

### excel-proxy-url `String`

The URL of the server side proxy which will stream the file to the end user. When the browser is not capable of saving files locally, a proxy will be used. Such browsers are Internet Explorer version 9 (and older) and Safari. You are responsible for implementing the server-side proxy.

The proxy receives a `POST` request with the following parameters in the request body:

* `contentType`&mdash;The MIME type of the file.
* `base64`&mdash;The base-64 encoded file content.
* `fileName`&mdash;The file name as requested by the caller.

The proxy is expected to return the decoded file with a set `Content-Disposition` header set to `toattachment; filename="<fileName.xslx>"`.

## Suggested Links

* [`Excel` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/excel)
Loading

0 comments on commit 5968760

Please sign in to comment.