Docebo libraries documentation site
vdevelop
Get Started
Guides
Overview Icons Illustrations Theme
Components
Accordion Avatar Badge Alert Badge Icon Badge Status Blank Slate Button Calendar Card Carousel Chip Data Browser Expandable Content Facet List
Filters
Filter Filter Container Filter Multiple Selection Filter Single Selection Filter Slider Range Selection Filter Slider Selection
Helper Message Icon Illustration
Inputs
Input Autocomplete Input Checkbox Input Checkbox Group Input Combobox Input Date Input Password Input Radio Group Input Rating Input Search Input Select Input Slider Input Text Input Toggle Input Upload
Link List List Listbox List Navigation List Presentation List Sheet List Tablist List Tree Menu Modal Dialog Navigation Notification Pagination Bar Popover Progress Skeleton Stepper Table Toast Tooltip
API References
@elemental/common / Function

createState

Generic types:T

Create a state object with signals, computed signals and effects. All the signals into withSignals are converted to writable signals.

Presentation

function createState(withSignals: T): {
  [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>;
};

Returns

{ [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; }

Parameters

NameTypeDescription
withSignals
T

@param withSignals The signals to be used as state

Overloads

Overload #1

Create a state object with signals, computed signals and effects. All the signals into withSignals are converted to writable signals.

Presentation
createState(withSignals: T): { [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; };
Parameters
NameTypeDescription
withSignals
T

@param withSignals The signals to be used as state

Returns
{ [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; }
Overload #2

Create a state object with signals, computed signals and effects. All the signals into withSignals are converted to writable signals.

Presentation
createState(withSignals: T, withComputed: F): { [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; } & { [B in keyof F]: Signal<ReturnType<F[B]>>; };
Parameters
NameTypeDescription
withSignals
T

@param withSignals The signals to be used as state

withComputed
F

@param withComputed The computed signals to be used as state based on the withSignals

Returns
{ [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; } & { [B in keyof F]: Signal<ReturnType<F[B]>>; }
Overload #3

Create a state object with signals, computed signals and effects. All the signals into withSignals are converted to writable signals.

Presentation
createState(withSignals: T, withComputed: F, withEffects: G): { [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; } & { [B in keyof F]: Signal<ReturnType<F[B]>>; } & { [J in keyof G]: EffectRef; };
Parameters
NameTypeDescription
withSignals
T

@param withSignals The signals to be used as state

withComputed
F

@param withComputed The computed signals to be used as state based on the withSignals

withEffects
G

@param withEffects The effects to be used as state based on the withSignals

Returns
{ [K in keyof T]: WritableSignal<ExtractSignal<T[K]>>; } & { [B in keyof F]: Signal<ReturnType<F[B]>>; } & { [J in keyof G]: EffectRef; }