24 lines
1.5 KiB
TypeScript
24 lines
1.5 KiB
TypeScript
|
import * as React from 'react';
|
||
|
|
export interface IControlledStateOptions<TProps, TProp extends keyof TProps, TDefaultProp extends keyof TProps> {
|
||
|
|
defaultPropValue?: TProps[TProp];
|
||
|
|
defaultPropName?: TDefaultProp;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Controlled state helper that gives priority to props value. Useful for components that have props with both
|
||
|
|
* controlled and uncontrolled modes. Any props values will override state, but will not update internal state.
|
||
|
|
* If prop is defined and then later undefined, state will revert to its previous value.
|
||
|
|
*
|
||
|
|
* @param props - The props object containing controlled prop values.
|
||
|
|
* @param propName - The controlled prop name.
|
||
|
|
* @param options - Options. defaultPropValue is only used if defaultPropName (or its value) is undefined.
|
||
|
|
*/
|
||
|
|
export declare function useControlledState<TProps, TProp extends keyof TProps, TDefaultProp extends keyof TProps>(props: Readonly<TProps>, propName: TProp, options?: IControlledStateOptions<TProps, TProp, TDefaultProp>): [TProps[TProp] | undefined, React.Dispatch<React.SetStateAction<TProps[TProp]>>];
|
||
|
|
/**
|
||
|
|
* Simple controlled helper that gives priority to props value and falls back to derived value.
|
||
|
|
*
|
||
|
|
* @param props - The props object containing controlled prop values.
|
||
|
|
* @param propName - The controlled prop name.
|
||
|
|
* @param derivedValue - Derived value. Returned when controlled value is not present.
|
||
|
|
*/
|
||
|
|
export declare function getControlledDerivedProps<TProps, TProp extends keyof TProps>(props: Readonly<TProps>, propName: TProp, derivedValue: TProps[TProp]): TProps[TProp];
|