import { useState } from "react"; import { boxStyleFunctions } from "../../theme/src/style-functions"; import { ComponentTypes, StyleFunctionContainer } from "../../theme/src/types"; import { useDynamicStateStyle } from "./useDynamicStateStyle"; /** * Hook to manage a checked state and compose extra styling while a component is checked * @param props The props object of a component * @param styleFunctions List of style functions supported by the component. By default, boxStyleFunctions are used * @param activeComponentType Type of the component inside which the hook is used. By default, this value is set to 'basic' * @param animateable Whether the styles should be dynamically animated using Moti. By default, this value is set to 'true' * @param parentStateValue A override value to control the 'checked' state instead of the local state value * @returns The props object with updated styles according the current 'checked' state */ export const useCheckedState = ( props: Record, styleFunctions: StyleFunctionContainer[] = boxStyleFunctions, activeComponentType: ComponentTypes = "basic", animateable = true, parentStateValue: boolean | undefined = undefined ) => { // Initialize the checked state to false const [checked, setChecked] = useState(false); // Override the focused state if the parentStateValue is provided let finalCheckedFlag; if (parentStateValue !== undefined) { finalCheckedFlag = parentStateValue; } else { finalCheckedFlag = checked; } // Dynamically update the styles based on the checked state const propsWithCheckedStyles = useDynamicStateStyle( props, "_checked", finalCheckedFlag, styleFunctions, activeComponentType, animateable ); // Return the checked state, a function to update the checked state, and the props with updated styles return { checked, setChecked, propsWithCheckedStyles, }; };