-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feat]: Adapt ManageOrMemberComponent to new design with dynamic fiel…
…ds and combobox (#2988) * feat: adapt ManageOrMemberComponent to new design with dynamic fields and comboboxes * fix: cspell
- Loading branch information
1 parent
46aae43
commit 4d7bf5f
Showing
4 changed files
with
227 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
apps/web/lib/features/manual-time/manage-member-component.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| import { CustomCombobox } from "lib/components/combobox"; | ||
|
|
||
|
|
||
| /** | ||
| * Represents an item with dynamic properties. | ||
| * @interface Item | ||
| */ | ||
| export interface Item { | ||
| [key: string]: any; // Allows for dynamic properties | ||
| } | ||
|
|
||
| /** | ||
| * Props interface for the ManageOrMemberComponent component. | ||
| * @template T - The type of items in the component. | ||
| */ | ||
| interface ManageOrMemberComponentProps<T extends Item> { | ||
| /** | ||
| * An array of field definitions for the component. | ||
| * Each field specifies the label, placeholder, whether it's required, and keys for value and display. | ||
| * @type {Object[]} | ||
| * @property {string} label - The label for the field. | ||
| * @property {string} placeholder - The placeholder text for the field. | ||
| * @property {boolean} isRequired - Indicates if the field is required. | ||
| * @property {string} valueKey - The key to extract the value of the item. | ||
| * @property {string} displayKey - The key to extract the display value of the item. | ||
| */ | ||
| fields: { | ||
| label: string; | ||
| element: string, | ||
| placeholder: string; | ||
| isRequired: boolean; | ||
| valueKey: string; // Key for extracting the item's value | ||
| displayKey: string; // Key for extracting the item's display text | ||
| }[]; | ||
|
|
||
| /** | ||
| * A dictionary of item lists for each field. | ||
| * The key corresponds to the field label, and the value is an array of items or undefined. | ||
| * @type {Object.<string, T[] | undefined>} | ||
| */ | ||
| itemsLists: { [key: string]: T[] | undefined }; | ||
|
|
||
| /** | ||
| * A dictionary of currently selected values for each field. | ||
| * The key corresponds to the field label, and the value is the selected item or null. | ||
| * @type {Object.<string, T | null>} | ||
| */ | ||
| selectedValues: { [key: string]: T | null }; | ||
|
|
||
| /** | ||
| * Callback function to handle changes in selected values. | ||
| * @param {Object.<string, T | null>} values - The updated selected values for each field. | ||
| */ | ||
| onSelectedValuesChange: (values: { [key: string]: T | null }) => void; | ||
|
|
||
| /** | ||
| * Optional callback function to handle additional logic when a value changes. | ||
| * @param {string} field - The label of the field where the change occurred. | ||
| * @param {T | null} selectedItem - The newly selected item or null. | ||
| */ | ||
| handleChange?: (field: string, selectedItem: T | null) => void; | ||
|
|
||
| /** | ||
| * Function to convert an item to a display string based on the displayKey. | ||
| * @param {T | null} item - The item to convert. | ||
| * @param {string} displayKey - The key to extract the display text. | ||
| * @returns {string} - The display string for the item. | ||
| */ | ||
| itemToString: (item: T | null, displayKey: string) => string; | ||
|
|
||
| /** | ||
| * Function to convert an item to a value string based on the valueKey. | ||
| * @param {T | null} item - The item to convert. | ||
| * @param {string} valueKey - The key to extract the value. | ||
| * @returns {string} - The value string for the item. | ||
| */ | ||
| itemToValue: (item: T | null, valueKey: string) => string; | ||
| } | ||
|
|
||
| /** | ||
| * A React component that renders a set of fields with dynamic item lists and handles user selections. | ||
| * @template T - The type of items in the component. | ||
| * @param {ManageOrMemberComponentProps<T>} props - The props for the component. | ||
| * @returns {JSX.Element} - The rendered component. | ||
| */ | ||
| export const ManageOrMemberComponent = <T extends Item>({ | ||
| fields, | ||
| itemsLists, | ||
| selectedValues, | ||
| onSelectedValuesChange, | ||
| handleChange, | ||
| itemToString, | ||
| itemToValue, | ||
| }: ManageOrMemberComponentProps<T>): JSX.Element => { | ||
|
|
||
| /** | ||
| * Internal handler for value changes. | ||
| * Calls the external handleChange function if provided, and updates the selected values. | ||
| * @param {string} field - The label of the field where the change occurred. | ||
| * @param {T | null} selectedItem - The newly selected item or null. | ||
| */ | ||
| const handleInternalChange = (field: string, selectedItem: T | null) => { | ||
| if (handleChange) { | ||
| handleChange(field, selectedItem); | ||
| } | ||
| onSelectedValuesChange({ | ||
| ...selectedValues, | ||
| [field]: selectedItem, | ||
| }); | ||
| }; | ||
|
|
||
| return ( | ||
| <div> | ||
| {fields.map((field, index) => ( | ||
| <div key={index} className="mb-4"> | ||
| <label className="block text-gray-600 mb-1 text-sm"> | ||
| <span className="text-[14px]">{field.label}</span> | ||
| {field.isRequired && <span className="text-[#de5505e1] ml-1 text-sm">*</span>} | ||
| </label> | ||
| <CustomCombobox | ||
| popoverWidth='w-full' | ||
| buttonWidth='w-full' | ||
| itemToString={(item) => itemToString(item, field.displayKey)} | ||
| itemToValue={(item) => itemToValue(item, field.valueKey)} | ||
| items={itemsLists[field.element] || []} | ||
| onChangeValue={(selectedItem) => handleInternalChange(field.element, selectedItem)} | ||
| placeholder={field.placeholder} | ||
| selectedItem={selectedValues[field.element] || null} | ||
| /> | ||
| </div> | ||
| ))} | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
|
|
||
| export const getNestedValue = (obj: any, key: string) => { | ||
| return key.split('.').reduce((o, i) => o && o[i], obj); | ||
| }; |