You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-src/pages/api.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ description: 'Functions, types, and constants'
19
19
20
20
## Component
21
21
22
-
Create a Web Component of type [Component](api/type-aliases/Component.html):
22
+
Create a Web Component of type [Component](api/type-aliases/Component.html) with reactive properties that extend [ComponentProps](api/type-aliases/ComponentProps.html).
23
23
24
24
-[component](api/functions/component.html)
25
25
@@ -29,28 +29,28 @@ Create a Web Component of type [Component](api/type-aliases/Component.html):
29
29
30
30
## Signals
31
31
32
-
Create a signal of type [Signal](api/type-aliases/Signal.html):
32
+
Create a signal of type [Signal](api/type-aliases/Signal.html).
33
33
34
-
-[computed](api/functions/computed.html)
35
-
-[selection](api/functions/selection.html)
36
-
-[sensor](api/functions/sensor.html)
37
-
-[state](api/functions/state.html)
34
+
-[computed](api/functions/computed.html) creates a [Computed](api/type-aliases/Computed.html) signal derived from other signals
35
+
-[selection](api/functions/selection.html) creates a [Computed](api/type-aliases/Computed.html) signal that updates according to a dynamic CSS selector
36
+
-[sensor](api/functions/sensor.html) creates a [Computed](api/type-aliases/Computed.html) signal that updates according to events
37
+
-[state](api/functions/state.html) creates a [State](api/type-aliases/State.html) signal
38
38
39
39
Helper functions:
40
40
41
-
-[isComputed](api/functions/isComputed.html)
42
-
-[isSignal](api/functions/isSignal.html)
43
-
-[isState](api/functions/isState.html)
41
+
-[isComputed](api/functions/isComputed.html) checks whether a value is a [Computed](api/type-aliases/Computed.html) signal
42
+
-[isSignal](api/functions/isSignal.html) checks whether a value is a [Signal](api/type-aliases/Signal.html)
43
+
-[isState](api/functions/isState.html) checks whether a value is a [State](api/type-aliases/State.html) signal
44
44
45
45
</section>
46
46
47
47
<section>
48
48
49
49
## Attribute Parsers
50
50
51
-
Declare how attributes are parsed. Variable of type or function returning [AttributeParser](api/type-aliases/AttributeParser.html):
51
+
Declare how attributes are parsed. Functions returning [AttributeParser](api/type-aliases/AttributeParser.html) that will be used to create [State](api/type-aliases/State.html) signals as reactive properties on the component.
52
52
53
-
-[asBoolean](api/variables/asBoolean.html)
53
+
-[asBoolean](api/functions/asBoolean.html)
54
54
-[asEnum](api/functions/asEnum.html)
55
55
-[asInteger](api/functions/asInteger.html)
56
56
-[asJSON](api/functions/asJSON.html)
@@ -65,11 +65,11 @@ Declare how attributes are parsed. Variable of type or function returning [Attri
65
65
66
66
Declare how signals are initialized. Variable of type or function returning [SignalInitializer](api/type-aliases/SignalInitializer.html):
67
67
68
-
-[consume](api/functions/consume.html)
69
-
-[fromChild](api/functions/fromChild.html)
70
-
-[fromChildren](api/functions/fromChildren.html)
71
-
-[fromEvent](api/functions/fromEvent.html)
72
-
-[fromSelector](api/functions/fromSelector.html)
68
+
-[fromContext](api/functions/fromContext.html) consumes a context value from nearest ancestor context provider component
69
+
-[fromDescendant](api/functions/fromDescendant.html) gets a reactive property of a descendant component
70
+
-[fromDescendants](api/functions/fromDescendants.html) reduces properties of a collection of descendant elements to a single value
71
+
-[fromEvent](api/functions/fromEvent.html) creates a computed signal from an event handler on a descendant element
72
+
-[fromSelector](api/functions/fromSelector.html) creates a computed signal of descentant elements matching a CSS selector
0 commit comments