diff --git a/vue-wrappers-documentation/README.md b/vue-wrappers-documentation/README.md index 72374c84..191b56ba 100644 --- a/vue-wrappers-documentation/README.md +++ b/vue-wrappers-documentation/README.md @@ -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) -
- ## API Directory - -
+**[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) -
- ## Examples Directory - -
\ No newline at end of file +**[Window Examples](kendo-window-vue-wrapper/examples)** \ No newline at end of file diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/aggregates.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/aggregates.md new file mode 100644 index 00000000..c2fba362 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/aggregates.md @@ -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 +--- + +
+ +# 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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ColumnMenuProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ColumnMenuProps.md new file mode 100644 index 00000000..6d3a9fc8 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ColumnMenuProps.md @@ -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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/EditableProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/EditableProps.md new file mode 100644 index 00000000..5831c57f --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/EditableProps.md @@ -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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ExcelProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ExcelProps.md new file mode 100644 index 00000000..e4e1a154 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ExcelProps.md @@ -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`—The MIME type of the file. +* `base64`—The base-64 encoded file content. +* `fileName`—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=""`. + +## Suggested Links + +* [`Excel` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/excel) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/FilterableProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/FilterableProps.md new file mode 100644 index 00000000..86af60fd --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/FilterableProps.md @@ -0,0 +1,152 @@ +--- +title: filterableProps API +description: "API Index | filterableProps" +api_reference: true +slug: api_treelist_filterableprops_wrapper +--- + +# FilterableProps + +### filterable-extra `Boolean` + +If `filterable-extra` is set to `true`, the filter menu allows the user to input a second criterion. + +### filterable-messages-and `String` + +The text of the option which represents the `AND` logical operation. + +### filterable-messages-clear `String` + +The text of the button which clears the filter. + +### filterable-messages-filter `String` + +The text of the button which applies the filter. + +### filterable-messages-info `String` + +The text of the information message on the top of the filter menu. + +### filterable-messages-title `String` + +The text that is rendered for the `title` attribute of the filter menu form. + +### filterable-messages-is-false `String` + +The text of the radio button for false values. Displayed when the user filters Boolean fields. + +### filterable-messages-is-true `String` + +The text of the radio button for true values. Displayed when the user filters Boolean fields. + +### filterable-messages-or `String` + +The text of the option which represents the `OR` logical operation. + +### filterable-operators-string-eq `String` + +The text of the `eq` (equal to) filter operator. + +### filterable-operators-string-neq `String` + +The text of the `ne` (not equal to) filter operator. + +### filterable-operators-string-isnull `String` + +The text of the `isnull` filter operator. + +### filterable-operators-string-isnotnull `String` + +The text of the `isnotnull` filter operator. + +### filterable-operators-string-isempty `String` + +The text of the `isempty` filter operator. + +### filterable-operators-string-isnotempty `String` + +The text of the `isnotempty` filter operator. + +### filterable-operators-string-startswith `String` + +The text of the `startswith` filter operator. + +### filterable-operators-string-contains `String` + +The text of the `contains` filter operator. + +### filterable-operators-string-doesnotcontain `String` + +The text of the `doesnotcontain` filter operator. + +### filterable-operators-string-endswith `String` + +The text of the `endswith` filter operator. + +### filterable-operators-number-eq `String` + +The text of the `eq` (equal to) filter operator. + +### filterable-operators-number-neq `String` + +The text of the `ne` (not equal to) filter operator. + +### filterable-operators-number-isnull `String` + +The text of the `isnull` filter operator. + +### filterable-operators-number-isnotnull `String` + +The text of the `isnotnull` filter operator. + +### filterable-operators-number-gte `String` + +The text of the `gte` (greater than or equal to) filter operator. + +### filterable-operators-number-gt `String` + +The text of the `gt` (greater than) filter operator. + +### filterable-operators-number-lte `String` + +The text of the `lte` (less than or equal to) filter operator. + +### filterable-operators-number-lt `String` + +The text of the `lt` (less than) filter operator. + +### filterable-operators-date-eq `String` + +The text of the `eq` (equal to) filter operator. + +### filterable-operators-date-neq `String` + +The text of the `ne` (not equal to) filter operator. + +### filterable-operators-date-isnull `String` + +The text of the `isnull` filter operator. + +### filterable-operators-date-isnotnull `String` + +The text of the `isnotnull` filter operator. + +### filterable-operators-date-gte `String` + +The text of the `gte` (greater than or equal to) filter operator. + +### filterable-operators-date-gt `String` + +The text of the `gt` (greater than) filter operator. + +### filterable-operators-date-lte `String` + +The text of the `lte` (less than or equal to) filter operator. + +### filterable-operators-date-lt `String` + +The text of the `lt` (less than) filter operator. + +## Suggested Links + +* [`Filterable` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/filterable) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/MessagesProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/MessagesProps.md new file mode 100644 index 00000000..bd75378a --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/MessagesProps.md @@ -0,0 +1,68 @@ +--- +title: messagesProps API +description: "API Index | messagesProps" +api_reference: true +slug: api_treelist_messagesprops_wrapper +--- + +# MessagesProps + +### messages-commands-canceledit `String` + +The text of the **Cancel** button that discards the changes during editing. + +### messages-commands-create `String` + +The text of the **Add new record** button that adds new data rows. + +### messages-commands-createchild `String` + +The text of the **Add child record** button that adds new child data rows. + +### messages-commands-destroy `String` + +The text of the **Delete** button that deletes a data row. + +### messages-commands-edit `String` + +The text of the **Edit** button that shows the editable fields for the row. + +### messages-commands-save `String` + +The text of the **Save Changes** button that saves modified data rows. + +### messages-commands-cancel `String` + +The text of the **Cancel Changes** button that cancels all data modifications. + +### messages-commands-excel `String` + +The text of the **Export to Excel** button that exports the TreeList data in spreadsheet format. + +### messages-commands-pdf `String` + +The text of the **Export to PDF** button that exports the TreeList data in PDF format. + +### messages-commands-update `String` + +The text of the **Update** button that applies the changes during editing. + +### messages-loading `String` + +The text of the **Loading...** message when the TreeList loads its root-level items. + +### messages-no-rows `String` + +The text of **No records to display** message when the TreeList does not show any items. + +### messages-request-failed `String` + +The text of **Request failed.** message when the TreeList fails to load its root-level items. + +### messages-retry `String` + +The text of **Retry** message which is assigned to the button that tries to load root-level items again. + +## Suggested Links + +* [`Messages` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/messages) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/PageableProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/PageableProps.md new file mode 100644 index 00000000..cf190fbc --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/PageableProps.md @@ -0,0 +1,111 @@ +--- +title: pageableProps API +description: "API Index | pageableProps" +api_reference: true +slug: api_treelist_pageableprops_wrapper +--- + +# PageableProps + +### pageable-always-visible `Boolean` + +(Available as of 2017 R3) By default, the TreeList displays a pager even when the total amount of items in the DataSource is less than the `pageSize` value. + +If `pageable-always-visible` is set to `false`, the TreeList will toggle the pager visibility in the following ways: + +* When the total amount of items which is initially set in the DataSource is less than the `pageSize` value, the pager will be hidden. +* When the total amount of items which is initially set in the DataSource is greater than or equal to the `pageSize` value, the pager will be displayed. +* When the total amount of items in the DataSource becomes less than the `pageSize` value (after a delete or filter operation, or on changing the `pageSize` value), the pager will be hidden. +* When the total amount of items in the DataSource becomes greater than or equal to the `pageSize` value (after an insert or filter operation, or on changing the `pageSize` value), the pager will be displayed. + +### pageable-page-size `Number` + +The number of data items which will be displayed in the TreeList. `pageable-page-size` will not work if an already existing Kendo UI DataSource instance is assigned to the TreeList. + +### pageable-previous-next `Boolean` + +If `pageable-previous-next` is set to `true`, the pager will display buttons for navigating to the first, previous, next, and last pages. By default, the TreeList displays the navigation buttons. + +### pageable-numeric `Boolean` + +If `pageable-numeric` is set to `true`, the pager will display buttons for navigating to specific pages. By default, the TreeList displays the navigation buttons. Avoid using `pageable.numeric` and `pageable.input` at the same time. + +### pageable-button-count `Number` + +The maximum number of buttons that are displayed in the numeric pager. If more pages than the specified number are available, the pager will display **...** (ellipsis). + +### pageable-input `Boolean` + +If `pageable-input` is set to `true`, the pager will display an input element which allows the user to type in a specific page number. By default, the TreeList does not display the page input. Avoid using `pageable.input` and `pageable.numeric` at the same time. + +### pageable-page-sizes `Boolean | Array` + +If `pageable-page-sizes` is set to `true`, the pager will display a drop-down list which allows the user to pick a page size. By default, the TreeList does not display the page size drop-down list. + +To override the default list, set `pageable-page-sizes` to an array of predefined page sizes. The TreeList supports the `all` value which sets the page size to the total number of records. If you provide a `pageSize` setting for the data source, then the TreeList will initially select that value. + +### pageable-refresh `Boolean` + +If `pageable-refresh` is set to `true`, the pager will display the **Refresh** button. Clicking the **Refresh** button refreshes the TreeList. By default, the TreeList does not display the **Refresh** button. + +### pageable-responsive `Boolean` + +If set to `false` the pager will not be responsive. By default the pager is responsive. + +### pageable-info `Boolean` + +If `pageable-info` is set to `true`, the pager will display information about the current page and the total number of data items. By default, the TreeList displays the paging information. + +### pageable-messages-display `String` + +The text of the pager. Uses `kendo.format`. + +The supported placeholders are: + +* `{0}`—Represents the index of the first data item. +* `{1}`—Represents the index of the last data item. +* `{2}`—Represents the total number of data items. + +### pageable-messages-empty `String` + +The text that is displayed when the TreeList is empty. + +### pageable-messages-page `String` + +The label that is displayed before the pager input. + +### pageable-messages-of `String` + +The label that is displayed before the pager input. Uses `kendo.format`. Supports the optional `{0}` placeholder which represents the total number of pages. + +### pageable-messages-items-per-page `String` + +The label that is displayed after the drop-down list of the page sizes. + +### pageable-messages-first `String` + +The tooltip of the button which goes to the first page. + +### pageable-messages-last `String` + +The tooltip of the button which goes to the last page. + +### pageable-messages-next `String` + +The tooltip of the button which goes to the next page. + +### pageable-messages-previous `String` + +The tooltip of the button which goes to the previous page. + +### pageable-messages-refresh `String` + +The tooltip of the **Refresh** button. + +### pageable-messages-more-pages `String` + +The tooltip of the **...** (ellipsis) button which appears when the number of pages is greater than the `buttonCount` value. + +## Suggested Links + +* [`Pageable` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/pageable) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/PdfProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/PdfProps.md new file mode 100644 index 00000000..565c636f --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/PdfProps.md @@ -0,0 +1,100 @@ +--- +title: pdfProps API +description: "API Index | pdfProps" +api_reference: true +slug: api_treelist_pdfprops_wrapper +--- + +# PdfProps + +### pdf-author `String` + +The author of the PDF document. + +### pdf-avoid-links `Boolean | String` + +A flag which indicates whether to produce actual hyperlinks in the exported PDF file. It is also possible to pass a CSS selector as an argument. All matching links will be ignored. + +### pdf-creator `String` + +The creator of the PDF document. + +### pdf-date `Date` + +The date when the PDF document is created. Defaults to `new Date()`. + +### pdf-file-name `String` + +Specifies the file name of the exported PDF file. + +### pdf-force-proxy `Boolean` + +If set to `true`, the content will be forwarded to `proxyURL` even if the browser supports the saving of files locally. + +### pdf-keywords `String` + +The keywords of the exported PDF file. + +### pdf-landscape `Boolean` + +If `pdf-landscape` is set to `true`, the paper dimensions will be reversed. + +### pdf-margin-bottom `Number | String` + +The bottom margin. Numbers are considered as `pt` units. + +### pdf-margin-left `Number | String` + +The left margin. Numbers are considered as `pt` units. + +### pdf-margin-right `Number | String` + +The right margin. Numbers are considered as `pt` units. + +### pdf-margin-top `Number | String` + +The top margin. Numbers are considered as `pt` units. + +### pdf-paper-size `String | Array` + +Specifies the paper size of the PDF document. The default setting is `auto` and determines the paper size by content. + +The supported values are: + +* A predefined size—A0-A10, B0-B10, C0-C10, Executive, Folio, Legal, Letter, Tabloid. +* An array of two numbers which specify the width and height in points (1pt = 1/72in). +* An array of two strings which specify the width and height in units. + + The supported units are: + * `mm` + * `cm` + * `in` + * `pt` + +### pdf-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`—The MIME type of the file. +* `base64`—The base-64 encoded file content. +* `fileName`—The file name as requested by the caller. + +The proxy is expected to return the decoded file with a `Content-Disposition` header set to `attachment; filename=""`. + +### pdf-proxy-target `String` + +A name or keyword which indicates where to display the document that is returned by the proxy. To display the document in a new window or an iframe, the proxy method has to set the `Content-Disposition` header of the response to `inline; filename=""`. + +### pdf-subject `String` + +Sets the subject of the PDF file. + +### pdf-title `String` + +Sets the title of the PDF file. + +## Suggested Links + +* [`Pdf` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/pdf) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/SortableProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/SortableProps.md new file mode 100644 index 00000000..0e8a5728 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/SortableProps.md @@ -0,0 +1,23 @@ +--- +title: sortableProps API +description: "API Index | sortableProps" +api_reference: true +slug: api_treelist_sortableprops_wrapper +--- + +# SortableProps + +### sortable-allow-unsort `Boolean` + +If `sortable-allow-unsort` is set to `true`, the user can get the TreeList in its unsorted state by clicking the sorted column header. + +### sortable-mode `String` + +The sort mode. + +* If `sortable-mode` is set to `single`, the user can sort by one column at a time. +* If `sortable-mode` is set to `multiple`, the user can sort by multiple columns. + +## Suggested Links + +* [`Sortable` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/sortable) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ToolbarProps.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ToolbarProps.md new file mode 100644 index 00000000..af36a652 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/ToolbarProps.md @@ -0,0 +1,35 @@ +--- +title: toolbarProps API +description: "API Index | toolbarProps" +api_reference: true +slug: api_treelist_toolbarprops_wrapper +--- + +# ToolbarProps + +### toolbar-toolbar-item-click `Function` + +The click handler of the toolbar command which is used for custom toolbar commands. + +### toolbar-toolbar-item-image-class `String` + +A class name that will be rendered inside the **Toolbar** button. If `toolbar-toolbar-item-image-class` is set, the TreeList renders an additional `span` element inside the **Toolbar** button having its `class` name set to the `option` value. This setting enables you to display an icon inside your custom toolbar commands. + +### toolbar-toolbar-item-name `String` + +The name of the toolbar command. The TreeList outputs the `name` in the HTML as a value of the `data`-command attribute of the button. + +The supported values are: + +* (Built-in) `create` +* (Built-in) `excel` +* (Built-in) `pdf` +* A custom string + +### toolbar-toolbar-item-text `String` + +The text that is displayed by the command button. If `toolbar-toolbar-item-text` is not set, the TreeList will use the `name` option as the button text instead. + +## Suggested Links + +* [`Toolbar` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/toolbar) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/TreeList.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/TreeList.md new file mode 100644 index 00000000..842892fd --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/TreeList.md @@ -0,0 +1,257 @@ +--- +title: TreeList API +description: "API Index | TreeList" +api_reference: true +slug: api_treelistcomponent_wrapper +--- + +# TreeList + +## Directive + +`kendo-treelist` + +## Child Components + +* [`kendo-treelist-column`]({% slug api_treelistcolumncomponent_wrapper %}) + +## Props + +### auto-bind `Boolean` + +If `auto-bind` is set to `false`, the TreeList will not bind to the data source during initialization ([`autoBind` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/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 TreeList will bind to the data source that is specified in the configuration. + +### columns `Array` + +The configuration of the TreeList columns ([`columns` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/columns)). + +The supported values are: + +* An array of JavaScript objects—JavaScript objects are interpreted as column configurations. +* Strings—Strings are interpreted as the field to which the column is bound. + +The TreeList creates a column for every item of the array. + +### resizable `Boolean` + +If `resizable` is set to `true`, users can resize columns by dragging their header borders ([`resizable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/resizable)). By default, column-resizing is disabled. + +### reorderable `Boolean` + +If `reorderable` is set to `true`, the user can reorder the columns by dragging their header cells ([`reorderable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/reorderable)). By default, column-reordering is disabled. + +### column-menu `Boolean | Object` + +If `column-menu` is set to `true`, the TreeList displays the column menu when the user clicks the **Chevron** icon in the column headers ([`columnMenu` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/columnmenu)). The column menu allows the user to show and hide columns and, if sorting and filtering are enabled, to filter and sort columns. By default, the column menu is disabled. Accepts a JavaScript object which represents the column menu configuration. The supported composite props are available in [`ColumnMenuProps`]({% slug api_treelist_columnmenuprops_wrapper %}). + +### data-source `Object | Array` + +The data source of the TreeList for rendering the table rows ([`dataSource` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/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.DataSource` instance. + +If the `dataSource` option is set to a JavaScript object or an array, the TreeList will initialize a new `kendo.data.DataSource` instance by using that value as a data source configuration. If the `dataSource` option is an existing `kendo.data.DataSource` instance, the TreeList will use that instance and will not initialize a new one. + +### editable `Boolean | Object` + +If `editable` is set to `true`, the user will be able to edit the data to which the TreeList is bound ([`editable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/editable)). By default, editing is disabled. Accepts a JavaScript object which represents the edit mode. + +The supported edit modes are: + +* `inline` +* (Default) `incell` +* `popup` + +The supported composite props are available in [`EditableProps`]({% slug api_treelist_editableprops_wrapper %}). + +### excel `Object` + +Configures the Excel-export settings of the TreeList ([`excel` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/excel)). The supported composite props are available in [`ExcelProps`]({% slug api_treelist_excelprops_wrapper %}). + +### filterable `Boolean | Object` + +If `filterable` is set to `true`, the user can filter the data source by using the filter menu of the TreeList ([`filterable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/filterable)). By default, filtering is disabled. Accepts a JavaScript object which represents the filter menu configuration. The supported composite props are available in [`FilterableProps`]({% slug api_treelist_filterableprops_wrapper %}). + +### height `Number | String` + +The height of the TreeList ([`height` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/height)). Numeric values are treated as pixels. + +### messages `Object` + +The text of the command buttons that are displayed within the TreeList ([`messages` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/messages)). Primarily used for localization. The supported composite props are available in [`MessagesProps`]({% slug api_treelist_messagesprops_wrapper %}). + +### navigatable `Boolean` + +If `navigatable` is set to `true`, the user can navigate the TreeList by using its keyboard navigation ([`navigatable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/navigatable)). By default, the keyboard navigation is disabled. + +### pageable `Boolean | Object` + +If `pageable` is set to `true`, the TreeList will display a pager ([`pageable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/pageable)). By default, only client-side paging is enabled which means that all data items are expected to be available upon the initialization of the TreeList. Accepts a JavaScript object which represents the pager configuration. The supported composite props are available in [`PageableProps`]({% slug api_treelist_pageableprops_wrapper %}). + +### pdf `Object` + +Configures the PDF-export settings of the TreeList ([`pdf` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/pdf)). The supported composite props are available in [`PdfProps`]({% slug api_treelist_pdfprops_wrapper %}). + +### scrollable `Boolean | Object` + +If `scrollable` is set to `true`, the TreeList will display a scrollbar when the total height or width of the rows exceeds the height or width of the TreeList ([`scrollable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/scrollable)). Scrolling renders separate tables for the header and data area of the TreeList. By default, scrolling is enabled. Disable scrolling for accessibility applications. + +### selectable `Boolean | String` + +If `selectable` is set to `true`, the user can select TreeList rows ([`selectable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/selectable)). By default, selection is disabled. + +The supported values are: + +* `row`—The user can select a single row. +* `cell`—The user can select a single cell. +* `multiple, row`—The user can select multiple rows. +* `multiple, cell`—The user can select multiple cells. + +### sortable `Boolean | Object` + +If `sortable` is set to `true`, the user can sort the TreeList by clicking the column header cells ([`sortable` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/sortable)). By default, sorting is disabled. Accepts a JavaScript object which represents the sorting configuration. The supported composite props are available in [`SortableProps`]({% slug api_treelist_sortableprops_wrapper %}). + +### toolbar `Array` + +* If a string value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole TreeList toolbar and the string value will be passed as an argument to a `kendo.template()` function ([`toolbar` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/toolbar)). +* If a `kendo.template()` function call or a generic function reference value is assigned, then the return value of the function will be used to render the content of the TreeList toolbar. +* If an array value is assigned, it will be treated as the list of commands that is displayed in the toolbar of the TreeList. + +Accepts the following commands: + +* `cancel`—A built-in command that reverts the data changes which were made by the user. +* `create`—A built-in command that adds an empty data item to the TreeList. +* `save`—A built-in command that persists the data changes which were made by the user. +* `excel`—A built-in command that exports the TreeList in the MS Excel format. +* `pdf`—A built-in command that exports the TreeList to PDF. +* Custom + +The supported composite props are available in [`ToolbarProps`]({% slug api_treelist_toolbarprops_wrapper %}). + +## Events + +### beforeedit: `Function` + +Fires when the user tries to edit or to create a data item and before the editor is created ([`beforeEdit` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/beforeedit)). Used for preventing custom editing. The event handler function context (available through the `this` keyword) will be set to the TreeList instance. The event will be fired only when the TreeList is editable. + +### cancel: `Function` + +Fires when the user clicks the **Cancel** button in the inline or popup edit mode, or closes the popup window ([`cancel` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/cancel)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### cellclose: `Function` + +Fires when the TreeList is in the incell edit mode and the cell is going to be closed ([`cellClose` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/cellclose)). The event is triggered after saving or canceling the changes but before the cell is closed. The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### change: `Function` + +Fires when the user selects a table row or cell in the TreeList ([`change` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/change)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### collapse: `Function` + +Fires when an item is about to be collapsed ([`collapse` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/collapse)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### databinding: `Function` + +Fires before the TreeList binds to its data source ([`dataBinding` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/databinding)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### databound: `Function` + +Fires when the TreeList is bound to data from its data source ([`dataBound` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/databound)).The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### dragstart: `Function` + +Fires when the user attempts to drag an item ([`dragStart` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/dragstart)). If `dragstart` is prevented, the item is unmovable. The event handler function context (available through the `this` keyword) will be set to the TreeList instance.Available in builds 2015.3.1014 and later. + +### drag: `Function` + +Fires while the user is dragging an item ([`drag` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/drag)). This event is triggered on every mouse move. The event handler function context (available through the `this` keyword) will be set to the TreeList instance.Available in builds 2015.3.1014 and later. + +### dragend: `Function` + +(Available as of 2015.3.1014) Fires when the user finished dragging an item and the model was updated ([`dragEnd` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/dragend)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### drop: `Function` + +Fires when the user drops an item ([`drop` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/drop)). If `drop` is prevented, the source row will be unmovable. The event handler function context (available through the `this` keyword) will be set to the TreeList instance.Available in builds 2015.3.1014 and later. + +### edit: `Function` + +Fires when the user edits or creates a data item ([`edit` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/edit)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### excelexport: `Function` + +Fires when the user clicks the **Export to Excel** toolbar button ([`excelExport` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/excelexport)). + +### expand: `Function` + +Fires when an item is about to be expanded ([`expand` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/expand)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### filtermenuinit: `Function` + +Fires when the TreeList filter menu is initialized ([`filterMenuInit` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/filtermenuinit)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### filtermenuopen: `Function` + +Fires when the TreeList filter menu is opened ([`filterMenuOpen` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/filtermenuopen)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### pdfexport: `Function` + +Fires when the user clicks the **Export to PDF** toolbar button ([`pdfExport` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/pdfexport)). + +### remove: `Function` + +Fires when the user clicks the **Destroy** command button ([`remove` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/remove)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### save: `Function` + +Fires when a data item is saved ([`save` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/save)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### savechanges: `Function` + +Fires when the user clicks the "save" command button ([`saveChanges` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/savechanges)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnshow: `Function` + +Fires when the user shows a column ([`columnShow` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnshow)).The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnhide: `Function` + +Fires when the user hides a column ([`columnHide` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnhide)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnreorder: `Function` + +Fires when the user changes the order of a column ([`columnReorder` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnreorder)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnresize: `Function` + +Fires when the user resizes a column ([`columnResize` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnresize)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnmenuinit: `Function` + +Fires when the column menu is initialized ([`columnMenuInit` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnmenuinit)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnmenuopen: `Function` + +Fires when the column menu is opened ([`columnMenuOpen` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnmenuopen)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnlock: `Function` + +Fires when the user locks a column ([`columnLock` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnlock)).The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +### columnunlock: `Function` + +Fires when the user unlocks a column ([`columnUnlock` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/events/columnunlock)). The event handler function context (available through the `this` keyword) will be set to the TreeList instance. + +## 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/treelist#methods). + +### kendoWidget + +##### returns + +Returns the Kendo UI TreeList instance. diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/TreeListColumn.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/TreeListColumn.md new file mode 100644 index 00000000..21c3f24d --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/TreeListColumn.md @@ -0,0 +1,151 @@ +--- +title: TreeListColumn API +description: "API Index | TreeListColumn" +api_reference: true +slug: api_treelistcolumncomponent_wrapper +--- + +# TreeListColumn + +## Directive + +`kendo-treelist-column` + +## Props + +### attributes `Object` + +The HTML attributes of the table cell (``) that are rendered for the column. + +### columns `Array` + +The columns which will be rendered as child columns under the column header of this group. Group columns cannot be data-bound and support a limited number of bound column settings, such as `title` and `locked`. + +### command `Array` + +The configuration of the column commands. If `command` is set, the column will display a button for every command. + +The supported commands are: + +* (Built-in) `edit`—Switches the current table row to edit mode. +* (Built-in) `createChild`—Adds a new child item to the current table row and switches to edit mode. +* (Built-in) `destroy`—Removes the data item to which the current table row is bound. +* Custom—Supported by specifying the `click` option. + +### editable `Function` + +The JavaScript function which is executed when a cell or a row is about to be opened for editing. The returned result determines whether the TreeList will create an editor for the column. + +### editor `Function` + +Specifies a UI for custom editing of the column. To create the editing UI, use the `container` parameter. + +### encoded `Boolean` + +* If `encoded` is set to `true`, the column value will be HTML-encoded before it is displayed. +* If `encoded` is set to `false`, the column value will be displayed as is. + +By default, the column value is HTML-encoded. + +### expandable `Boolean` + +If `expandable` is set to `true`, the column displays the icons that are used for expanding and collapsing child rows. By default, the first column of the TreeList is expandable. + +### field `String` + +The field to which the column is bound. The value of this field is displayed by the column during data binding. The field name has to be any valid Javascript identifier, has to contain alphanumeric, `$`, or `_` characters, and must not start with a digit. + +### filterable `Boolean` + +* If `filterable` is set to `true` and filtering is enabled, the TreeList will display a filter menu for this column. +* If `filterable` is set to `false`, the TreeList will not display the filter menu. + +By default, a filter menu is displayed for all columns when filtering is enabled over the `filterable` option. `filterable` can be set to a JavaScript object which represents the filter menu configuration. + +### filterable-ui `String | Function` + +The `role` data attribute of the TreeList that is used in the filter menu or a JavaScript function which initializes the TreeList. + +### footer-template `String | Function` + +The template for rendering the footer table cell of the column. + +The template supports the following fields: + +* `average`—The value of the `average` aggregate (if specified). +* `count`—The value of the `count` aggregate (if specified). +* `max`—The value of the `max` aggregate (if specified). +* `min`—The value of the `min` aggregate (if specified). +* `sum`—The value of the `sum` aggregate (if specified). + +### format `String` + +The format that is applied to the value before it is displayed. + +The supported format is `{0:format}` where `format` is any of the following values: + +* A standard number format. +* A custom number format. +* A standard date format. +* A custom date format. + +### header-attributes `Object` + +The HTML attributes of the table header cell (``) that is rendered for the column. + +### header-template `String | Function` + +The template for rendering the content of the column header. By default, the TreeList displays the value of the `title` column option in the column header cell. + +### min-screen-width `Number` + +The pixel screen width below which the column will be hidden. Avoid using `min-screen-width` and `hidden` at the same time because `min-screen-width` takes precedence over `hidden`. + +### sortable `Boolean` + +* If `sortable` is set to `true` and sorting is enabled, the user can click the column header and sort the TreeList by the column field. +* If `sortable` is set to `false`, sorting will be disabled for this column. + +By default, all columns are sortable if sorting is enabled over the `sortable` option. + +### sortable-compare `Function` + +A JavaScript function which for comparing the values. + +The functions returns the following values: + +* If the first argument is less than the second one, the function returns `-1` (minus one). +* If both arguments are the same, the function returns `0` (zero). +* If the first argument is greater than the second one, the function returns `+1` (plus one). + +### template `String | Function` + +The template for rendering the column content. The TreeList renders table rows (``) which represent the data source items. Each table row consists of table cells (``) which represent the columns of the TreeList. By default, the TreeList displays the HTML-encoded value of the field in the column. + +### title `String` + +The text that is displayed in the column header cell. If `title` is not set, the TreeList uses the `field` value. + +### width `String | Number` + +The width of the column. Numeric values are treated as pixels. + +### hidden `Boolean` + +If `hidden` is set to `true`, the TreeList will not display a column. By default, the TreeList displays all columns. + +### menu `Boolean` + +If `menu` is set to `true`, the column in the column menu of the TreeList will be visible. By default, the column menu includes all data-bound columns—the ones that have their `field` set. + +### locked `Boolean` + +If `locked` is set to `true`, the TreeList will display the column as locked (frozen). + +### lockable `Boolean` + +If `lockable` is set to `false`, the column will remain to the side of the TreeList where its own `locked` configuration placed it. + +## Suggested Links + +* [`Columns` in Kendo UI TreeList for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist/configuration/columns) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/index.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/index.md new file mode 100644 index 00000000..820045f3 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/api/index.md @@ -0,0 +1,15 @@ +--- +title: TreeList API +page_title: TreeList API - Components - Kendo UI for Vue +description: "List of API members in the @progress/kendo-treelist-vue-wrapper package, part of Kendo UI for Vue." +slug: api_treelist_wrapper +api_reference: true +position: 1 +--- + +# TreeList API + +## Components + +* [`kendo-treelist`]({% slug api_treelistcomponent_wrapper %}) +* [`kendo-treelist-column`]({% slug api_treelistcolumncomponent_wrapper %}) \ No newline at end of file diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/columns.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/columns.md new file mode 100644 index 00000000..3ae6a6c9 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/columns.md @@ -0,0 +1,26 @@ +--- +title: Columns +page_title: Columns - TreeList - Kendo UI for Vue +description: "Configure the column features of the Kendo UI TreeList wrapper for Vue." +slug: columns_treelist_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/" +position: 4 +--- + +
+ +# Columns + +The TreeList enables you to resize and reorder its columns. + +The following example demonstrates how to modify the TreeList by using the column resizing and reordering functionality. + +{% meta height:500 %} +{% embed_file columns/main.vue preview %} +{% embed_file columns/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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/data-binding.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/data-binding.md new file mode 100644 index 00000000..78e76224 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/data-binding.md @@ -0,0 +1,55 @@ +--- +title: Data Binding +page_title: Data Binding - TreeList - Kendo UI for Vue +description: "Bind the Kendo UI TreeList wrapper for Vue to local data arrays or remote data services." +slug: databinding_treelist_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/" +position: 1 +--- + +
+ +# Data Binding + +The TreeList provides support for binding it to [local data arrays](#toc-binding-to-local-data-arrays) and to [remote data services](#toc-binding-to-remote-data-services). + +## Binding to Local Data Arrays + +The following example demonstrates how to create a TreeList and bind it to a local data source. + +{% meta height:260 %} +{% embed_file data-binding/local/main.vue preview %} +{% embed_file data-binding/local/main.js %} +{% endmeta %} + +## Binding to Remote Data Services + +You can bind the TreeList to a remote dataset by either: + +* [Using the TreeListDataSource component](#toc-using-the-treelistdatasource-component), or +* [Using the `data` method](#toc-using-the-data-method). + +### Using the TreeListDataSource Component + +The following example demonstrates how to bind the TreeList to a remote [TreeListDataSource component]({% slug overview_treelistdatasource %}). + +{% meta height:260 %} +{% embed_file data-binding/remote/main.vue preview %} +{% embed_file data-binding/remote/main.js %} +{% endmeta %} + +### Using the data Method + +The following example demonstrates how to bind the TreeList to remote data by using the `data` method. + +{% meta height:260 %} +{% embed_file data-binding/data-method/main.vue preview %} +{% embed_file data-binding/data-method/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeListDataSource Component for Vue]({% slug overview_treelistdatasource %}) +* [Kendo UI DataSource Component](https://docs.telerik.com/kendo-ui/api/javascript/data/datasource) +* [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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/drag-and-drop.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/drag-and-drop.md new file mode 100644 index 00000000..a278263f --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/drag-and-drop.md @@ -0,0 +1,26 @@ +--- +title: Dragging and Dropping +page_title: Dragging and Dropping - TreeList - Kendo UI for Vue +description: "Configure the drag and drop features of the Kendo UI TreeList wrapper for Vue." +slug: drag_and_drop_treelist_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/" +position: 3 +--- + +
+ +# Dragging and Dropping + +The TreeList enables you to allow the rearranging of its records through dragging and dropping. + +To enable the drag-and-drop functionality, use the `:editable-move` property. + +{% meta height:500 %} +{% embed_file dragging-and-dropping/main.vue preview %} +{% embed_file dragging-and-dropping/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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/editing.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/editing.md new file mode 100644 index 00000000..5fec1ddc --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/editing.md @@ -0,0 +1,46 @@ +--- +title: Editing +page_title: Editing - TreeList - Kendo UI for Vue +description: "Get started with the editing functionality of the Kendo UI TreeList wrapper in Vue projects." +slug: editing_treelist_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/" +position: 2 +--- + +
+ +# Editing + +The Kendo UI TreeList enables you to modify its records. + +The available editing options are: + +* [Inline editing](#toc-inline-mode) +* [Popup editing](#toc-popup-mode) + +You can also rearrange TreeList items by [dragging and dropping]({% slug drag_and_drop_treelist_wrapper %}). + +## Inline Mode + +The following example demonstrates how to edit data in the default `inline` editing mode. + +{% meta height:630 %} +{% embed_file editing/inline/main.vue preview %} +{% embed_file editing/inline/main.js %} +{% endmeta %} + +## Popup Mode + +The following example demonstrates how to edit data in the `pop-up` editing mode. + +{% meta height:630 %} +{% embed_file editing/popup/main.vue preview %} +{% embed_file editing/popup/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) diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/custom/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/aggregates/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/custom/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/aggregates/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/aggregates/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/aggregates/main.vue new file mode 100644 index 00000000..2a65706b --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/aggregates/main.vue @@ -0,0 +1,55 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/predefined/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/columns/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/predefined/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/columns/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/columns/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/columns/main.vue new file mode 100644 index 00000000..60a25481 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/columns/main.vue @@ -0,0 +1,48 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/ajax/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/data-method/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/ajax/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/data-method/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/data-method/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/data-method/main.vue new file mode 100644 index 00000000..c7bb55e6 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/data-method/main.vue @@ -0,0 +1,52 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/animation/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/local/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/animation/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/local/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/local/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/local/main.vue new file mode 100644 index 00000000..43c1958a --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/local/main.vue @@ -0,0 +1,32 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/constrain/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/remote/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/constrain/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/remote/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/remote/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/remote/main.vue new file mode 100644 index 00000000..9a726a53 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/data-binding/remote/main.vue @@ -0,0 +1,81 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/dimensions/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/dragging-and-dropping/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/dimensions/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/dragging-and-dropping/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/dragging-and-dropping/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/dragging-and-dropping/main.vue new file mode 100644 index 00000000..e34f13a9 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/dragging-and-dropping/main.vue @@ -0,0 +1,45 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/keyboard-navigation/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/inline/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/keyboard-navigation/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/inline/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/inline/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/inline/main.vue new file mode 100644 index 00000000..f4b345ce --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/inline/main.vue @@ -0,0 +1,74 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/overview/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/popup/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/overview/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/popup/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/popup/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/popup/main.vue new file mode 100644 index 00000000..fe5df690 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/editing/popup/main.vue @@ -0,0 +1,73 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/position/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/excel/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/position/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/excel/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/excel/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/excel/main.vue new file mode 100644 index 00000000..7060db81 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/excel/main.vue @@ -0,0 +1,57 @@ + + + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/rtl/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/pdf/main.js similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/rtl/main.js rename to vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/pdf/main.js diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/pdf/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/pdf/main.vue new file mode 100644 index 00000000..a81ca9b8 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/export/pdf/main.vue @@ -0,0 +1,55 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/keyboard-navigation/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/keyboard-navigation/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/keyboard-navigation/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/keyboard-navigation/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/keyboard-navigation/main.vue new file mode 100644 index 00000000..6b0d7a76 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/keyboard-navigation/main.vue @@ -0,0 +1,76 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/basic-usage/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/basic-usage/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/basic-usage/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/basic-usage/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/basic-usage/main.vue new file mode 100644 index 00000000..809fee12 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/basic-usage/main.vue @@ -0,0 +1,32 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/events/main.js b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/events/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/events/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/events/main.vue b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/events/main.vue new file mode 100644 index 00000000..11cc3a4a --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/examples/overview/events/main.vue @@ -0,0 +1,93 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/_meta.yml b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/_meta.yml new file mode 100644 index 00000000..62465105 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/_meta.yml @@ -0,0 +1,2 @@ +title: Export Options +position: 6 diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/excel-export.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/excel-export.md new file mode 100644 index 00000000..90362d21 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/excel-export.md @@ -0,0 +1,23 @@ +--- +title: Excel Export +page_title: Excel Export - TreeList Export Options - Kendo UI for Vue +description: "Export the Kendo UI TreeList wrapper for Vue to Excel." +slug: excelexport_treelist +position: 1 +--- + +# Excel Export + +The TreeList enables you to export its records to Excel. + +To enable the Excel export functionality, set the `excel` property. For example, you can specify the file name and enable filtering in the Excel file or other options. + +{% meta height:450 %} +{% embed_file export/excel/main.vue preview %} +{% embed_file export/excel/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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/pdf-export.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/pdf-export.md new file mode 100644 index 00000000..d6888e32 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/export/pdf-export.md @@ -0,0 +1,23 @@ +--- +title: PDF Export +page_title: PDF Export - TreeList Export Options - Kendo UI for Vue +description: "Export the Kendo UI TreeList wrapper for Vue to PDF." +slug: pdfexport_treelist +position: 2 +--- + +# PDF Export + +The TreeList enables you to export its records to PDF. + +To enable the PDF export functionality, use the `pdf` attribute. For example, you can specify the file name and export all pages, margins, paper size, font, and so on. + +{% meta height:450 %} +{% embed_file export/pdf/main.vue preview %} +{% embed_file export/pdf/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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/index.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/index.md new file mode 100644 index 00000000..bae286f6 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/index.md @@ -0,0 +1,97 @@ +--- +title: Overview +page_title: TreeList Overview - Components - Kendo UI for Vue +description: "Get an overview of the features the Kendo UI TreeList delivers and use the component in Vue projects." +slug: overview_treelist_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/" +position: 0 +--- + +
+ +# TreeList Overview + +The TreeList enables you to display self-referencing tabular data and to sort, filter, and edit its data. + +It also shows a parent-child relation between the TreeList data items. + +The TreeList wrapper for Vue is a client-side wrapper for the [Kendo UI TreeList](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist) widget. + +
+ +## Basic Usage + +The following example demonstrates how to initialize the TreeList. + +{% meta height:380 %} +{% embed_file overview/basic-usage/main.vue preview %} +{% embed_file overview/basic-usage/main.js %} +{% endmeta %} + +## Installation + +To initialize the TreeList, either: + +* [Use the CDN service]({% slug using_cdn %}), or +* [Use Webpack](#toc-initializing-with-webpack). + +### Initializing with Webpack + +1. Install Kendo UI and add a theme. + + ```sh + npm install --save @progress/kendo-ui + npm install --save @progress/kendo-theme-default + ``` + +1. Install the Kendo UI TreeList package for Vue. + + ```sh + npm install --save @progress/kendo-treelist-vue-wrapper + ``` + +1. Import the Kendo UI packages to the App component. If you use the Kendo UI components more than once in your application, add all Kendo UI-related files to the `main.js` file. If you use the Kendo UI components once in your application, add the Kendo UI-related files the component where they will be referred. + + ```js-no-run + import '@progress/kendo-ui' // This will import the entire Kendo UI library + // As an alternative, you could import only the scripts that are used by a specific widget: + // import '@progress/kendo-ui/js/kendo.treelist' // Imports only the TreeList script and its dependencies + + import '@progress/kendo-theme-default/dist/all.css' + + import { TreeList, TreeListInstaller } from '@progress/kendo-treelist-vue-wrapper' + + Vue.use(TreeListInstaller) + + new Vue({ + el: '#app', + components: { + TreeList + } + }) + ``` + +## Functionality and Features + +* [Data binding]({% slug databinding_treelist_wrapper %}) +* [Editing]({% slug editing_treelist_wrapper %}) +* [Column features]({% slug columns_treelist_wrapper %}) +* [Dragging and dropping]({% slug drag_and_drop_treelist_wrapper %}) +* [Aggregates]({% slug aggregates_treelist_wrapper %}) +* [Excel export]({% slug excelexport_treelist %}) +* [PDF export]({% slug pdfexport_treelist %}) +* [Keyboard navigation]({% slug keyboard_navigation_treelist_wrapper %}) + +## Events + +The following example demonstrates basic TreeList events. You can subscribe to [all TreeList events](https://docs.telerik.com/kendo-ui/api/javascript/ui/treelist#events) by the handler name. + +{% meta height:380 %} +{% embed_file overview/events/main.vue preview %} +{% embed_file overview/events/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) diff --git a/vue-wrappers-documentation/kendo-treelist-vue-wrapper/keyboard-navigation.md b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/keyboard-navigation.md new file mode 100644 index 00000000..717fa75c --- /dev/null +++ b/vue-wrappers-documentation/kendo-treelist-vue-wrapper/keyboard-navigation.md @@ -0,0 +1,42 @@ +--- +title: Keyboard Navigation +page_title: Keyboard Navigation - TreeList - Kendo UI for Vue +description: "Explore the keyboard navigation options provided by the Kendo UI TreeList wrapper for Vue." +slug: keyboard_navigation_treelist_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treelist/keyboard-navigation/" +position: 7 +--- + +
+ +# Keyboard Navigation + +The keyboard navigation of the TreeList is always available. + +The data table of the TreeList supports the following keyboard shortcuts: + +|SHORTCUT | DESCRIPTION | +|:---|:---| +| `Arrow Keys` | Navigates between the cells.| +| `Space` | Selects the row with the currently highlighted cell. | +| `Ctrl`+`Space` |
  • Selects or deselects the current row.
  • Persists the previously selected rows.
| +| `Shift`+`Space` |
  • Performs range selection.
  • Selects all rows between the last selected one.
| +| `Shift`+`Arrow Keys` | Adds the row of the focused cell to the selection. | +| `Enter` or `F2` | Sets the item in edit mode. If pressed on a command column, the shortcut focuses the first focusable element inside it. | +| `Esc` | Cancels the edit or, if an element inside a cell is focused, returns the focus to the table. | +| `Alt`+`Right Arrow`| Expands the current item. | +| `Alt`+`Left Arrow` | Collapses the current item. | +| `Ctrl`+`Home` | Focuses the first focusable element inside the body. | +| `Ctrl`+`End` | Focuses the last focusable element inside the body. | +| `Home` | Focuses the first focusable cell in the row. | +| `End` | Focuses the last focusable cell in the row. | + +{% meta height:630 %} +{% embed_file keyboard-navigation/main.vue preview %} +{% embed_file keyboard-navigation/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) diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/api/TreeMap.md b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/api/TreeMap.md new file mode 100644 index 00000000..c452e541 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/api/TreeMap.md @@ -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`—The original data item for constructing the point. +* `text`—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. diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/api/index.md b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/api/index.md new file mode 100644 index 00000000..8af9070c --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/api/index.md @@ -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 %}) \ No newline at end of file diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/data-binding.md b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/data-binding.md new file mode 100644 index 00000000..bd9b7d97 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/data-binding.md @@ -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 +--- + +
+ +# 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) diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/data-binding/main.js b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/data-binding/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/data-binding/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/data-binding/main.vue b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/data-binding/main.vue new file mode 100644 index 00000000..ff3738b9 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/data-binding/main.vue @@ -0,0 +1,354 @@ + + + + diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/overview/main.js b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/overview/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/overview/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/overview/main.vue b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/overview/main.vue new file mode 100644 index 00000000..14aaa108 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/examples/overview/main.vue @@ -0,0 +1,354 @@ + + + + diff --git a/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/index.md b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/index.md new file mode 100644 index 00000000..06de3ea4 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treemap-vue-wrapper/docs/index.md @@ -0,0 +1,80 @@ +--- +title: Overview +page_title: Treemap Overview - Components - Kendo UI for Vue +description: "Get an overview of the features the Kendo UI TreeMap delivers and use the component in Vue projects." +slug: overview_treemap +position: 0 +--- + +
+ +# TreeMap Overview + +The TreeMap displays hierarchical data in a traditional tree structure. + +It also support various rendering types such us Squarified, Vertical, and Horizontal (slice and dice algorithm). + +The TreeMap wrapper for Vue is a client-side wrapper for the [Kendo UI TreeMap](https://docs.telerik.com/kendo-ui/controls/charts/treemap/overview) widget. + +
+ +## Basic Usage + +The following example demonstrates how to initialize the TreeMap. + +{% meta height:460 %} +{% embed_file overview/main.vue preview %} +{% embed_file overview/main.js %} +{% endmeta %} + +## Installation + +To initialize the TreeMap, either: + +* [Use the CDN service]({% slug using_cdn %}), or +* [Use Webpack](#toc-initializing-with-webpack). + +### Initializing with Webpack + +1. Install Kendo UI and add a theme. + + ```sh + npm install --save @progress/kendo-ui + npm install --save @progress/kendo-theme-default + ``` + +1. Install the Kendo UI TreeMap package for Vue. + + ```sh + npm install --save @progress/kendo-treemap-vue-wrapper + ``` + +1. Import the Kendo UI packages to the App component. If you use the Kendo UI components more than once in your application, add all Kendo UI-related files to the `main.js` file. If you use the Kendo UI components once in your application, add the Kendo UI-related files the component where they will be referred. + + ```js-no-run + import '@progress/kendo-ui' // This will import the entire Kendo UI library + // As an alternative, you could import only the scripts that are used by a specific widget: + // import '@progress/kendo-ui/js/kendo.dataviz.treemap' // Imports only the TreeMap script and its dependencies + + import '@progress/kendo-theme-default/dist/all.css' + + import { TreeMap, TreeMapInstaller } from '@progress/kendo-treemap-vue-wrapper' + + Vue.use(TreeMapInstaller) + + new Vue({ + el: '#app', + components: { + TreeMap + } + }) + ``` + +## Functionality and Features + +The TreeMap supports [data binding]({% slug databinding_treemap %}). + +## Suggested Links + +* [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) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/animation-effects.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/animation-effects.md new file mode 100644 index 00000000..a712ab41 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/animation-effects.md @@ -0,0 +1,24 @@ +--- +title: Animation Effects +page_title: Animation Effects - TreeView - Kendo UI for Vue +description: "Add animation effects to the Kendo UI TreeView wrapper for Vue." +slug: animation_effects_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/" +position: 3 +--- + +# Animation Effects + +The TreeView allows you to implement animation effects. + +The following example demonstrates how to set up animations to the TreeView. + +{% meta height:450 %} +{% embed_file animation/main.vue preview %} +{% embed_file animation/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/AnimationProps.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/AnimationProps.md new file mode 100644 index 00000000..6fb40da7 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/AnimationProps.md @@ -0,0 +1,46 @@ +--- +title: animationProps API +description: "API Index | animationProps" +api_reference: true +slug: api_treeview_animationprops_wrapper +--- + +# AnimationProps + +### animation-collapse `Boolean` + +The animation that will be played for collapsing items. + +### animation-collapse-duration `Number` + +The duration (in milliseconds) of the animation for the collapsing items. + +### animation-collapse-effects `String` + +A whitespace-delimited string of animation effects that are used when the nodes are collapsing. + +The supported effects are: + +* `fadeOut` +* `collapseVertical` + +### animation-expand `Boolean` + +The duration (in milliseconds) of the animation for the expanding items. + +### animation-expand-duration `Number` + +The duration (in milliseconds) of the animation when a node is expanded. + +### animation-expand-effects `String` + +A whitespace-delimited string of animation effects that are used when the nodes are expanding. + +The supported effects are: + +* `expandVertical` +* `fadeIn` + +## Suggested Links + +* [`Animation` in Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/animation) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/CheckboxesProps.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/CheckboxesProps.md new file mode 100644 index 00000000..ce3b179f --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/CheckboxesProps.md @@ -0,0 +1,29 @@ +--- +title: checkboxesProps API +description: "API Index | checkboxesProps" +api_reference: true +slug: api_treeview_checkboxesprops_wrapper +--- + +# CheckboxesProps + +### checkboxes-check-children `Boolean` + +Indicates whether the checkboxes of the child items will be checked when the user checks the checkbox of a parent item. Also enables the tri-state checkboxes of an indeterminate state. + +### checkboxes-name `String` + +The `name` attribute of the checkbox inputs which will be posted to the server. + +### checkboxes-template `String | Function` + +The template for rendering the checkboxes. Allows the posting of additional information next to the TreeView checkboxes. + +The template supports the following fields: + +* `item`—The data item of the specific node. +* `treeview`—The options of the TreeView. + +## Suggested Links + +* [`Checkboxes` in Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/checkboxes) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/MessagesProps.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/MessagesProps.md new file mode 100644 index 00000000..fcaa3dd7 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/MessagesProps.md @@ -0,0 +1,24 @@ +--- +title: messagesProps API +description: "API Index | messagesProps" +api_reference: true +slug: api_treeview_messagesprops_wrapper +--- + +# MessagesProps + +### messages-loading `String` + +The text message which will be displayed while the root-level items are loading. + +### messages-request-failed `String` + +The text message which will be displayed when an error occurs while fetching the content. + +### messages-retry `String` + +The text message which will be displayed in the **Retry** button. + +## Suggested Links + +* [`Messages` in Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/messages) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/TreeView.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/TreeView.md new file mode 100644 index 00000000..590f2aec --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/TreeView.md @@ -0,0 +1,134 @@ +--- +title: TreeView API +description: "API Index | TreeView" +api_reference: true +slug: api_treeviewcomponent_wrapper +--- + +# TreeView + +## Directive + +`kendo-treeview` + +## Child Components + +* [`kendo-treeview-item`]({% slug api_treeviewitemcomponent_wrapper %}) + +## Props + +### animation `Boolean | Object` + +A collection of visual animations that are displayed when TreeView items are expanded or collapsed through user interaction ([`animation` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/animation)). Setting `animation` to `false` disables all animations. The supported composite props are available in [`AnimationProps`]({% slug api_treeview_animationprops_wrapper %}). + +### auto-bind `Boolean` + +If `auto-bind` is set to `false`, the TreeView will not bind to the data source during initialization ([`autoBind` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/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 TreeView will bind to the data source that is specified in the configuration. + +### auto-scroll `Boolean` + +If `auto-scroll` is set to `true`, the TreeView will automatically scroll the containing element when the mouse or user finger is close to its top or bottom ([`autoScroll` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/autoscroll)). + +### checkboxes `Boolean | Object` + +If `checkboxes` is set to `true` or to an object, the TreeView renders checkboxes next to each node ([`checkboxes` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/checkboxes)). The supported composite props are available in [`CheckboxesProps`]({% slug api_treeview_checkboxesprops_wrapper %}). + +### data-image-url-field `String` + +The field of the data item that provides the image URL of the TreeView nodes ([`dataImageUrlField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/dataimageurlfield)). + +### data-source `Object | Array` + +The data source of the TreeView for rendering the nodes ([`dataSource` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/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 TreeView 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 TreeView will use that instance and will not initialize a new one. + +### data-sprite-css-class-field `String` + +The field of the data item that provides the sprite CSS class of the nodes ([`dataSpriteCssClassField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/dataspritecssclassfield)). If `data-sprite-css-class-field` is set to an array, each level uses either the field which is at the same index in the array or the last item in the array. + +### data-text-field `String | Array` + +The field of the data item that provides the textual content of the nodes ([`dataTextField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/datatextfield)). If `data-text-field` is set to an array, each level either uses the field which is at the same index in the array or the last item in the array. + +### data-url-field `String` + +The field of the data item that provides the URL of the node links ([`dataUrlField` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/dataurlfield)). + +### drag-and-drop `Boolean` + +If `drag-and-drop` is set to `false`, the dragging and dropping of the nodes is disabled ([`dragAndDrop` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/draganddrop)). + +### load-on-demand `Boolean` + +Indicates whether the child DataSources will be fetched lazily when the parent groups are expanded ([`loadOnDemand` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/loadondemand)). Setting `load-on-demand` to `false` loads all child DataSources at the time of initialization. + +### messages `Object` + +The text messages that are displayed in the TreeView ([`messages` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/messages)). Used for customization or localization of messages. The supported composite props are available in [`MessagesProps`]({% slug api_treeview_messagesprops_wrapper %}). + +### template `String | Function` + +The template for rendering each node ([`template` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/template)). + +## Events + +### change: `Function` + +Fires when the selection was changed either by the user or through the `select` method ([`change` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/change)). + +### check: `Function` + +(Available in internal builds as of 2014.2.828) Fires after the user checked or unchecked a checkbox ([`check` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/check)). If `checkChildren` is set to `true`, the `check` event is triggered after all checked states are updated. + +### collapse: `Function` + +Fires before a subgroup gets collapsed ([`collapse` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/collapse)). Can be cancelled. + +### databound: `Function` + +Fires after the `change` event of the data source was processed by adding or removing items ([`dataBound` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/databound)). + +### drag: `Function` + +Fires while a node is being dragged ([`drag` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/drag)). + +### dragend: `Function` + +Fires after a node was dropped ([`dragEnd` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/dragend)). + +### dragstart: `Function` + +Fires before the dragging of a node starts ([`dragStart` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/dragstart)) + +### drop: `Function` + +Fires while a node is being dropped ([`drop` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/drop)). + +### expand: `Function` + +Fires before a subgroup is expanded ([`expand` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/expand)). + +### navigate: `Function` + +Fires when the user moves the focus to another node ([`navigate` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/navigate)). + +### select: `Function` + +Fires when a node is being selected by the user ([`select` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/events/select)). Can be cancelled. + +## 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/treeview#methods). + +### kendoWidget + +##### returns + +Returns the Kendo UI TreeView instance. diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/TreeViewItem.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/TreeViewItem.md new file mode 100644 index 00000000..e9d38c21 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/TreeViewItem.md @@ -0,0 +1,66 @@ +--- +title: TreeViewItem API +description: "API Index | TreeViewItem" +api_reference: true +slug: api_treeviewitemcomponent_wrapper +--- + +# TreeViewItem + +## Directive + +`kendo-treeview-item` + +## Parent Components + +* [`kendo-treeview`]({% slug api_treeviewcomponent_wrapper %}) + +## Child Components + +You can nest `kendo-treeview-item` components instead of binding the `items` prop to an array of items. + +## Props + +### text `String` + +The text of the item. + +### css-class `String` + +Adds a custom CSS class to the item. + +### url `String` + +Links a URL if navigation is needed. + +### encoded `Boolean` + +Allows the use of HTML for the item text. + +### content `String` + +The content within an item. + +### content-url `Object` + +The URL from which the content will be fetched. + +### image-url `String` + +The URL of the item image. + +### items `Array` + +A collection of sub-items. + +### expanded `Boolean` + +Defines whether the item will be expanded or not. + +### sprite-css-class `String` + +The sprite CSS class of the item image. + +## Suggested Links + +* [`dataSource` in Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview/configuration/datasource) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/index.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/index.md new file mode 100644 index 00000000..75e3ed58 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/api/index.md @@ -0,0 +1,16 @@ +--- +title: TreeView API +page_title: TreeView API - Components - Kendo UI for Vue +description: "List of API members in the @progress/kendo-treeview-vue-wrapper package, part of Kendo UI for Vue." +slug: api_treeview_wrapper +api_reference: true +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/api/" +position: 1 +--- + +# TreeView API + +## Components + +* [`kendo-treeview`]({% slug api_treeviewcomponent_wrapper %}) +* [`kendo-treeview-item`]({% slug api_treeviewitemcomponent_wrapper %}) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/checkboxes.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/checkboxes.md new file mode 100644 index 00000000..86afb4bb --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/checkboxes.md @@ -0,0 +1,26 @@ +--- +title: Checkboxes +page_title: Checkboxes TreeView - TreeView - Kendo UI for Vue +description: "Implement checkboxes in the Kendo UI TreeView wrapper for Vue." +slug: checkboxes_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/checkboxes/" +position: 5 +--- + +
+ +# Checkboxes + +The TreeView provides options for rendering checkboxes. + +To enable the checkboxes, set the `:checkboxes="true"` property or configure any of the `checkoxes` composite options such as `:checkboxes-check-children`, `:checkboxes-name`, or `:checkboxes-template`. + +{% meta height:520 %} +{% embed_file checkboxes/main.vue preview %} +{% embed_file checkboxes/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/data-binding.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/data-binding.md new file mode 100644 index 00000000..a1de5894 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/data-binding.md @@ -0,0 +1,70 @@ +--- +title: Data Binding +page_title: Data Binding - TreeView - Kendo UI for Vue +description: "Bind the Kendo UI TreeView wrapper for Vue to local data arrays or remote data services." +slug: databinding_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/data-binding/" +position: 1 +--- + +
+ +# Data Binding + +The TreeView provides support for binding it to [local data arrays](#toc-binding-to-local-data-arrays) and to [remote data services](#toc-binding-to-remote-data-services). + +## Binding to Local Data Arrays + +The TreeView enables you to bind it to: +* [Simple local data](#toc-simple-local-data-binding) +* [Complex local data](#toc-complex-local-data-binding) + +### Simple Local Data Binding + +The following example demonstrates how to create and bind the TreeView to a simple local data source. + +{% meta height:450 %} +{% embed_file data-binding/local-simple/main.vue preview %} +{% embed_file data-binding/local-simple/main.js %} +{% endmeta %} + +### Complex Local Data Binding + +The following example demonstrates how to create and bind the TreeView to a complex local data source. + +{% meta height:450 %} +{% embed_file data-binding/local-complex/main.vue preview %} +{% embed_file data-binding/local-complex/main.js %} +{% endmeta %} + +## Binding to Remote Data Services + +You can bind the TreeView to a remote dataset by either: +* [Using the HierarchicalDataSource component](#toc-using-the-hierarchicaldatasource-component), or +* [Using the `data` method](#toc-using-the-data-method). + +### Using the HierarchicalDataSource Component + +The following example demonstrates how to bind the TreeView to a [HierarchicalDataSource component]({% slug overview_hierarchicaldatasource %}). + +{% meta height:450 %} +{% embed_file data-binding/remote/main.vue preview %} +{% embed_file data-binding/remote/main.js %} +{% endmeta %} + + +### Using the data Method + +The following example demonstrates how to bind the TreeView to remote data by using the `data` method. + +{% meta height:450 %} +{% embed_file data-binding/data-method/main.vue preview %} +{% embed_file data-binding/data-method/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI HierarchicalDataSource Component for Vue]({% slug overview_hierarchicaldatasource %}) +* [Kendo UI DataSource Component](https://docs.telerik.com/kendo-ui/api/javascript/data/datasource) +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/drag-and-drop.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/drag-and-drop.md new file mode 100644 index 00000000..bee9cff1 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/drag-and-drop.md @@ -0,0 +1,26 @@ +--- +title: Dragging and Dropping +page_title: Dragging and Dropping - TreeView - Kendo UI for Vue +description: "Drag and drop items in the Kendo UI TreeView wrapper for Vue." +slug: draganddrop_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/drag-drop/" +position: 2 +--- + +
+ +# Dragging and Dropping + +The TreeView enables you to implement the drag-and-drop functionality for its items. + +The following example demonstrates how to enable the dragging and dropping by using the `drag-and-drop` property. + +{% meta height:665 %} +{% embed_file dragging-and-dropping/main.vue preview %} +{% embed_file dragging-and-dropping/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/animation/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/animation/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/animation/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/animation/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/animation/main.vue new file mode 100644 index 00000000..47ef132a --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/animation/main.vue @@ -0,0 +1,72 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/checkboxes/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/checkboxes/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/checkboxes/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/checkboxes/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/checkboxes/main.vue new file mode 100644 index 00000000..0b9b2859 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/checkboxes/main.vue @@ -0,0 +1,96 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/data-method/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/data-method/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/data-method/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/data-method/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/data-method/main.vue new file mode 100644 index 00000000..5812a837 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/data-method/main.vue @@ -0,0 +1,37 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-complex/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-complex/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-complex/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-complex/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-complex/main.vue new file mode 100644 index 00000000..6cc843fb --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-complex/main.vue @@ -0,0 +1,47 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-simple/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-simple/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-simple/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-simple/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-simple/main.vue new file mode 100644 index 00000000..5571a2fa --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/local-simple/main.vue @@ -0,0 +1,41 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/remote/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/remote/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/remote/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/remote/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/remote/main.vue new file mode 100644 index 00000000..255036a7 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/data-binding/remote/main.vue @@ -0,0 +1,25 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/dragging-and-dropping/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/dragging-and-dropping/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/dragging-and-dropping/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/dragging-and-dropping/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/dragging-and-dropping/main.vue new file mode 100644 index 00000000..d018cfff --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/dragging-and-dropping/main.vue @@ -0,0 +1,58 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/images/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/images/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/images/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/images/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/images/main.vue new file mode 100644 index 00000000..921f93f5 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/images/main.vue @@ -0,0 +1,41 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/sprite/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/sprite/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/sprite/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/sprite/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/sprite/main.vue new file mode 100644 index 00000000..7aeecc17 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/icons/sprite/main.vue @@ -0,0 +1,54 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/keyboard-navigation/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/keyboard-navigation/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/keyboard-navigation/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/keyboard-navigation/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/keyboard-navigation/main.vue new file mode 100644 index 00000000..9a067070 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/keyboard-navigation/main.vue @@ -0,0 +1,68 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/basic-usage/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/basic-usage/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/basic-usage/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/basic-usage/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/basic-usage/main.vue new file mode 100644 index 00000000..0b8b44b4 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/basic-usage/main.vue @@ -0,0 +1,48 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/events/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/events/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/events/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/events/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/events/main.vue new file mode 100644 index 00000000..0456cba7 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/overview/events/main.vue @@ -0,0 +1,74 @@ + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/rtl/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/rtl/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/rtl/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/rtl/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/rtl/main.vue new file mode 100644 index 00000000..731bd419 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/rtl/main.vue @@ -0,0 +1,60 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/templates/main.js b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/templates/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/templates/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/templates/main.vue b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/templates/main.vue new file mode 100644 index 00000000..b8a30c6b --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/examples/templates/main.vue @@ -0,0 +1,74 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/icons.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/icons.md new file mode 100644 index 00000000..4ee110d9 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/icons.md @@ -0,0 +1,33 @@ +--- +title: Icons +page_title: Icons - TreeView - Kendo UI for Vue +description: "Add images or predefined and custom icons to the Kendo UI TreeView wrapper for Vue." +slug: icons_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/custom-rendering/" +position: 4 +--- + +
+ +# Icons + +You can enhance the meaning of the context by adding an icon to the Button either through the `image-url` option or `sprite-css-class` attributes. + +The following example demonstrates how to create a TreeView with images. + +{% meta height:450 %} +{% embed_file icons/images/main.vue preview %} +{% embed_file icons/images/main.js %} +{% endmeta %} + +The following example demonstrates how to create a TreeView with sprites. + +{% meta height:450 %} +{% embed_file icons/sprite/main.vue preview %} +{% embed_file icons/sprite/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/index.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/index.md new file mode 100644 index 00000000..bce54148 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/index.md @@ -0,0 +1,100 @@ +--- +title: Overview +page_title: TreeView Overview - Components - Kendo UI for Vue +description: "Get an overview of the features the Kendo UI TreeView wrapper for Vue delivers and use the component in Vue projects." +slug: overview_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/" +position: 0 +--- + +
+ + +# TreeView Overview + +The TreeView displays hierarchical data in a traditional tree structure. + +It supports user interaction through mouse or touch events and performs re-ordering operations by using the drag-and-drop functionality. + +The TreeView wrapper for Vue is a client-side wrapper for the [Kendo UI TreeView](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) widget. + +
+ +## Basic Usage + +The following example demonstrates how to initialize the TreeView. + +{% meta height:470 %} +{% embed_file overview/basic-usage/main.vue preview %} +{% embed_file overview/basic-usage/main.js %} +{% endmeta %} + +## Installation + +To initialize the TreeView, either: + +* [Use the CDN service]({% slug using_cdn %}), or +* [Use Webpack](#toc-initializing-with-webpack). + +### Initializing with Webpack + +1. Install Kendo UI and add a theme. + + ```sh + npm install --save @progress/kendo-ui + npm install --save @progress/kendo-theme-default + ``` + +1. Install the Kendo UI TreeView package for Vue. + + ```sh + npm install --save @progress/kendo-treeview-vue-wrapper + ``` + +1. Import the Kendo UI packages to the App component. If you use the Kendo UI components more than once in your application, add all Kendo UI-related files to the `main.js` file. If you use the Kendo UI components once in your application, add the Kendo UI-related files the component where they will be referred. + + ```js-no-run + import '@progress/kendo-ui' // This will import the entire Kendo UI library + // As an alternative, you could import only the scripts that are used by a specific widget: + // import '@progress/kendo-ui/js/kendo.treeview' // Imports only the TreeView script and its dependencies + + import '@progress/kendo-theme-default/dist/all.css' + + import { TreeView, + TreeViewItem, + TreeViewInstaller } from '@progress/kendo-treeview-vue-wrapper' + + Vue.use(TreeViewInstaller) + + new Vue({ + el: '#app', + components: { + TreeView + } + }) + ``` + +## Functionality and Features + +* [Data binding]({% slug databinding_treeview_wrapper %}) +* [Dragging and dropping]({% slug draganddrop_treeview_wrapper %}) +* [Animation effects]({% slug animation_effects_treeview_wrapper %}) +* [Icons in TreeView]({% slug icons_treeview_wrapper %}) +* [Checkboxes]({% slug checkboxes_treeview_wrapper %}) +* [Templates]({% slug templates_treeview_wrapper %}) +* [Keyboard navigation]({% slug keyboard_navigation_treeview_wrapper %}) +* [RTL support]({% slug rtl_treeview_wrapper %}) + +## Events + +The following example demonstrates basic TreeView events. You can subscribe to [all TreeView events](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview#events) by the handler name. + +{% meta height:450 %} +{% embed_file overview/events/main.vue preview %} +{% embed_file overview/events/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/keyboard-navigation.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/keyboard-navigation.md new file mode 100644 index 00000000..4629e31e --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/keyboard-navigation.md @@ -0,0 +1,38 @@ +--- +title: Keyboard Navigation +page_title: Keyboard Navigation - TreeView - Kendo UI for Vue +description: "Explore the keyboard navigation options provided by the Kendo UI TreeView wrapper for Vue." +slug: keyboard_navigation_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/keyboard-navigation/" +position: 7 +--- + +
+ + +# Keyboard Navigation + +The keyboard navigation of the TreeView is always available. + +The TreeView supports the following keyboard shortcuts: + +| SHORTCUT | DESCRIPTION | +|:--- |:--- | +|`Alt`+`w` | If an item is focused, highlights the previous item. | +|`Up Arrow` | Highlights the previous item. | +|`Left Arrow` | Collapses the item. | +|`Down Arrow` | Highlights the next item. | +|`Right Arrow` | Expands the item. | +|`Home` | Highlights the first item in the list. | +|`End` | Highlights the last item in the list. | +|`Enter` | Selects the highlighted item. | + +{% meta height:600 %} +{% embed_file keyboard-navigation/main.vue preview %} +{% embed_file keyboard-navigation/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/rtl-support.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/rtl-support.md new file mode 100644 index 00000000..6ca16798 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/rtl-support.md @@ -0,0 +1,25 @@ +--- +title: RTL Support +page_title: RTL Support - TreeView - Kendo UI for Vue +description: "Explore the RTL support provided by the Kendo UI TreeView wrapper for Vue." +slug: rtl_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/" +position: 8 +--- + +
+ +# RTL Support + +You can activate the right-to-left functionality by adding the `k-rtl` class to the container of the TreeView. + +The following example demonstrates how to utilize the RTL support for the TreeView. + +{% meta height:600 %} +{% embed_file rtl/main.vue preview %} +{% embed_file rtl/main.js %} +{% endmeta %} +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-treeview-vue-wrapper/templates.md b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/templates.md new file mode 100644 index 00000000..2e9b5d88 --- /dev/null +++ b/vue-wrappers-documentation/kendo-treeview-vue-wrapper/templates.md @@ -0,0 +1,26 @@ +--- +title: Templates +page_title: Templates - TreeView - Kendo UI for Vue +description: "Use templates and customize the Kendo UI TreeView wrapper for Vue." +slug: templates_treeview_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/treeview/custom-rendering/" +position: 6 +--- + +
+ +# Templates + +The TreeView enables you to customize its content by using templates. + +The following example demonstrates how to create custom templates for the TreeView nodes. + +{% meta height:600 %} +{% embed_file templates/main.vue preview %} +{% embed_file templates/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI TreeView for jQuery](https://docs.telerik.com/kendo-ui/controls/navigation/treeview/overview) +* [API Reference of the TreeView Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/treeview) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/AsyncProps.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/AsyncProps.md new file mode 100644 index 00000000..d7dbcd2c --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/AsyncProps.md @@ -0,0 +1,76 @@ +--- +title: asyncProps API +description: "API Index | asyncProps" +api_reference: true +slug: api_upload_asyncprops_wrapper +--- + +# AsyncProps + +### async-auto-upload `Boolean` + +By default, the selected files are uploaded immediately. To avoid the automatic upload of selected files, set `async-auto-upload` to `false`. + +### async-batch `Boolean` + +By default and if supported by the browser, the selected files are uploaded in separate requests. To avoid the upload of selected files in separate requests, set `async-batch` to `true`. As a result, all selected files are uploaded in one request. The batch mode applies to multiple files which are selected simultaneously. Files that are selected one after the other are uploaded in separate requests. + +### async-chunk-size `Number` + +When `async-chunk-size` is set, the selected files are uploaded chunk by chunk with the declared size. Each request sends a separate file blob and additional string metadata to the server. + +The string metadata that is sent to the server is in a stringified JSON format and contains the following properties: + +* `fileName` +* `relativePath` +* `chunkIndex` +* `contentType` +* `totalFileSize` +* `totalChunks` +* `uploadUid` + +These properties enable the validation and combination of the file on the server side. The response also returns a JSON object with the uploaded and `fileUid` properties and notifies the client what the next chunk is. + +### async-concurrent `Boolean` + +By default, the selected files are uploaded one after the other. When `async-concurrent` is set to `true`, all selected files start to upload simultaneously. + +### async-auto-retry-after `Number` + +If `async-auto-retry-after` is set, the failed upload request is repeated after the declared amount of time (in milliseconds). + +### async-max-auto-retries `Number` + +The maximum number of attempts that are performed if an upload fails. + +### async-remove-field `String` + +The name of the `form` field that is submitted to `removeUrl`. + +### async-remove-url `String` + +The URL of the handler which is responsible for the removal of the uploaded files (if any). The handler must accept `POST` requests with one or more `fileNames` fields which specify the files that will be deleted. + +### async-remove-verb `String` + +The HTTP verb that will be used by the `remove` action. + +### async-save-field `String` + +The name of the `form` field which is submitted to `saveUrl`. Defaults to the input name. + +### async-save-url `String` + +The URL of the handler that will receive the submitted files. The handler must accept `POST` requests which contain one or more fields with the same name as the original input name. + +### async-use-array-buffer `Boolean` + +By default, the files are uploaded as file data. When `async-use-array-buffer` is set to `true`, the files are read as a file buffer by using `FileReader`. This buffer is sent in the request body. + +### async-with-credentials `Boolean` + +Controls whether to send credentials (cookies, headers) for cross-site requests. + +## Suggested Links + +* [`Async` in Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/async) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/FilesProps.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/FilesProps.md new file mode 100644 index 00000000..b056ec06 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/FilesProps.md @@ -0,0 +1,24 @@ +--- +title: filesProps API +description: "API Index | filesProps" +api_reference: true +slug: api_upload_filesprops_wrapper +--- + +# FilesProps + +### files-file-extension `String` + +The extension of the initial file. + +### files-file-name `String` + +The name of the initial file. + +### files-file-size `Number` + +The size of the initial file. + +## Suggested Links + +* [`Files` in Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/files) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/LocalizationProps.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/LocalizationProps.md new file mode 100644 index 00000000..18387f7f --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/LocalizationProps.md @@ -0,0 +1,76 @@ +--- +title: localizationProps API +description: "API Index | localizationProps" +api_reference: true +slug: api_upload_localizationprops_wrapper +--- + +# LocalizationProps + +### localization-cancel `String` + +The text of the **Cancel** button. + +### localization-clear-selected-files `String` + +The text of the **Clear** button. + +### localization-drop-files-here `String` + +The hint of the drop zone. + +### localization-header-status-uploaded `String` + +The status message of the header for the uploaded files. + +### localization-header-status-uploading `String` + +The status message of the header for the files which are in the process of upload. + +### localization-invalid-file-extension `String` + +The text of the validation message for an invalid file extension. + +### localization-invalid-files `String` + +The text of the validation messages for invalid files when the `batch` property is set to `true` and two or more files fail the validation. + +### localization-invalid-max-file-size `String` + +The text of the validation message for an invalid maximum file size. + +### localization-invalid-min-file-size `String` + +The text of the validation message for an invalid minimum file size. + +### localization-remove `String` + +The text of the **Remove** button. + +### localization-retry `String` + +The text of the **Retry** button. + +### localization-select `String` + +The text of the **Select...** button. + +### localization-status-failed `String` + +The status message for the failed uploads. + +### localization-status-uploaded `String` + +The status message for the successful uploads. + +### localization-status-uploading `String` + +The status message for the files which are in the process of upload. + +### localization-upload-selected-files `String` + +The text of the **Upload files** button. + +## Suggested Links + +* [`Localization` in Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/localization) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/Upload.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/Upload.md new file mode 100644 index 00000000..e4822c32 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/Upload.md @@ -0,0 +1,127 @@ +--- +title: Upload API +description: "API Index | Upload" +api_reference: true +slug: api_uploadcomponent_wrapper +--- + +# Upload + +## Directive + +`kendo-upload` + +## Props + +### async `Object` + +Configures the asynchronous upload of files ([`async` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/async)). The supported composite props are available in [`AsyncProps`]({% slug api_upload_asyncprops_wrapper %}). + +### directory `Boolean` + +Enables the selection of folders instead of files ([`directory` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/directory)). When the user selects a directory, its entire content hierarchy of files is included in the set of selected items. The `directory` setting is available only in browsers which support `webkitdirectory`. + +### directory-drop `Boolean` + +Enables the dropping of folders to the Upload and its drop zone ([`directoryDrop` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/directorydrop)). When the user drops a directory, its entire content hierarchy of files is included in the set of selected items. The `directoryDrop` setting is available only in browsers which support `DataTransferItem` and `webkitGetAsEntry`. + +### drop-zone `String` + +Based on a specific selector, initializes a `drop-zone` element which provides for the drag-and-drop file upload ([`dropZone` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/dropzone)). + +### enabled `Boolean` + +If `enabled` id set to `true`, the Upload is enabled ([`enabled` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/enabled)). To re-enable a disabled Upload, use `enable()`. + +### files `Array` + +The list of files that will be initially rendered in the file list of the Upload ([`files` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/files)). The supported composite props are available in [`FilesProps`]({% slug api_upload_filesprops_wrapper %}). + +Each `file` object in the array has to contain the following properties: + +* `name` +* `size` +* `extension` + +### localization `Object` + +Sets the strings that are rendered by the Upload ([`localization` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/localization)). The supported composite props are available in [`LocalizationProps`]({% slug api_upload_localizationprops_wrapper %}). + +### multiple `Boolean` + +* If `multiple` is set to `true`, the selection of multiple files is enabled ([`multiple` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/multiple)). +* If `multiple` is set to `false`, the user can select only one file at a time. + +### show-file-list `Boolean` + +If `show-file-list` is set to `true`, the display of a file listing for the file upload is enabled ([`showFileList` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/showfilelist)). The disabling of a file listing might be useful if you want to customize the UI. To build your own UI, use the client-side events. + +### template `String | Function` + +Sets a template for rendering the files in the file list ([`template` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/template)). + +The template data array consists of the following properties: + +* `name`—The name of the file. If used in the batch upload mode, `name` represents a comma-separated string combination of all file names. +* `size`—The file size (in bytes). If used in the batch upload mode, `size` represents the total file size. If not available, the value is `null`. +* `files`—An array which contains information about all selected files (name, size, and extension). + +### validation `Object` + +The validation options for the uploaded files ([`validation` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/validation)). The supported composite props are available in [`ValidationProps`]({% slug api_upload_validationprops_wrapper %}). + +## Events + +### cancel: `Function` + +Fires when the upload was cancelled while in progress ([`cancel` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/cancel)). + +### clear: `Function` + +Fires when the files are cleared through the **Clear** button ([`clear` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/clear)). + +### complete: `Function` + +Fires when all active uploads complete—either successfully or with errors ([`complete` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/complete)). + +### error: `Function` + +Fires when an upload or a `remove` operation fails ([`error` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/error)). + +### pause: `Function` + +Fires when the files are cleared through the **Pause** button ([`pause` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/pause)). The button is visible if `chunksize` is set. + +### progress: `Function` + +Fires when the data about the progress of the upload is available ([`progress` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/progress)). + +### resume: `Function` + +Fires when the files are resumed through the **Resume** button ([`resume` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/resume)). The button is visible if `chunksize` is set and the file upload is paused. + +### remove: `Function` + +Fires when an uploaded file is about to be removed ([`remove` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/remove)). If `remove` is canceled, the `remove` operation is prevented. + +### select: `Function` + +Fires when a file is selected ([`select` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/select)). + +### success: `Function` + +Fires when an upload or a `remove` operation is successfully completed ([`success` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/success)). + +### upload: `Function` + +Fires when one or more files are about to be uploaded ([`upload` in Kendo UI for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/events/upload)). The canceling of the `upload` event prevents the upload. + +## 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/upload#methods). + +### kendoWidget + +##### returns + +Returns the Kendo UI Upload instance. diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/ValidationProps.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/ValidationProps.md new file mode 100644 index 00000000..967ba448 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/ValidationProps.md @@ -0,0 +1,24 @@ +--- +title: validationProps API +description: "API Index | validationProps" +api_reference: true +slug: api_upload_validationprops_wrapper +--- + +# ValidationProps + +### validation-allowed-extensions `Array` + +A list of the file extensions which are allowed for upload. Recognizes entries of both `.type` and `type` values. + +### validation-max-file-size `Number` + +The maximum file size (in bytes) which is allowed for upload. + +### validation-min-file-size `Number` + +The minimum file size (in bytes) which is allowed for upload. + +## Suggested Links + +* [`Validation` in Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload/configuration/validation) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/index.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/index.md new file mode 100644 index 00000000..6c390230 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/api/index.md @@ -0,0 +1,15 @@ +--- +title: Upload API +page_title: Upload API - Components - Kendo UI for Vue +description: "List of API members in the @progress/kendo-upload-vue-wrapper package, part of Kendo UI for Vue." +slug: api_upload_wrapper +api_reference: true +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/api/" +position: 1 +--- + +# Upload API + +## Components + +* [`kendo-upload`]({% slug api_uploadcomponent_wrapper %}) \ No newline at end of file diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/chunk-upload.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/chunk-upload.md new file mode 100644 index 00000000..dc0da5a1 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/chunk-upload.md @@ -0,0 +1,26 @@ +--- +title: Chunk Upload +page_title: Chunk Upload - Upload - Kendo UI for Vue +description: "Upload files in chunks when working with the Kendo UI Upload wrapper in Vue projects." +slug: chunk_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/file-processing/" +position: 4 +--- + +
+ +# Chunk Upload + +The Upload enables you to upload chunks of files from local file systems to dedicated server handlers which are configured to receive them. + +To enable chunk upload, set the `async-chunk-side` property to `true`. Each request sends a separate file blob and additional string metadata to the server. This metadata is in a `stringified` JSON format and contains the `chunkIndex`, `contentType`, `totalFileSize`, `totalChunks`, and `uploadUid` properties. These properties enable the validation and combination of the files on the server. The response also returns a JSON object with the `uploaded` and `fileUid` properties which notify the client what the next chunk is. + +{% meta height:250 %} +{% embed_file chunk-upload/main.vue preview %} +{% embed_file chunk-upload/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/custom-drop-zone.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/custom-drop-zone.md new file mode 100644 index 00000000..ee43d995 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/custom-drop-zone.md @@ -0,0 +1,26 @@ +--- +title: Custom Drop Zone +page_title: Custom Drop Zone - Upload - Kendo UI for Vue +description: "Implement a custom drop zone when working with the Kendo UI Upload wrapper in Vue projects." +slug: custom_drop_zone_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/external-drop-zone/" +position: 6 +--- + +
+ +# Custom Drop Zone + +The Upload enables you to upload files from a specific page area after dragging and dropping them beforehand. + +To implement a custom drag zone, add a selector to the `drop-zone` property. + +{% meta height:450 %} +{% embed_file custom-drop-zone/main.vue preview %} +{% embed_file custom-drop-zone/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/directory-upload.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/directory-upload.md new file mode 100644 index 00000000..0f14170b --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/directory-upload.md @@ -0,0 +1,26 @@ +--- +title: Directory Upload +page_title: Directory Upload - Upload - Kendo UI for Vue +description: "Upload directories of files when working with the Kendo UI Upload wrapper in Vue projects." +slug: directory_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/" +position: 5 +--- + +
+ +# Directory Upload + +The Upload enables you to select and upload directories of files by drag-and-drop. + +> Only browsers which support HTML5 directory and `DataTransferItem` features provide support for the upload of file directories. + +{% meta height:250 %} +{% embed_file directory-upload/main.vue preview %} +{% embed_file directory-upload/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/chunk-upload/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/chunk-upload/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/chunk-upload/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/chunk-upload/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/chunk-upload/main.vue new file mode 100644 index 00000000..f115c403 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/chunk-upload/main.vue @@ -0,0 +1,50 @@ + + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/custom-drop-zone/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/custom-drop-zone/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/custom-drop-zone/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/custom-drop-zone/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/custom-drop-zone/main.vue new file mode 100644 index 00000000..99b78e7a --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/custom-drop-zone/main.vue @@ -0,0 +1,137 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/directory-upload/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/directory-upload/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/directory-upload/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/directory-upload/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/directory-upload/main.vue new file mode 100644 index 00000000..bf963299 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/directory-upload/main.vue @@ -0,0 +1,52 @@ + + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/initial-files/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/initial-files/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/initial-files/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/initial-files/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/initial-files/main.vue new file mode 100644 index 00000000..dcf3c456 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/initial-files/main.vue @@ -0,0 +1,53 @@ + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/overview/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/overview/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/overview/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/overview/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/overview/main.vue new file mode 100644 index 00000000..493c9548 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/overview/main.vue @@ -0,0 +1,40 @@ + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/rtl/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/rtl/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/rtl/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/rtl/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/rtl/main.vue new file mode 100644 index 00000000..13ab8d6d --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/rtl/main.vue @@ -0,0 +1,44 @@ + + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/templates/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/templates/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/templates/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/templates/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/templates/main.vue new file mode 100644 index 00000000..2014c354 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/templates/main.vue @@ -0,0 +1,104 @@ + + + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/validation/main.js b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/validation/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/validation/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/validation/main.vue b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/validation/main.vue new file mode 100644 index 00000000..acf711a9 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/examples/validation/main.vue @@ -0,0 +1,72 @@ + + + diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/index.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/index.md new file mode 100644 index 00000000..81bd4379 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/index.md @@ -0,0 +1,85 @@ +--- +title: Overview +page_title: Upload Overview - Components - Kendo UI for Vue +description: "Get an overview of the features the Kendo UI Upload wrapper for Vue delivers and use the component in Vue projects." +slug: overview_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/" +position: 0 +--- + +
+ +# Upload Overview + +The Upload helps users send files from local file systems to dedicated server handlers which are configured to receive them. + +The Upload wrapper for Vue is a client-side wrapper for the [Kendo UI Upload](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) widget. + +
+ +## Basic Usage + +The following example demonstrates how to initialize the Upload. + +{% meta height:250 %} +{% embed_file overview/main.vue preview %} +{% embed_file overview/main.js %} +{% endmeta %} + +## Installation + +To initialize the Upload, either: + +* [Use the CDN service]({% slug using_cdn %}), or +* [Use Webpack](#toc-initializing-with-webpack). + +### Initializing with Webpack + +1. Install Kendo UI and add a theme. + + ```sh + npm install --save @progress/kendo-ui + npm install --save @progress/kendo-theme-default + ``` + +1. Install the Kendo UI Upload package for Vue. + + ```sh + npm install --save @progress/kendo-upload-vue-wrapper + ``` + +1. Import the Kendo UI packages to the App component. If you use the Kendo UI components more than once in your application, add all Kendo UI-related files to the `main.js` file. If you use the Kendo UI components once in your application, add the Kendo UI-related files the component where they will be referred. + + ```js-no-run + import '@progress/kendo-ui' // This will import the entire Kendo UI library + // As an alternative, you could import only the scripts that are used by a specific widget: + // import '@progress/kendo-ui/js/kendo.upload' // Imports only the Upload script and its dependencies + + import '@progress/kendo-theme-default/dist/all.css' + + import { Upload, UploadInstaller } from '@progress/kendo-upload-vue-wrapper' + + Vue.use(UploadInstaller) + + new Vue({ + el: '#app', + components: { + Upload + } + }) + ``` + +## Functionality and Features + +* [Initial files]({% slug initial_files_upload_wrapper %}) +* [Validation]({% slug validation_upload_wrapper %}) +* [Templates]({% slug templates_upload_wrapper %}) +* [Chunk upload]({% slug chunk_upload_wrapper %}) +* [Directory upload]({% slug directory_upload_wrapper %}) +* [Custom drop zones]({% slug custom_drop_zone_wrapper %}) +* [RTL support]({% slug right_to_left_support_upload_wrapper %}) + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/initial-files.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/initial-files.md new file mode 100644 index 00000000..d7c13653 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/initial-files.md @@ -0,0 +1,25 @@ +--- +title: Initial Files +page_title: Initial Files - Upload - Kendo UI for Vue +description: "Define the files that will initially be rendered by the Kendo UI Upload wrapper for Vue." +slug: initial_files_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/file-processing/" +position: 1 +--- + +
+ +# Initial Files + +You can define the files that will be initially rendered by the Upload as selected. + +To configure the initial files, use the `files` property which accepts arrays of values and is available only when the Upload is in async mode. As a result, the files are displayed as uploaded successfully. + +{% meta height:350 %} +{% embed_file initial-files/main.vue preview %} +{% embed_file initial-files/main.js %} +{% endmeta %} +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/rtl-support.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/rtl-support.md new file mode 100644 index 00000000..85dce472 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/rtl-support.md @@ -0,0 +1,26 @@ +--- +title: RTL Support +page_title: RTL Support - Upload - Kendo UI for Vue +description: "Explore the RTL support provided by the Kendo UI Upload wrapper for Vue." +slug: right_to_left_support_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/globalization/" +position: 7 +--- + +
+ +# RTL Support + +You can activate the right-to-left functionality by adding the `k-rtl` class to the container of the Upload. + +The following example demonstrates how to utilize the RTL support for the Upload. + +{% meta height:350 %} +{% embed_file rtl/main.vue preview %} +{% embed_file rtl/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/templates.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/templates.md new file mode 100644 index 00000000..403608bc --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/templates.md @@ -0,0 +1,24 @@ +--- +title: Templates +page_title: Templates - Upload - Kendo UI for Vue +description: "Customize the upload by using templates when working with the Kendo UI Upload wrapper in Vue projects." +slug: templates_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/custom-rendering/" +position: 3 +--- + +
+ +# Templates + +The Upload provides options for customizing the uploaded files through templates. + +{% meta height:350 %} +{% embed_file templates/main.vue preview %} +{% embed_file templates/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-upload-vue-wrapper/validation.md b/vue-wrappers-documentation/kendo-upload-vue-wrapper/validation.md new file mode 100644 index 00000000..a466ae30 --- /dev/null +++ b/vue-wrappers-documentation/kendo-upload-vue-wrapper/validation.md @@ -0,0 +1,24 @@ +--- +title: Validation +page_title: Validation - Upload - Kendo UI for Vue +description: "Validate the upload of files when working with the Kendo UI Upload wrapper for Vue." +slug: validation_upload_wrapper +canonicalLink: "https://www.telerik.com/kendo-vue-ui/components/upload/restrictions/" +position: 2 +--- + +
+ +# Validation + +The Upload allows you to restrict the upload of files by setting requirements for file validation. + +{% meta height:550 %} +{% embed_file validation/main.vue preview %} +{% embed_file validation/main.js %} +{% endmeta %} + +## Suggested Links + +* [Kendo UI Upload for jQuery](https://docs.telerik.com/kendo-ui/controls/editors/upload/overview) +* [API Reference of the Upload Widget](https://docs.telerik.com/kendo-ui/api/javascript/ui/upload) diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/actions.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/actions.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/actions.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/actions.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/animation-effects.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/animation-effects.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/animation-effects.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/animation-effects.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/AnimationProps.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/AnimationProps.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/AnimationProps.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/AnimationProps.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/ContentProps.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/ContentProps.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/ContentProps.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/ContentProps.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/DraggableProps.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/DraggableProps.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/DraggableProps.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/DraggableProps.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/ModalProps.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/ModalProps.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/ModalProps.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/ModalProps.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/PositionProps.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/PositionProps.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/PositionProps.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/PositionProps.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/TitleProps.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/TitleProps.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/TitleProps.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/TitleProps.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/Window.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/Window.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/Window.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/Window.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/index.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/api/index.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/api/index.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/api/index.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/constrain-movement.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/constrain-movement.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/constrain-movement.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/constrain-movement.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/dimensions.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/dimensions.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/dimensions.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/dimensions.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/custom/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/custom/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/custom/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/custom/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/custom/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/custom/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/custom/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/predefined/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/predefined/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/predefined/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/predefined/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/predefined/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/actions/predefined/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/actions/predefined/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/ajax/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/ajax/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/ajax/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/ajax/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/ajax/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/ajax/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/ajax/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/animation/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/animation/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/animation/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/animation/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/animation/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/animation/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/animation/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/constrain/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/constrain/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/constrain/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/constrain/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/constrain/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/constrain/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/constrain/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/dimensions/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/dimensions/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/dimensions/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/dimensions/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/dimensions/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/dimensions/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/dimensions/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/keyboard-navigation/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/keyboard-navigation/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/keyboard-navigation/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/keyboard-navigation/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/keyboard-navigation/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/keyboard-navigation/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/keyboard-navigation/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/overview/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/overview/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/overview/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/overview/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/overview/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/overview/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/overview/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/position/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/position/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/position/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/position/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/position/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/position/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/position/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/rtl/main.js b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/rtl/main.js new file mode 100644 index 00000000..1f1c6c86 --- /dev/null +++ b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/rtl/main.js @@ -0,0 +1,5 @@ +import { createApp } from 'vue' +import App from './main.vue' + +createApp(App).mount('#app') + diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/rtl/main.vue b/vue-wrappers-documentation/kendo-window-vue-wrapper/examples/rtl/main.vue similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/examples/rtl/main.vue rename to vue-wrappers-documentation/kendo-window-vue-wrapper/examples/rtl/main.vue diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/index.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/index.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/index.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/index.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/keyboard-navigation.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/keyboard-navigation.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/keyboard-navigation.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/keyboard-navigation.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/loading-content-with-ajax.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/loading-content-with-ajax.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/loading-content-with-ajax.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/loading-content-with-ajax.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/position.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/position.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/position.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/position.md diff --git a/vue-wrappers-documentation/kendo-window-vue-wrapper/docs/rtl-support.md b/vue-wrappers-documentation/kendo-window-vue-wrapper/rtl-support.md similarity index 100% rename from vue-wrappers-documentation/kendo-window-vue-wrapper/docs/rtl-support.md rename to vue-wrappers-documentation/kendo-window-vue-wrapper/rtl-support.md