@scheels-softdev/kendoreact-generics 2.2.11 → 2.4.0

package/FilterCellDropdown.d.ts

@@ -1,7 +1,10 @@
 import { GridFilterCellProps } from "@progress/kendo-react-grid";
 interface DropdownFilterCellProps<T> extends GridFilterCellProps {
+    /** The data to populate the dropdown options */
     data: T[];
+    /** The field names used to extract text values for display */
     textFields: (keyof T)[];
+    /** The separator to use when concatenating multiple text values */
     separator?: string;
 }
 export declare function FilterCellDropdown<T>(props: DropdownFilterCellProps<T>): import("react/jsx-runtime").JSX.Element;

package/GenericDropdown.d.ts

@@ -3,40 +3,29 @@ 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.
- * @prop {T[]} data - Array of data objects. (Tooltip: .)
- * @prop {number} [selectedId] - ID of the selected data object. (Tooltip:)
- * @prop {T} [selectedData] - The selected data object. Use this instead of selectedId if there is no identity key in the object. (Tooltip: )
- * @prop {Function} onChange - Function to call when the selected value changes. (Tooltip: .)
- * @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, }: {
-    /** The data to populate the dropdown options*/
+    /** The data to populate the dropdown options */
     data: T[];
-    /** The ID of the currently selected item.*/
+    /** The ID of the currently selected item. (optional)*/
     selectedId?: number;
-    /** The currently selected data object. */
+    /** The currently selected data object. (optional)*/
     selectedData?: T;
     /** Callback function triggered when the selected value changes*/
     onChange: Function;
-    /** The list of data to feed the dropdown */
+    /**  The field names used to extract text values for display */
     textFields: (keyof T)[];
-    /** The list of data to feed the dropdown */
+    /**  The separator to use when concatenating multiple text values. (optional)*/
     separator?: string;
-    /** The list of data to feed the dropdown */
+    /**  Determines whether the dropdown is disabled. (optional)*/
     idField?: keyof T;
-    /** The list of data to feed the dropdown */
+    /**  The field name used as the identity key (optional)*/
     disabled?: boolean;
-    /** The list of data to feed the dropdown */
+    /** The label displayed for the dropdown (optional)*/
     title?: string;
-    /** The list of data to feed the dropdown */
+    /** The Determines whether the clear button is hidden from the dropdown. (optional)*/
     hideClearButton?: boolean;
-    /** The list of data to feed the dropdown */
+    /** Custom CSS properties for the component. (optional)*/
     style?: CSSProperties;
 }): import("react/jsx-runtime").JSX.Element;

package/GenericDropdown.js

@@ -10,17 +10,6 @@ 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.
- * @prop {T[]} data - Array of data objects. (Tooltip: .)
- * @prop {number} [selectedId] - ID of the selected data object. (Tooltip:)
- * @prop {T} [selectedData] - The selected data object. Use this instead of selectedId if there is no identity key in the object. (Tooltip: )
- * @prop {Function} onChange - Function to call when the selected value changes. (Tooltip: .)
- * @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/MultiSelectDropdown.d.ts

@@ -1,9 +1,16 @@
 export declare function MultiSelectDropdown<T>({ data, selectedData, textFields, selectEvent, title, separator, limit, }: {
+    /** The data array for the dropdown options. */
     data: T[];
+    /** The array of selected data items. */
     selectedData: T[];
+    /** The field names to use for text values in the dropdown. */
     textFields: (keyof T)[];
+    /** The function to call when an item is selected or deselected. */
     selectEvent: Function;
+    /** The optional title of the dropdown. */
     title?: string;
+    /** The optional separator to use for concatenating text values. */
     separator?: string;
+    /** The optional limit of the maximum number of selected items. */
     limit?: number;
 }): import("react/jsx-runtime").JSX.Element;

package/Toolbar.d.ts

@@ -2,9 +2,12 @@ type CommonProps = {
     id: number;
     isEditing?: boolean;
 };
-export declare function ToolbarButton<T extends CommonProps>({ item, data, setData }: {
+export declare function ToolbarButton<T extends CommonProps>({ item, data, setData, }: {
+    /** The item object to add. */
     item: T;
+    /** The data array. */
     data: T[];
+    /** The function to set the updated data. */
     setData: Function;
 }): import("react/jsx-runtime").JSX.Element;
 export {};

package/Toolbar.js

@@ -1,4 +1,4 @@
 import { jsx as _jsx } from "react/jsx-runtime";
-export function ToolbarButton({ item, data, setData }) {
+export function ToolbarButton({ item, data, setData, }) {
     return (_jsx("button", Object.assign({ title: "Add new", className: "k-button k-button-md k-rounded-md k-button-solid k-button-solid-primary", onClick: () => setData([Object.assign(Object.assign({}, item), { isEditing: true, id: 0 }), ...data]), disabled: data.find((x) => x.isEditing) ? true : false }, { children: "Add Another" })));
 }

package/commandCell/CommandCellCheckbox.d.ts

@@ -1,5 +1,8 @@
-export declare function CommandCellCheckBox({ checked, onCheck, onUncheck }: {
+export declare function CommandCellCheckBox({ checked, onCheck, onUncheck, }: {
+    /** Boolean value indicating whether the checkbox is checked (`true`) or unchecked (`false`). */
     checked: boolean;
+    /** Callback function to be called when the checkbox is checked. */
     onCheck: Function;
+    /** Callback function to be called when the checkbox is unchecked. */
     onUncheck: Function;
 }): import("react/jsx-runtime").JSX.Element;

package/commandCell/CommandCellCheckbox.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Checkbox } from "@progress/kendo-react-inputs";
-export function CommandCellCheckBox({ checked, onCheck, onUncheck }) {
+export function CommandCellCheckBox({ checked, onCheck, onUncheck, }) {
     const functionToRun = () => {
         if (checked) {
             onUncheck();

package/commandCell/CommandCellDDWithoutId.d.ts

@@ -1,11 +1,19 @@
 import { ComboBoxChangeEvent } from "@progress/kendo-react-dropdowns";
 export declare function CommandCellDDWithoutId<T>(props: {
+    /** The data array for the dropdown options. */
     data: T[];
+    /** The currently selected data item. */
     selectedData: T;
+    /** The field names to use for text values in the dropdown. */
     textFields: (keyof T)[];
+    /** Callback function to be called when the selected value changes. */
     onChange: (e: ComboBoxChangeEvent) => void;
+    /** Optional separator to use for concatenating text values. */
     separator?: string;
+    /** Determines if the edit field should be checked. */
     checkEditField?: boolean;
+    /** Determines if the cell is in an editing state. */
     isEditing?: boolean;
+    /** Determines if the clear button should be displayed in the dropdown. */
     showClearButton?: boolean;
 }): import("react/jsx-runtime").JSX.Element;

package/commandCell/CommandCellDDWithoutId.js

@@ -1,6 +1,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { GenericDropdown } from "../GenericDropdown";
 export function CommandCellDDWithoutId(props) {
+    // Function implementation...
     return (_jsx("td", { children: props.checkEditField && !props.isEditing ? (props.textFields.map((x) => props.data.find((y) => y === props.selectedData)[x]).join(props.separator || " ")) : (
         // If "props.checkEditField" is false or "props.isEditing" is true, render the GenericDropdownWithSearch component with the "props" passed to it
         _jsx(GenericDropdown, Object.assign({}, props))) }));

package/commandCell/CommandCellDate.d.ts

@@ -1,6 +1,9 @@
 import { CommonProps, GridChangeEvent } from "../PropTypes";
-export declare function CommandCellDate<T extends CommonProps>({ dataItem, chgFn: changeFunction, field, }: {
+export declare function CommandCellDate<T extends CommonProps>({ dataItem, onChange, field, }: {
+    /** The data item for the cell. */
     dataItem: T;
-    chgFn: (e: GridChangeEvent) => void;
+    /** Callback function to be called when the value changes. */
+    onChange: (e: GridChangeEvent) => void;
+    /** The field of the data item to display in the cell. this field must be formattable into a date. */
     field: keyof T;
 }): import("react/jsx-runtime").JSX.Element;

package/commandCell/CommandCellDate.js

@@ -1,10 +1,10 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { DatePicker } from "@progress/kendo-react-dateinputs";
 import moment from "moment";
-export function CommandCellDate({ dataItem, chgFn: changeFunction, field, }) {
+export function CommandCellDate({ dataItem, onChange, field, }) {
     let valString = "" + dataItem[field];
     let date = moment(valString).format("MM/DD/YY");
-    return (_jsx("td", Object.assign({ "data-testid": "date" }, { children: valString === undefined || dataItem.isEditing ? (_jsx(DatePicker, { value: new Date(moment(valString).format("MMMM, DD YYYY")), onChange: (e) => changeFunction({
+    return (_jsx("td", Object.assign({ "data-testid": "date" }, { children: valString === undefined || dataItem.isEditing ? (_jsx(DatePicker, { value: new Date(moment(valString).format("MMMM, DD YYYY")), onChange: (e) => onChange({
                 field: field.toString(),
                 value: moment(e.value),
                 dataItem: dataItem,

package/commandCell/CommandCellDropdown.d.ts

@@ -1,12 +1,21 @@
 import { ComboBoxChangeEvent } from "@progress/kendo-react-dropdowns";
 export declare function CommandCellDropdown<T>(props: {
+    /** The data array for the dropdown options. */
     data: T[];
+    /** The ID of the currently selected item. */
     selectedId: number;
+    /** The field names to use for text values in the dropdown. */
     textFields: (keyof T)[];
+    /** Callback function to be called when the selected value changes. */
     onChange: (e: ComboBoxChangeEvent) => void;
+    /** Optional separator to use for concatenating text values. */
     separator?: string;
+    /** Determines if the edit field should be checked. */
     checkEditField?: boolean;
+    /** Determines if the cell is in an editing state. */
     isEditing?: boolean;
+    /** The field to use as the identity key. */
     idField?: keyof T;
+    /** Determines if the clear button should be displayed in the dropdown. */
     showClearButton?: boolean;
 }): import("react/jsx-runtime").JSX.Element;

package/commandCell/CommandCellSwitch.d.ts

@@ -1,5 +1,7 @@
 import { GridCellProps } from "@progress/kendo-react-grid";
-export declare function CommandCellSwitch({ props, changeFunction }: {
+export declare function CommandCellSwitch({ props, changeFunction, }: {
+    /** The GridCellProps object containing cell-related properties. */
     props: GridCellProps;
+    /** The function to call when the switch value changes. */
     changeFunction: Function;
 }): import("react/jsx-runtime").JSX.Element;

package/commandCell/CommandCellSwitch.js

@@ -1,5 +1,5 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Switch } from "@progress/kendo-react-inputs";
-export function CommandCellSwitch({ props, changeFunction }) {
+export function CommandCellSwitch({ props, changeFunction, }) {
     return (_jsx("td", Object.assign({ "data-testid": "switch" }, { children: props.dataItem.isEditing ? (_jsx(Switch, { onChange: () => changeFunction(), checked: props.dataItem[props.field] })) : (props.dataItem[props.field].toString()) })));
 }

package/package.json

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