headless

API config

createWidgetsConfig

function

createWidgetsConfig<T>(parent$?, adaptParentConfig?): WidgetsConfigStore<T>

Creates a new widgets default configuration store, optionally inheriting from a parent store, and containing its own set of widgets configuration properties that override the same properties form the parent configuration.

Type Parameters

T

Parameters

parent$?: WidgetsConfigStore<T>

optional parent widgets default configuration store.

adaptParentConfig? = identity

optional function that receives a 2-levels copy of the widgets default configuration from parent$ (or an empty object if parent$ is not specified) and returns the widgets default configuration to be used. It is called only if the configuration is needed, and was not yet computed for the current value of the parent configuration. It is called in a tansu reactive context, so it can use any tansu store and will be called again if those stores change.

Returns

WidgetsConfigStore<T>

the resulting widgets default configuration store, which contains 3 additional properties that are stores: parent$, adaptedParent$ (containing the value computed after the first step), and own$ (that contains only overridding properties). The resulting store is writable, its set function is actually the set function of the own$ store.

Remarks

The resulting store has a value computed from the parent store in two steps:

  • first step: the parent configuration is transformed by the adaptParentConfig function (if specified). If adaptParentConfig is not specified, this step is skipped.
  • second step: the configuration from step 1 is merged (2-levels deep) with the own$ store. The own$ store initially contains an empty object (i.e. no property from the parent is overridden). It can be changed by calling set on the store returned by this function.

mergeInto

function

mergeInto<T>(destination, source, levels): T

Merges source object into destination object, up to the provided number of levels.

Type Parameters

T

Parameters

destination: T

destination object

source: undefined | T

source object

levels: number = Infinity

number of levels to merge

Returns

T

the destination object in most cases, or the source in some cases (if the source is not undefined and either levels is smaller than 1 or the source is not an object)


Partial2Levels

type alias

Partial2Levels<T>: Partial<{ [Level1 in keyof T]: Partial<T[Level1]> }>

A utility type that makes all properties of an object type T optional, and also makes all properties of the nested objects within T optional.

Type Parameters

T

The object type to be transformed.


WidgetsConfig

type alias

WidgetsConfig: object

Configuration for various widgets used in the application.

Type declaration
accordion

accordion: AccordionProps

the accordion widget config

alert

alert: AlertProps

the alert widget config

modal

modal: ModalProps

the modal widget config

pagination

pagination: PaginationProps

the pagination widget config

progressbar

progressbar: ProgressbarProps

the progress bar widget config

rating

rating: RatingProps

the rating widget config

select

select: SelectProps<any>

the select widget config

slider

slider: SliderProps

slider widget config

toast

toast: ToastProps

toast widget config


widgetsConfigFactory

function

widgetsConfigFactory<Config>(widgetsDefaultConfigKey): object

A factory to create the utilities to allow widgets to be context-aware.

It can be used when extending the core and creating new widgets.

Type Parameters

Config extends object = WidgetsConfig

The shape of the widgets configuration object.

Parameters

widgetsDefaultConfigKey: symbol = ...

the widgets config key

Returns

object

the utilities to create / manage widgets and contexts

callWidgetFactory

callWidgetFactory: <W>(input) => WidgetSlotContext<W>

Type Parameters

W extends Widget<object, object, object, object>

Parameters

input: WidgetFactoryInput<Config, W>

Returns

WidgetSlotContext<W>

createWidgetsDefaultConfig

createWidgetsDefaultConfig: CreateWidgetsDefaultConfig<Config>

getContextWidgetConfig

getContextWidgetConfig: <N>(widgetName) => ReadableSignal<undefined | Partial<Config[N]>>

Type Parameters

N extends string | number | symbol

Parameters

widgetName: N

Returns

ReadableSignal<undefined | Partial<Config[N]>>

widgetsDefaultConfigKey

widgetsDefaultConfigKey: symbol

Key used in the Svelte context to get or set the widgets default configuration store.


WidgetsConfigStore

type alias

WidgetsConfigStore<T>: WritableSignal<Partial2Levels<T>> & object

Represents a store for widget configurations with support for partial updates at two levels of depth. This store includes signals for its own state, an optional parent state, and an optional adapted parent state.

Type declaration
adaptedParent$

adaptedParent$: undefined | ReadableSignal<Partial2Levels<T>>

own$

own$: WritableSignal<Partial2Levels<T>>

parent$

parent$: undefined | WritableSignal<Partial2Levels<T>>

Type Parameters

T

The type of the widget configuration.


widgetsDefaultConfigKey

constant

widgetsDefaultConfigKey: symbol