@progress/kendo-react-listbox 12.0.2-develop.1 → 12.0.2-develop.2

package/index.d.mts

@@ -19,13 +19,25 @@ declare const ListBox_2: React_2.ForwardRefExoticComponent<ListBoxProps & React_
 /** @hidden */
 declare type ListBox_2 = ListBoxHandle;
 
+/**
+ * The event that is triggered during drag operations on the ListBox.
+ */
 export declare interface ListBoxDragEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The data item involved in the drag operation.
+     */
     dataItem?: any;
 }
 
+/**
+ * The event that is triggered when a dragged element leaves the ListBox.
+ */
 declare interface ListBoxDragLeaveEvent extends BaseEvent<ListBox_2> {
 }
 
+/**
+ * The base event for ListBox operations.
+ */
 export declare interface ListBoxEvent extends BaseEvent<ListBox_2> {
 }
 
@@ -43,18 +55,39 @@ declare interface ListBoxHandle {
     props: ListBoxProps;
 }
 
+/**
+ * The event that is triggered when an item in the ListBox is clicked.
+ */
 export declare interface ListBoxItemClickEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The data item that was clicked.
+     */
     dataItem?: any;
 }
 
+/**
+ * The event that is triggered when a keyboard navigation action is performed.
+ */
 export declare interface ListBoxItemNavigateEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The name of the action that was performed.
+     */
     actionName?: string;
 }
 
+/**
+ * The event that is triggered when an item in the ListBox is selected.
+ */
 export declare interface ListBoxItemSelectEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The data item that was selected.
+     */
     dataItem?: any;
 }
 
+/**
+ * The event that is triggered when a key is pressed down over the ListBox.
+ */
 export declare interface ListBoxKeyDownEvent extends BaseEvent<ListBox_2> {
 }
 
@@ -116,7 +149,9 @@ export declare interface ListBoxProps {
      */
     data: Array<any>;
     /**
-     * Makes the items of the ListBox draggable. The items are draggable by default.
+     * Makes the items of the ListBox draggable.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -125,7 +160,7 @@ export declare interface ListBoxProps {
      */
     draggable?: boolean;
     /**
-     * Sets the selected field of the ListBox. Based on the value of this field, an item will be selected or not.
+     * Sets the selected field of the ListBox. Based on the value of this field, an item is selected or not.
      *
      * @example
      * ```jsx
@@ -143,7 +178,7 @@ export declare interface ListBoxProps {
      */
     textField: string;
     /**
-     * The field that will be used during form submission. Defaults to the `textField` if not set.
+     * The field that is used during form submission. Defaults to the `textField` if not set.
      *
      * @example
      * ```jsx
@@ -161,6 +196,8 @@ export declare interface ListBoxProps {
      * - `right` (Default)
      * - `none`
      *
+     * @default 'right'
+     *
      * @example
      * ```jsx
      * <ListBox toolbarPosition="top" />
@@ -206,7 +243,7 @@ export declare interface ListBoxProps {
      */
     onItemSelect?: (event: ListBoxItemSelectEvent) => void;
     /**
-     * Fires on keydown over the ListBox list items. It can be used to add extra keyboard navigation options.
+     * Fires on keydown over the ListBox list items. You can use it to add extra keyboard navigation options.
      *
      * @example
      * ```jsx
@@ -266,10 +303,19 @@ export declare const ListBoxToolbar: React_2.ForwardRefExoticComponent<ListBoxTo
 /** @hidden */
 export declare type ListBoxToolbar = ListBoxToolbarHandle;
 
+/**
+ * The event that is triggered when a tool in the ListBoxToolbar is clicked.
+ */
 export declare interface ListBoxToolbarClickEvent extends BaseEvent<ListBoxToolbar> {
+    /**
+     * The name of the tool that was clicked.
+     */
     toolName?: string;
 }
 
+/**
+ * The base event for ListBoxToolbar operations.
+ */
 declare interface ListBoxToolbarEvent extends BaseEvent<ListBoxToolbar> {
 }
 
@@ -338,7 +384,7 @@ export declare interface ListBoxToolbarProps {
 export declare const moveItem: (from: number, to: number, data: Array<any>) => any[];
 
 /**
- * Process the data collection/s based on the clicked ListBoxToolbar tool.
+ * Processes the data collections based on the clicked ListBoxToolbar tool.
  *
  * @param {T[]} listBoxOneData - The first data collection.
  * @param {T[]} listBoxTwoData - The second data collection. Pass an empty array if there is only one ListBox.
@@ -352,7 +398,7 @@ export declare const processListBoxData: (listBoxOneData: any[] | undefined, lis
 };
 
 /**
- * Process the data collection/s based on the dragged and drop item.
+ * Processes the data collections based on the dragged and dropped item.
  *
  * @param {T[]} listBoxOneData - The first data collection.
  * @param {T[]} listBoxTwoData - The second data collection. Pass an empty array if there is only one ListBox.
@@ -366,6 +412,9 @@ export declare const processListBoxDragAndDrop: (listBoxOneData: any[] | undefin
     listBoxTwoData: any[];
 };
 
+/**
+ * Defines the possible positions for the ListBox toolbar.
+ */
 declare enum toolbarPosition {
     TOP = "top",
     BOTTOM = "bottom",

package/index.d.ts

@@ -19,13 +19,25 @@ declare const ListBox_2: React_2.ForwardRefExoticComponent<ListBoxProps & React_
 /** @hidden */
 declare type ListBox_2 = ListBoxHandle;
 
+/**
+ * The event that is triggered during drag operations on the ListBox.
+ */
 export declare interface ListBoxDragEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The data item involved in the drag operation.
+     */
     dataItem?: any;
 }
 
+/**
+ * The event that is triggered when a dragged element leaves the ListBox.
+ */
 declare interface ListBoxDragLeaveEvent extends BaseEvent<ListBox_2> {
 }
 
+/**
+ * The base event for ListBox operations.
+ */
 export declare interface ListBoxEvent extends BaseEvent<ListBox_2> {
 }
 
@@ -43,18 +55,39 @@ declare interface ListBoxHandle {
     props: ListBoxProps;
 }
 
+/**
+ * The event that is triggered when an item in the ListBox is clicked.
+ */
 export declare interface ListBoxItemClickEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The data item that was clicked.
+     */
     dataItem?: any;
 }
 
+/**
+ * The event that is triggered when a keyboard navigation action is performed.
+ */
 export declare interface ListBoxItemNavigateEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The name of the action that was performed.
+     */
     actionName?: string;
 }
 
+/**
+ * The event that is triggered when an item in the ListBox is selected.
+ */
 export declare interface ListBoxItemSelectEvent extends BaseEvent<ListBox_2> {
+    /**
+     * The data item that was selected.
+     */
     dataItem?: any;
 }
 
+/**
+ * The event that is triggered when a key is pressed down over the ListBox.
+ */
 export declare interface ListBoxKeyDownEvent extends BaseEvent<ListBox_2> {
 }
 
@@ -116,7 +149,9 @@ export declare interface ListBoxProps {
      */
     data: Array<any>;
     /**
-     * Makes the items of the ListBox draggable. The items are draggable by default.
+     * Makes the items of the ListBox draggable.
+     *
+     * @default true
      *
      * @example
      * ```jsx
@@ -125,7 +160,7 @@ export declare interface ListBoxProps {
      */
     draggable?: boolean;
     /**
-     * Sets the selected field of the ListBox. Based on the value of this field, an item will be selected or not.
+     * Sets the selected field of the ListBox. Based on the value of this field, an item is selected or not.
      *
      * @example
      * ```jsx
@@ -143,7 +178,7 @@ export declare interface ListBoxProps {
      */
     textField: string;
     /**
-     * The field that will be used during form submission. Defaults to the `textField` if not set.
+     * The field that is used during form submission. Defaults to the `textField` if not set.
      *
      * @example
      * ```jsx
@@ -161,6 +196,8 @@ export declare interface ListBoxProps {
      * - `right` (Default)
      * - `none`
      *
+     * @default 'right'
+     *
      * @example
      * ```jsx
      * <ListBox toolbarPosition="top" />
@@ -206,7 +243,7 @@ export declare interface ListBoxProps {
      */
     onItemSelect?: (event: ListBoxItemSelectEvent) => void;
     /**
-     * Fires on keydown over the ListBox list items. It can be used to add extra keyboard navigation options.
+     * Fires on keydown over the ListBox list items. You can use it to add extra keyboard navigation options.
      *
      * @example
      * ```jsx
@@ -266,10 +303,19 @@ export declare const ListBoxToolbar: React_2.ForwardRefExoticComponent<ListBoxTo
 /** @hidden */
 export declare type ListBoxToolbar = ListBoxToolbarHandle;
 
+/**
+ * The event that is triggered when a tool in the ListBoxToolbar is clicked.
+ */
 export declare interface ListBoxToolbarClickEvent extends BaseEvent<ListBoxToolbar> {
+    /**
+     * The name of the tool that was clicked.
+     */
     toolName?: string;
 }
 
+/**
+ * The base event for ListBoxToolbar operations.
+ */
 declare interface ListBoxToolbarEvent extends BaseEvent<ListBoxToolbar> {
 }
 
@@ -338,7 +384,7 @@ export declare interface ListBoxToolbarProps {
 export declare const moveItem: (from: number, to: number, data: Array<any>) => any[];
 
 /**
- * Process the data collection/s based on the clicked ListBoxToolbar tool.
+ * Processes the data collections based on the clicked ListBoxToolbar tool.
  *
  * @param {T[]} listBoxOneData - The first data collection.
  * @param {T[]} listBoxTwoData - The second data collection. Pass an empty array if there is only one ListBox.
@@ -352,7 +398,7 @@ export declare const processListBoxData: (listBoxOneData: any[] | undefined, lis
 };
 
 /**
- * Process the data collection/s based on the dragged and drop item.
+ * Processes the data collections based on the dragged and dropped item.
  *
  * @param {T[]} listBoxOneData - The first data collection.
  * @param {T[]} listBoxTwoData - The second data collection. Pass an empty array if there is only one ListBox.
@@ -366,6 +412,9 @@ export declare const processListBoxDragAndDrop: (listBoxOneData: any[] | undefin
     listBoxTwoData: any[];
 };
 
+/**
+ * Defines the possible positions for the ListBox toolbar.
+ */
 declare enum toolbarPosition {
     TOP = "top",
     BOTTOM = "bottom",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-react-listbox",
-  "version": "12.0.2-develop.1",
+  "version": "12.0.2-develop.2",
   "description": "React ListBox enables you to display a list of items and manage the data between multiple lists. KendoReact ListBox package",
   "author": "Progress",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -26,9 +26,9 @@
   "sideEffects": false,
   "peerDependencies": {
     "@progress/kendo-licensing": "^1.7.0",
-    "@progress/kendo-react-buttons": "12.0.2-develop.1",
-    "@progress/kendo-react-common": "12.0.2-develop.1",
-    "@progress/kendo-react-intl": "12.0.2-develop.1",
+    "@progress/kendo-react-buttons": "12.0.2-develop.2",
+    "@progress/kendo-react-common": "12.0.2-develop.2",
+    "@progress/kendo-react-intl": "12.0.2-develop.2",
     "@progress/kendo-svg-icons": "^4.0.0",
     "react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
     "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"