-
Notifications
You must be signed in to change notification settings - Fork 0
[Component] SelectBox #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: nextjs-tailwind
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,381 @@ | ||
| import React, { | ||
| useState, | ||
| useRef, | ||
| useEffect, | ||
| useMemo, | ||
| useCallback, | ||
| } from "react"; | ||
| import { ChevronDownIcon as ChevronDown } from '@heroicons/react/24/solid'; | ||
| import Chip from "./Chip"; | ||
|
|
||
|
|
||
| //flat options | ||
| interface Option { | ||
| label: string; | ||
| value: string; | ||
| type?: "standard"; | ||
| status?: "passed" | "failed" | "pending"; | ||
| } | ||
|
|
||
| //Group of options | ||
| interface GroupOption { | ||
| label: string; | ||
| type: "group"; | ||
| children: Option[]; | ||
| } | ||
|
|
||
| /** Union type for the options array input. so that we can support both flat and grouped options */ | ||
| export type SelectOption = Option | GroupOption; | ||
|
|
||
| interface SelectProps { | ||
| options: SelectOption[]; | ||
| placeholder?: string; | ||
| search?: boolean; | ||
| multiSelect?: boolean; | ||
| showAllSelected?: boolean; | ||
| onChange: (values: string[]) => void; | ||
| } | ||
|
|
||
| const Select: React.FC<SelectProps> = ({ | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using React.FC is a historically controversial way to define a component in React as such many project have moved away from doing this. As of TypeScript 5.1 and React 18, React.FC is now officially 'fine' but many project still do not use this. This way of defining a function also doesn't match the other ways functions were defined and it is important to keep code consistent across the codebase at times where it makes sense to do so. Is there a particular reason you chose to use React.FC here? |
||
| options: initialOptions, | ||
| placeholder = "Select", | ||
| search = false, | ||
| multiSelect = false, | ||
| showAllSelected = false, | ||
| onChange = () => {}, | ||
| }) => { | ||
| const [isOpen, setIsOpen] = useState<boolean>(false); | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you name these state variables to [open, setOpen] that way we are ensuring consistent naming in all the components? The dropdown component has the naming for this similar state that I am requesting. |
||
| const [searchValue, setSearchValue] = useState<string>(""); | ||
| const [selectedValues, setSelectedValues] = useState<string[]>([]); // values of slected options | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The state for the selectedValues is state that will impact more than just this component so it should be lifted up out of this component and passed through as a prop just like what was done in the dropdown component. |
||
| const [visibleChipCount, setVisibleChipCount] = useState<number>(0); // For +N more logic in multi-select mode | ||
|
|
||
| const componentRef = useRef<HTMLDivElement>(null); | ||
| const inputRef = useRef<HTMLInputElement>(null); | ||
| const chipsContainerRef = useRef<HTMLDivElement>(null); | ||
|
|
||
| const theme = { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please remove this theme object and define all the styles inline, all but one of the style options in this theme options have already been defined in the global stylesheet or are only applied in one location. |
||
| textOnSurface: "text-gray-900 dark:text-gray-100", | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. onSurface is already a CSS variable that is defined in the global.css file. It is further defined as a css token and it already has both a light and dark option defined. This doesn't need to be redefined in this file. |
||
| bgContainer: "bg-white dark:bg-gray-700", | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. container is already a CSS variable that is defined in the global.css file. It is further defined as a css token and it already has both a light and dark option defined. This doesn't need to be redefined in this file. |
||
| bgContainerHigh: "bg-gray-100 dark:bg-gray-800", | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. containerHigh is already a CSS variable that is defined in the global.css file. It is further defined as a css token and it already has both a light and dark option defined. This doesn't need to be redefined in this file. |
||
| borderOutline: "border-gray-300 dark:border-gray-600", | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. outline is already a CSS variable that is defined in the global.css file. It is further defined as a css token and it already has both a light and dark option defined. This doesn't need to be redefined in this file. |
||
| inputStyle: | ||
| "flex items-center min-h-10 w-full rounded-md border px-4 py-2 cursor-pointer transition duration-150 ease-in-out focus-within:ring-2 focus-within:ring-blue-500", | ||
| dropdownStyle: | ||
| "absolute z-30 mt-1 w-full rounded-md shadow-xl max-h-60 overflow-y-auto", | ||
| listItemStyle: | ||
| "px-4 py-2 cursor-pointer hover:bg-blue-50 dark:hover:bg-blue-900 transition duration-100", | ||
| }; | ||
|
|
||
| // Effect for click outside logic | ||
| useEffect(() => { | ||
| const handleClickOutside = (event: MouseEvent) => { | ||
| if ( | ||
| componentRef.current && | ||
| !componentRef.current.contains(event.target as Node) | ||
| ) { | ||
| setIsOpen(false); | ||
| } | ||
| }; | ||
| document.addEventListener("mousedown", handleClickOutside); | ||
| return () => document.removeEventListener("mousedown", handleClickOutside); | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you used a 'click' event listener in dropdown why did you choose to use a 'mousedown' click event in this listener? |
||
| }, []); | ||
|
|
||
| // parent component listener for selection changes | ||
| useEffect(() => { | ||
| onChange(selectedValues); | ||
| }, [selectedValues, onChange]); | ||
|
|
||
| // --- Filtering Logic --- | ||
| const flattenedOptions = useMemo<Option[]>(() => { | ||
| // all options flattened into a single array for easy searching | ||
| return initialOptions.flatMap((item) => | ||
| (item as GroupOption).type === "group" && (item as GroupOption).children | ||
| ? (item as GroupOption).children.map((child) => ({ | ||
| ...child, | ||
| groupLabel: item.label, | ||
| })) | ||
| : item.type !== "group" | ||
| ? [item as Option] | ||
| : [] | ||
| ); | ||
| }, [initialOptions]); | ||
|
|
||
| const filteredOptions = useMemo<SelectOption[]>(() => { | ||
| if (!searchValue) return initialOptions; | ||
|
|
||
| const lowerSearch = searchValue.toLowerCase(); | ||
|
|
||
| // Recursive filtering function to handle group and flat options | ||
| const filterItem = (item: SelectOption): SelectOption | null => { | ||
| if (item.type === "group") { | ||
| // Group: filter children | ||
| const groupItem = item as GroupOption; | ||
| const filteredChildren = groupItem.children.filter((child) => | ||
| child.label.toLowerCase().includes(lowerSearch) | ||
| ); | ||
| // Only return the group if it has matching children | ||
| return filteredChildren.length > 0 | ||
| ? { ...groupItem, children: filteredChildren } | ||
| : null; | ||
| } | ||
| // Standard flat option check | ||
| const standardItem = item as Option; | ||
| return standardItem.label.toLowerCase().includes(lowerSearch) | ||
| ? standardItem | ||
| : null; | ||
| }; | ||
|
|
||
| return initialOptions.map(filterItem).filter(Boolean) as SelectOption[]; | ||
| }, [initialOptions, searchValue]); | ||
|
|
||
| const handleToggle = useCallback(() => { | ||
| setIsOpen((prev) => !prev); | ||
| // Clear search value when closing | ||
| if (isOpen) setSearchValue(""); | ||
|
|
||
| // Focus input when opening and searchable | ||
| if (!isOpen && search && inputRef.current) { | ||
| setTimeout(() => inputRef.current?.focus(), 0); | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please explain what you are attempting to do with this conditional setTimeout statement? |
||
| } | ||
| }, [isOpen, search]); | ||
|
|
||
| const handleSelect = useCallback( | ||
| (value: string) => { | ||
| // Hope you understand this logic | ||
| setSelectedValues((prev) => { | ||
| let newValues: string[]; | ||
| if (multiSelect) { | ||
| newValues = prev.includes(value) | ||
| ? prev.filter((v) => v !== value) // Remove | ||
| : [...prev, value]; // Add | ||
| } else { | ||
| newValues = [value]; | ||
| setIsOpen(false); | ||
| } | ||
| return newValues; | ||
| }); | ||
| setSearchValue(""); | ||
| }, | ||
| [multiSelect] | ||
| ); | ||
|
|
||
| const handleRemoveChip = useCallback((value: string) => { | ||
| setSelectedValues((prev) => { | ||
| const newValues = prev.filter((v) => v !== value); | ||
| return newValues; | ||
| }); | ||
| }, []); | ||
|
|
||
| // Memoized array of selected option objects for rendering chips and input display | ||
| const allSelectedItems = useMemo<Option[]>( | ||
| () => | ||
| selectedValues | ||
| .map((v) => flattenedOptions.find((o) => o.value === v)) | ||
| .filter(Boolean) as Option[], | ||
| [selectedValues, flattenedOptions] | ||
| ); | ||
|
|
||
| // Effect to manage visible chip count based on container width and showAllSelected prop | ||
| useEffect(() => { | ||
| if (showAllSelected || !multiSelect || !chipsContainerRef.current) { | ||
| setVisibleChipCount(allSelectedItems.length); | ||
| return; | ||
| } | ||
|
|
||
| const checkOverflow = () => { | ||
| // In a dynamic container, we use a simple heuristic for responsive estimation. | ||
| // If we have more than 2 chips, we show 2 and the overflow counter. | ||
| if (allSelectedItems.length > 2) { | ||
| setVisibleChipCount(2); | ||
| } else { | ||
| setVisibleChipCount(allSelectedItems.length); | ||
| } | ||
| }; | ||
|
|
||
| // Use a delay for DOM layout stability | ||
| const timer = setTimeout(checkOverflow, 50); | ||
| window.addEventListener("resize", checkOverflow); | ||
| return () => { | ||
| clearTimeout(timer); | ||
| window.removeEventListener("resize", checkOverflow); | ||
| }; | ||
| }, [allSelectedItems.length, multiSelect, showAllSelected]); | ||
|
|
||
| const renderChip = (item: Option) => ( | ||
| <span key={item.value}> | ||
| <Chip | ||
| label={item.label} | ||
| variant="filled" | ||
| deleteIcon | ||
| onDelete={(e) => { | ||
| e.stopPropagation(); | ||
| handleRemoveChip(item.value); | ||
| }} | ||
| /> | ||
| </span> | ||
| ); | ||
|
|
||
| const renderChipsAndInput = () => { | ||
| const selectedCount = allSelectedItems.length; | ||
| const placeholderVisible = selectedCount === 0 && !searchValue; | ||
|
|
||
| if (!multiSelect) { | ||
| const selectedItem = allSelectedItems[0]; | ||
| let inputDisplayValue = ""; | ||
| if (isOpen && search) { | ||
| inputDisplayValue = searchValue; // Show search input when open and searchable | ||
| } else if (selectedItem) { | ||
| inputDisplayValue = selectedItem.label; // Show selected label when closed | ||
| } | ||
|
|
||
| return ( | ||
| <input | ||
| ref={inputRef} | ||
| type="text" | ||
| value={inputDisplayValue} | ||
| onChange={(e) => setSearchValue(e.target.value)} | ||
| onClick={(e) => { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If the parent element already handles changing the open state, why is this onClick event needed? |
||
| e.stopPropagation(); | ||
| if (!isOpen) setIsOpen(true); | ||
| }} | ||
| placeholder={placeholderVisible ? placeholder : ""} | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you explain to me what this conditional statement is for? |
||
| readOnly={!search || (!isOpen && !!selectedItem)} | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please explain what functionality you are trying to achieve with this conditional statement? |
||
| className={`flex-grow border-none focus:ring-0 focus:outline-none bg-transparent py-1 w-full min-w-[50px] | ||
| ${theme.textOnSurface} ${!inputDisplayValue && placeholderVisible ? "text-gray-500" : ""} | ||
| ${search ? "cursor-text" : "cursor-pointer"} | ||
| `} | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
| const visibleItems = | ||
| showAllSelected || visibleChipCount === selectedCount | ||
| ? allSelectedItems | ||
| : allSelectedItems.slice(0, visibleChipCount); | ||
|
|
||
| const overflowCount = selectedCount - visibleItems.length; | ||
|
|
||
| return ( | ||
| <div | ||
| ref={chipsContainerRef} | ||
| className={`flex flex-wrap items-center flex-grow overflow-hidden ${ | ||
| showAllSelected ? "h-auto max-h-none" : "max-h-10" | ||
| }`} | ||
| > | ||
| {visibleItems.map(renderChip)} | ||
| {overflowCount > 0 && ( | ||
| <Chip | ||
| label={" +" + overflowCount + " more"} | ||
| variant="filled" | ||
| /> | ||
| )} | ||
| {(search || placeholderVisible) && ( | ||
| <input | ||
| ref={inputRef} | ||
| type="text" | ||
| value={searchValue} | ||
| onChange={(e) => setSearchValue(e.target.value)} | ||
| onClick={(e) => { | ||
| e.stopPropagation(); // Stop parent click from handling toggle | ||
| if (!isOpen) setIsOpen(true); | ||
| }} | ||
| placeholder={placeholderVisible ? placeholder : ""} | ||
| className={`flex-grow border-none focus:ring-0 focus:outline-none bg-transparent py-1 ${ | ||
| theme.textOnSurface | ||
| } ${placeholderVisible ? "w-full" : "w-auto min-w-[50px]"}`} | ||
| // Added min-width for placeholder/search input to prevent collapse | ||
| /> | ||
| )} | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| const renderDropdownContent = () => { | ||
| if (filteredOptions.length === 0) { | ||
| return ( | ||
| <div className={`px-4 py-3 text-sm italic ${theme.textOnSurface}`}> | ||
| No options found. | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| return filteredOptions.map((item) => { | ||
| // checking if item is a group | ||
| if (item.type === "group") { | ||
| const groupItem = item as GroupOption; | ||
| // Hierarchical Group Header (Not selectable, only displays text) | ||
| return ( | ||
| <div key={groupItem.label} className="py-1"> | ||
| <div | ||
| className={`px-4 py-2 text-sm font-semibold ${theme.bgContainerHigh} ${theme.textOnSurface}`} | ||
| > | ||
| {groupItem.label} | ||
| </div> | ||
| {/* Divider */} | ||
| <div className={`border-t ${theme.borderOutline}`}></div> | ||
| {/* Render subcategories (Selectable) */} | ||
| {groupItem.children.map((child: Option) => { | ||
| const isSelected = selectedValues.includes(child.value); | ||
| return ( | ||
| <div | ||
| key={child.value} | ||
| className={`${theme.listItemStyle} ${ | ||
| isSelected ? "bg-blue-100 dark:bg-blue-800 font-medium" : "" | ||
| } ${theme.textOnSurface}`} | ||
| onClick={() => handleSelect(child.value)} | ||
| > | ||
| {child.label} | ||
| </div> | ||
| ); | ||
| })} | ||
| </div> | ||
| ); | ||
| } else { | ||
| // Standard selectable option (no 'type: group' property) | ||
| const standardItem = item as Option; | ||
| const isSelected = selectedValues.includes(standardItem.value); | ||
| return ( | ||
| <div | ||
| key={standardItem.value} | ||
| className={`${theme.listItemStyle} ${ | ||
| isSelected ? "bg-blue-100 dark:bg-blue-800 font-medium" : "" | ||
| } ${theme.textOnSurface}`} | ||
| onClick={() => handleSelect(standardItem.value)} | ||
| > | ||
| {standardItem.label} | ||
| </div> | ||
| ); | ||
| } | ||
| }); | ||
| }; | ||
|
|
||
| return ( | ||
| <div ref={componentRef} className="relative w-full font-inter"> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is the font set to inter here? |
||
| <div | ||
| className={`${theme.inputStyle} ${theme.borderOutline} ${ | ||
| theme.textOnSurface | ||
| } ${isOpen ? "ring-2 ring-blue-500" : ""}`} | ||
| onClick={handleToggle} | ||
| > | ||
| {renderChipsAndInput()} | ||
|
|
||
| <div | ||
| className={`ml-2 transform transition-transform ${ | ||
| isOpen ? "rotate-180" : "rotate-0" | ||
| } ${theme.textOnSurface}`} | ||
| > | ||
| <ChevronDown /> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This icon isn't showing up in the UI for me. |
||
| </div> | ||
| </div> | ||
|
|
||
| {isOpen && ( | ||
| <div | ||
| className={`${theme.dropdownStyle} ${theme.bgContainer} ${theme.borderOutline} border`} | ||
| > | ||
| {renderDropdownContent()} | ||
| </div> | ||
| )} | ||
| </div> | ||
| ); | ||
| }; | ||
| export default Select; | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's change status to match the status options for a property "valid" | "falsified" | "undetermined"