@scheels-softdev/kendoreact-generics 2.2.8 → 2.2.10

package/GenericDropdown.d.ts

@@ -3,17 +3,17 @@ import { CSSProperties } from "react";
  * 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.
+ * @prop {T[]} data - Array of data objects. (Tooltip: The data to populate the dropdown options.)
+ * @prop {number} [selectedId] - ID of the selected data object. (Tooltip: The ID of the currently selected item.)
+ * @prop {T} [selectedData] - The selected data object. Use this instead of selectedId if there is no identity key in the object. (Tooltip: The currently selected data object.)
+ * @prop {Function} onChange - Function to call when the selected value changes. (Tooltip: Callback function triggered when the selected value changes.)
+ * @prop {(keyof T)[]} textFields - Array of field names to use for text values. (Tooltip: The field names used to extract text values for display.)
+ * @prop {string} [separator] - Optional separator to use for concatenating text values. (Tooltip: The separator to use when concatenating multiple text values.)
+ * @prop {boolean} [disabled] - Boolean to disable the dropdown. (Tooltip: Determines whether the dropdown is disabled.)
+ * @prop {keyof T} [idField] - The field name to use as the identity key. If the id field to look at isn't 'id', what is it? (Tooltip: The field name used as the identity key.)
+ * @prop {string} [title] - The label of the dropdown. (Tooltip: The label displayed for the dropdown.)
+ * @prop {boolean} [hideClearButton] - Set to true if you want to hide the clear button. (Tooltip: Determines whether the clear button is hidden from the dropdown.)
+ * @prop {CSSProperties} [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. (Tooltip: Custom CSS properties for the component.)
  * @returns {JSX.Element}
  */
 export declare function GenericDropdown<T>({ data, selectedId, selectedData, onChange, textFields, separator, disabled, idField, title, hideClearButton, style, }: {

package/GenericDropdown.js

@@ -10,17 +10,17 @@ import { getTextValue } from "./Utility";
  * 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.
+ * @prop {T[]} data - Array of data objects. (Tooltip: The data to populate the dropdown options.)
+ * @prop {number} [selectedId] - ID of the selected data object. (Tooltip: The ID of the currently selected item.)
+ * @prop {T} [selectedData] - The selected data object. Use this instead of selectedId if there is no identity key in the object. (Tooltip: The currently selected data object.)
+ * @prop {Function} onChange - Function to call when the selected value changes. (Tooltip: Callback function triggered when the selected value changes.)
+ * @prop {(keyof T)[]} textFields - Array of field names to use for text values. (Tooltip: The field names used to extract text values for display.)
+ * @prop {string} [separator] - Optional separator to use for concatenating text values. (Tooltip: The separator to use when concatenating multiple text values.)
+ * @prop {boolean} [disabled] - Boolean to disable the dropdown. (Tooltip: Determines whether the dropdown is disabled.)
+ * @prop {keyof T} [idField] - The field name to use as the identity key. If the id field to look at isn't 'id', what is it? (Tooltip: The field name used as the identity key.)
+ * @prop {string} [title] - The label of the dropdown. (Tooltip: The label displayed for the dropdown.)
+ * @prop {boolean} [hideClearButton] - Set to true if you want to hide the clear button. (Tooltip: Determines whether the clear button is hidden from the dropdown.)
+ * @prop {CSSProperties} [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. (Tooltip: Custom CSS properties for the component.)
  * @returns {JSX.Element}
  */
 export function GenericDropdown({ data, selectedId, selectedData, onChange, textFields, separator, disabled, idField, title, hideClearButton, style, }) {

package/package.json

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