@genesislcap/web-core 14.408.0 → 14.409.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -51
- package/package.json +3 -4
- package/docs/api/index.md +0 -30
- package/docs/api/web-core.conversiontype.md +0 -13
- package/docs/api/web-core.defaulteventmap.md +0 -13
- package/docs/api/web-core.definefactory.md +0 -99
- package/docs/api/web-core.definefunction.md +0 -15
- package/docs/api/web-core.definitionoverrider.md +0 -15
- package/docs/api/web-core.deprecatedattr.md +0 -54
- package/docs/api/web-core.deprecatedattr_1.md +0 -70
- package/docs/api/web-core.eventname.md +0 -13
- package/docs/api/web-core.md +0 -194
- package/docs/api/web-core.sync.md +0 -100
- package/docs/api/web-core.tagfor.md +0 -59
- package/docs/api/web-core.templateelementdependency.md +0 -16
- package/docs/api/web-core.templateelements.md +0 -20
- package/docs/api/web-core.whenelse.md +0 -86
- package/docs/api-report.md.api.md +0 -502
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/web-core](./web-core.md) > [sync](./web-core.sync.md)
|
|
4
|
-
|
|
5
|
-
## sync() function
|
|
6
|
-
|
|
7
|
-
Creates a synchronization directive that binds a data source to an HTML element,
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function sync<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, conversionType?: ConversionType, eventName?: EventName, keyAttr?: string): CaptureType<TSource>;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Parameter
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Type
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Description
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th></tr></thead>
|
|
33
|
-
<tbody><tr><td>
|
|
34
|
-
|
|
35
|
-
binding
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</td><td>
|
|
39
|
-
|
|
40
|
-
Binding<TSource, TReturn>
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td></tr>
|
|
47
|
-
<tr><td>
|
|
48
|
-
|
|
49
|
-
conversionType
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
</td><td>
|
|
53
|
-
|
|
54
|
-
[ConversionType](./web-core.conversiontype.md)
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
</td><td>
|
|
58
|
-
|
|
59
|
-
_(Optional)_
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</td></tr>
|
|
63
|
-
<tr><td>
|
|
64
|
-
|
|
65
|
-
eventName
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
</td><td>
|
|
69
|
-
|
|
70
|
-
[EventName](./web-core.eventname.md)
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
</td><td>
|
|
74
|
-
|
|
75
|
-
_(Optional)_
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</td></tr>
|
|
79
|
-
<tr><td>
|
|
80
|
-
|
|
81
|
-
keyAttr
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
</td><td>
|
|
85
|
-
|
|
86
|
-
string
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
</td><td>
|
|
90
|
-
|
|
91
|
-
_(Optional)_
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
</td></tr>
|
|
95
|
-
</tbody></table>
|
|
96
|
-
|
|
97
|
-
**Returns:**
|
|
98
|
-
|
|
99
|
-
CaptureType<TSource>
|
|
100
|
-
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/web-core](./web-core.md) > [tagFor](./web-core.tagfor.md)
|
|
4
|
-
|
|
5
|
-
## tagFor() function
|
|
6
|
-
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Determines what HTML tag name to use for the dependency.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export declare function tagFor(dependency: TemplateElementDependency): string;
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Parameters
|
|
19
|
-
|
|
20
|
-
<table><thead><tr><th>
|
|
21
|
-
|
|
22
|
-
Parameter
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
</th><th>
|
|
26
|
-
|
|
27
|
-
Type
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
</th><th>
|
|
31
|
-
|
|
32
|
-
Description
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
</th></tr></thead>
|
|
36
|
-
<tbody><tr><td>
|
|
37
|
-
|
|
38
|
-
dependency
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
</td><td>
|
|
42
|
-
|
|
43
|
-
[TemplateElementDependency](./web-core.templateelementdependency.md)
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
The dependency the template is dependent on.
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
</td></tr>
|
|
52
|
-
</tbody></table>
|
|
53
|
-
|
|
54
|
-
**Returns:**
|
|
55
|
-
|
|
56
|
-
string
|
|
57
|
-
|
|
58
|
-
The tag name to use in markup.
|
|
59
|
-
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/web-core](./web-core.md) > [TemplateElementDependency](./web-core.templateelementdependency.md)
|
|
4
|
-
|
|
5
|
-
## TemplateElementDependency type
|
|
6
|
-
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Used to designate a template's dependency on another custom element.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export type TemplateElementDependency = string | GenesisElementDefinition | Constructable<GenesisElement>;
|
|
16
|
-
```
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/web-core](./web-core.md) > [TemplateElements](./web-core.templateelements.md)
|
|
4
|
-
|
|
5
|
-
## TemplateElements type
|
|
6
|
-
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Used to help map components / elements for tagFor usage
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export type TemplateElements = {
|
|
16
|
-
[key: string]: TemplateElementDependency;
|
|
17
|
-
};
|
|
18
|
-
```
|
|
19
|
-
**References:** [TemplateElementDependency](./web-core.templateelementdependency.md)
|
|
20
|
-
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/web-core](./web-core.md) > [whenElse](./web-core.whenelse.md)
|
|
4
|
-
|
|
5
|
-
## whenElse() function
|
|
6
|
-
|
|
7
|
-
Directive that allows supplying an "else" template to the traditional [https://www.fast.design/docs/api/fast-element.when/\#when-function](https://www.fast.design/docs/api/fast-element.when/#when-function) directive
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function whenElse<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, trueTemplateOrTemplateBinding: WhenTemplate<TSource>, falseTemplateOrTemplateBinding: WhenTemplate<TSource>): CaptureType<TSource>;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
<table><thead><tr><th>
|
|
18
|
-
|
|
19
|
-
Parameter
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
</th><th>
|
|
23
|
-
|
|
24
|
-
Type
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</th><th>
|
|
28
|
-
|
|
29
|
-
Description
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
</th></tr></thead>
|
|
33
|
-
<tbody><tr><td>
|
|
34
|
-
|
|
35
|
-
binding
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
</td><td>
|
|
39
|
-
|
|
40
|
-
Binding<TSource, TReturn>
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
</td><td>
|
|
44
|
-
|
|
45
|
-
The condition to test for rendering.
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
</td></tr>
|
|
49
|
-
<tr><td>
|
|
50
|
-
|
|
51
|
-
trueTemplateOrTemplateBinding
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
</td><td>
|
|
55
|
-
|
|
56
|
-
WhenTemplate<TSource>
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
</td><td>
|
|
60
|
-
|
|
61
|
-
The template or a binding that gets the template to render when the condition is true.
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
</td></tr>
|
|
65
|
-
<tr><td>
|
|
66
|
-
|
|
67
|
-
falseTemplateOrTemplateBinding
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
</td><td>
|
|
71
|
-
|
|
72
|
-
WhenTemplate<TSource>
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
</td><td>
|
|
76
|
-
|
|
77
|
-
The template or a binding that gets the template to render when the condition is false.
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
</td></tr>
|
|
81
|
-
</tbody></table>
|
|
82
|
-
|
|
83
|
-
**Returns:**
|
|
84
|
-
|
|
85
|
-
CaptureType<TSource>
|
|
86
|
-
|