callWidgetFactory<
W>(__namedParameters):W&object
• W extends Widget<object, object, object, object, object>
• __namedParameters: WidgetFactoryInput<W>
W & object
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.
• T
• 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.
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.
The resulting store has a value computed from the parent store in two steps:
createWidgetsDefaultConfig(
adaptParentConfig?):WidgetsConfigStore<WidgetsConfig>
• adaptParentConfig?: AdaptParentConfig
getContextWidgetConfig<
N>(widgetName):ReadableSignal<undefined|Partial<WidgetsConfig[N]>>
• N extends keyof WidgetsConfig
• widgetName: N
ReadableSignal<undefined | Partial<WidgetsConfig[N]>>
mergeInto<
T>(destination,source,levels):T
Merges source object into destination object, up to the provided number of levels.
• T
• destination: T
destination object
• source: undefined | T
source object
• levels: number = Infinity
number of levels to merge
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<
T>:Partial<{ [Level1 in keyof T]: Partial<T[Level1]> }>
• T
WidgetsConfig:
object
accordion:
AccordionProps
the accordion widget config
alert:
AlertProps
the alert widget config
modal:
ModalProps<any>
the modal widget config
pagination:
PaginationProps
the pagination widget config
progressbar:
ProgressbarProps
the progressbar widget config
rating:
RatingProps
the rating widget config
select:
SelectProps<any>
the select widget config
slider:
SliderProps
the slider widget config
toast:
ToastProps
the toast widget config
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.
• Config extends object = WidgetsConfig
• widgetsDefaultConfigKey: symbol = ...
the widgets config key
object
the utilities to create / manage widgets and contexts
callWidgetFactory: <
W>(__namedParameters) =>W&object
• W extends Widget<object, object, object, object, object>
• __namedParameters: WidgetFactoryInput<Config, W>
W & object
createWidgetsDefaultConfig:
CreateWidgetsDefaultConfig<Config>
getContextWidgetConfig: <
N>(widgetName) =>ReadableSignal<undefined|Partial<Config[N]>>
• N extends string | number | symbol
• widgetName: N
ReadableSignal<undefined | Partial<Config[N]>>
widgetsDefaultConfigKey:
symbol
Key used in the Svelte context to get or set the widgets default configuration store.
WidgetsConfigStore<
T>:WritableSignal<Partial2Levels<T>> &object
adaptedParent$:
undefined|ReadableSignal<Partial2Levels<T>>
own$:
WritableSignal<Partial2Levels<T>>
parent$:
undefined|WritableSignal<Partial2Levels<T>>
• T
widgetsDefaultConfigKey:
symbol