UNPKG

@zeix/ui-element

Version:

UIElement - a HTML-first library for reactive Web Components

48 lines (24 loc) • 1.03 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
[**@zeix/ui-element**](../README.md) *** [@zeix/ui-element](../globals.md) / fromContext # Function: fromContext() > **fromContext**\<`T`, `C`\>(`context`, `fallback`): [`Extractor`](../type-aliases/Extractor.md)\<[`Signal`](../type-aliases/Signal.md)\<`T`\>, `C`\> Defined in: [src/core/context.ts:125](https://github.com/zeixcom/ui-element/blob/1e5ebee179adfc4619d3d0e9d2b864d1e97ba797/src/core/context.ts#L125) Consume a context value for a component. ## Type Parameters ### T `T` *extends* `object` ### C `C` *extends* `HTMLElement` = `HTMLElement` ## Parameters ### context [`Context`](../type-aliases/Context.md)\<`string`, [`Signal`](../type-aliases/Signal.md)\<`T`\>\> Context key to consume ### fallback [`Fallback`](../type-aliases/Fallback.md)\<`T`, `C`\> Fallback value or extractor function ## Returns [`Extractor`](../type-aliases/Extractor.md)\<[`Signal`](../type-aliases/Signal.md)\<`T`\>, `C`\> Function that returns the consumed context signal or a signal of the fallback value ## Since 0.13.1