@scheels-softdev/kendoreact-generics 2.2.6 → 2.2.8

package/GenericDropdown.d.ts

@@ -1,19 +1,20 @@
 import { CSSProperties } from "react";
 /**
- * JSX Component for displaying selected images in a fullscreen Modal
- * @param {object} props
- * @param {T[]} props.data array of data objects
- * @param {number} [props.selectedId] id of the selected data object
- * @param {T} [props.selectedData] if there is no identity key in the object and you need to compare the entire object, use this instead of selectedId
- * @param {Function} props.onChange function to call when the selected value changes
- * @param {(keyof T)[] } props.textFields array of field names to use for text values
- * @param {string} [props.separator] optional separator to use for concatenating text values
- * @param {object} [props.disabled] boolean to disable the dropdown
- * @param {keyof T} [props.idField] if the id field to look at isn't 'id', what is it?
- * @param {string} [props.title] the label of the dropdown
- * @param {boolean} [props.showClearButton] set to false if you want to hide clear button
- * @param {CSSProperties} [props.style] the CSS Properties you want to use. It is generally recommended to do styling in your App.css file but if necessary this prop is available to you
- * @returns
+ * JSX Component for displaying items in a virtualized combobox
+ * @template T - The type of the data objects in the dropdown.
+ * @param {object} props - The component props.
+ * @param {T[]} props.data - array of data objects.
+ * @param {number} [props.selectedId] - id of the selected data object.
+ * @param {T} [props.selectedData] - if there is no identity key in the object and you need to compare the entire object, use this instead of selectedId.
+ * @param {Function} props.onChange - function to call when the selected value changes.
+ * @param {(keyof T)[] } props.textFields - array of field names to use for text values.
+ * @param {string} [props.separator] - optional separator to use for concatenating text values.
+ * @param {object} [props.disabled] - boolean to disable the dropdown.
+ * @param {keyof T} [props.idField] - if the id field to look at isn't 'id', what is it?.
+ * @param {string} [props.title] - the label of the dropdown.
+ * @param {boolean} [props.showClearButton] - set to false if you want to hide clear button.
+ * @param {CSSProperties} [props.style] - the CSS Properties you want to use. It is generally recommended to do styling in your App.css file but if necessary this prop is available to you.
+ * @returns {JSX.Element}
  */
 export declare function GenericDropdown<T>({ data, selectedId, selectedData, onChange, textFields, separator, disabled, idField, title, hideClearButton, style, }: {
     data: T[];

package/GenericDropdown.js

@@ -7,20 +7,21 @@ import { getTextValue } from "./Utility";
 //TODO add metadata documentation
 // component that renders a dropdown with a search filter
 /**
- * JSX Component for displaying selected images in a fullscreen Modal
- * @param {object} props
- * @param {T[]} props.data array of data objects
- * @param {number} [props.selectedId] id of the selected data object
- * @param {T} [props.selectedData] if there is no identity key in the object and you need to compare the entire object, use this instead of selectedId
- * @param {Function} props.onChange function to call when the selected value changes
- * @param {(keyof T)[] } props.textFields array of field names to use for text values
- * @param {string} [props.separator] optional separator to use for concatenating text values
- * @param {object} [props.disabled] boolean to disable the dropdown
- * @param {keyof T} [props.idField] if the id field to look at isn't 'id', what is it?
- * @param {string} [props.title] the label of the dropdown
- * @param {boolean} [props.showClearButton] set to false if you want to hide clear button
- * @param {CSSProperties} [props.style] the CSS Properties you want to use. It is generally recommended to do styling in your App.css file but if necessary this prop is available to you
- * @returns
+ * JSX Component for displaying items in a virtualized combobox
+ * @template T - The type of the data objects in the dropdown.
+ * @param {object} props - The component props.
+ * @param {T[]} props.data - array of data objects.
+ * @param {number} [props.selectedId] - id of the selected data object.
+ * @param {T} [props.selectedData] - if there is no identity key in the object and you need to compare the entire object, use this instead of selectedId.
+ * @param {Function} props.onChange - function to call when the selected value changes.
+ * @param {(keyof T)[] } props.textFields - array of field names to use for text values.
+ * @param {string} [props.separator] - optional separator to use for concatenating text values.
+ * @param {object} [props.disabled] - boolean to disable the dropdown.
+ * @param {keyof T} [props.idField] - if the id field to look at isn't 'id', what is it?.
+ * @param {string} [props.title] - the label of the dropdown.
+ * @param {boolean} [props.showClearButton] - set to false if you want to hide clear button.
+ * @param {CSSProperties} [props.style] - the CSS Properties you want to use. It is generally recommended to do styling in your App.css file but if necessary this prop is available to you.
+ * @returns {JSX.Element}
  */
 export function GenericDropdown({ data, selectedId, selectedData, onChange, textFields, separator, disabled, idField, title, hideClearButton, style, }) {
     if (selectedId !== undefined && selectedData !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@scheels-softdev/kendoreact-generics",
-    "version": "2.2.6",
+    "version": "2.2.8",
     "main": "index.js",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",