Function useAmbassadorState

A type of state where the value is used from the props in the case of them being set.

Otherwise, an internal set of properties are used. This is useful in the case that you want to allow properties to control the state of the component, but this functionality is to be optional.

Param: current

The current value from the props. If this is undefined, then the internal state is used.

Param: setCurrent

The mutator method to set the current value. This can be undefined, but if it is set, both the internal value and the prop value are set.

Param: initial

The initial value to set if current is undefined.

Param: T

The type of data for the state.

Returns

A tuple where the first item is the current state and the 2nd item is a mutator method to modify the state.

useAmbassadorState<T>(
current: T | undefined,
setCurrent: ZAmbassadorSetCurrent<T>,
): [T | undefined, (val: T | ZAmbassadorReducer<T>) => void]
A type of state where the value is used from the props in the case of them being set.

Otherwise, an internal set of properties are used. This is useful in the case that you want to allow properties to control the state of the component, but this functionality is to be optional.
Type Parameters
- T
  The type of data for the state.
Parameters
- current: T | undefined
  The current value from the props. If this is undefined, then the internal state is used.
- setCurrent: ZAmbassadorSetCurrent<T>
  The mutator method to set the current value. This can be undefined, but if it is set, both the internal value and the prop value are set.
Returns [T | undefined, (val: T | ZAmbassadorReducer<T>) => void]
A tuple where the first item is the current state and the 2nd item is a mutator method to modify the state.
- Defined in ambassador-state/use-ambassador-state.mts:41
useAmbassadorState<T>(
    current: T | undefined,
    setCurrent: ZAmbassadorSetCurrent<T>,
    initial: T,
): [T, (val: T | ZAmbassadorReducerRequired<T>) => void]
A type of state where the value is used from the props in the case of them being set.

Otherwise, an internal set of properties are used. This is useful in the case that you want to allow properties to control the state of the component, but this functionality is to be optional.
Type Parameters
- T
Parameters
- current: T | undefined
  The current value from the props. If this is undefined, then the internal state is used.
- setCurrent: ZAmbassadorSetCurrent<T>
  The mutator method to set the current value. This can be undefined, but if it is set, both the internal value and the prop value are set.
- initial: T
  The initial value to set if current is undefined.
Returns [T, (val: T | ZAmbassadorReducerRequired<T>) => void]
A tuple where the first item is the current state and the 2nd item is a mutator method to modify the state.
- Defined in ambassador-state/use-ambassador-state.mts:67

Function useAmbassadorState

Param: current

Param: setCurrent

Param: initial

Param: T

Returns

Type Parameters

Parameters

Returns [T | undefined, (val: T | ZAmbassadorReducer<T>) => void]

Type Parameters

Parameters

Returns [T, (val: T | ZAmbassadorReducerRequired<T>) => void]

Settings