Skip to content

Variable: StateProvider

API / @xmachines/play-vue / StateProvider

const StateProvider: vue.DefineComponent<
vue.ExtractPropTypes<{
initialState: {
default: undefined;
type: PropType<StateModel>;
};
onStateChange: {
default: undefined;
type: PropType<(changes) => void>;
};
store: {
default: undefined;
type: PropType<StateStore>;
};
}>,
() =>
| vue.VNode<
vue.RendererNode,
vue.RendererElement,
{
[key: string]: any;
}
>[]
| undefined,
{},
{},
{},
vue.ComponentOptionsMixin,
vue.ComponentOptionsMixin,
{},
string,
vue.PublicProps,
Readonly<
vue.ExtractPropTypes<{
initialState: {
default: undefined;
type: PropType<StateModel>;
};
onStateChange: {
default: undefined;
type: PropType<(changes) => void>;
};
store: {
default: undefined;
type: PropType<StateStore>;
};
}>
> &
Readonly<{}>,
{
initialState: StateModel;
onStateChange: (changes) => void;
store: StateStore;
},
{},
{},
{},
string,
vue.ComponentProvideOptions,
true,
{},
any
>;

Defined in: @json-render/vue

Provider for state model context.

Supports two modes:

  • Controlled: pass a store prop (e.g. backed by Redux / Zustand).
  • Uncontrolled (default): omit store and optionally pass initialState / onStateChange.