@tater-archives/react-use-destructure v1.1.3

react-use-destructure

React hooks to split an object into multiple states.

Normally you should use multiple states for multiple values, but sometimes you have, for example, a list of objects where a component must be rendered for each object and the component has to modify its object. This hook lets you skip the boilerplate when modifying properties of an object.

TypeScript is recommended for the level of complexity in this logic.

usePropState

Creates a state pair for a single prop in an object

Example Usage

interface PersonData {
    name: string;
    age: number;
}

// Suppose you have a component Person which
// gets passed a PersonData and needs to modify it
function Person({value, onChange}: {
    value: PersonData,
    onChange: (value: PersonData) => void
}) {
    const [age, setAge] = usePropState(value, onChange, 'age');
    
    // Now you can use it like a regular state
    return <div>
        <h2>{value.name}</h2>
        </h2>
        <p>
            Age:
            <NumberInput value={age} onChange={setAge} />
        </p>
    </div>
}

useDestructure

Creates a state pair for every prop in an object

Example Usage

interface PersonData {
    name: string;
    age: number;
}

function Person({value, onChange}: {
    value: PersonData,
    onChange: (value: PersonData) => void
}) {
    const {
        name: [name, setName],
        age: [age, setAge]
    } = useDestructure(value, onChange);    
    
    // Now you can use these like regular states
    return <div>
        <h2>
            <TextInput value={name} onChange={setName} />
        </h2>
        <p>Age: {age}</p>
        <button onClick={() => setAge(age + 1)}>Increment Age</button>
    </div>
}

Note: If the object could gain properties (e.g. if some properties are optional and get added later), you must specify all of the possible property names as a third parameter, otherwise it will not expose these properties.

interface Shape {
    sides: number,
    curved?: boolean    
}

const [myShape, setMyShape] = useState<Shape>({sides: 4});

const {
    sides: [sides, setSides],
    curved: [curved, setCurved]
} = useDestructure(myShape, setMyShape, ['sides', 'curved']);

See also: @tater-archives/react-array-utils