@decaf-ts/ui-decorators 0.4.6 → 0.5.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 +70 -28
- package/dist/ui-decorators.cjs +604 -0
- package/dist/ui-decorators.esm.cjs +581 -0
- package/lib/esm/index.d.ts +1 -1
- package/lib/esm/index.js +2 -3
- package/lib/esm/model/Renderable.js +1 -2
- package/lib/esm/model/decorators.js +1 -2
- package/lib/esm/model/index.js +1 -2
- package/lib/esm/model/model.js +1 -2
- package/lib/esm/model/overrides.js +1 -2
- package/lib/esm/ui/Rendering.js +1 -2
- package/lib/esm/ui/constants.js +1 -2
- package/lib/esm/ui/decorators.js +1 -2
- package/lib/esm/ui/errors.js +1 -2
- package/lib/esm/ui/index.js +1 -2
- package/lib/esm/ui/interfaces.js +1 -2
- package/lib/esm/ui/types.js +1 -2
- package/lib/esm/ui/utils.d.ts +1 -1
- package/lib/esm/ui/utils.js +2 -3
- package/lib/index.cjs +2 -1
- package/lib/index.d.ts +1 -1
- package/lib/model/Renderable.cjs +1 -0
- package/lib/model/decorators.cjs +1 -0
- package/lib/model/index.cjs +1 -0
- package/lib/model/model.cjs +1 -0
- package/lib/model/overrides.cjs +1 -0
- package/lib/ui/Rendering.cjs +1 -0
- package/lib/ui/constants.cjs +1 -0
- package/lib/ui/decorators.cjs +1 -0
- package/lib/ui/errors.cjs +1 -0
- package/lib/ui/index.cjs +1 -0
- package/lib/ui/interfaces.cjs +1 -0
- package/lib/ui/types.cjs +1 -0
- package/lib/ui/utils.cjs +2 -1
- package/lib/ui/utils.d.ts +1 -1
- package/package.json +36 -38
- package/dist/esm/ui-decorators.bundle.min.esm.js +0 -2
- package/dist/esm/ui-decorators.bundle.min.esm.js.LICENSE.txt +0 -14
- package/dist/ui-decorators.bundle.min.js +0 -2
- package/dist/ui-decorators.bundle.min.js.LICENSE.txt +0 -14
package/README.md
CHANGED
|
@@ -1,53 +1,95 @@
|
|
|
1
|
-
|
|
2
|
-
[](https://github.com/TiagoVenceslau/ui-decorators)
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
|
|
5
2
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
## User Interface Decorators
|
|
4
|
+
|
|
5
|
+
Introduces a declarative way to render UI forms
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
[](https://github.com/decaf-ts/ui-decorators/actions/workflows/nodejs-build-prod.yaml)
|
|
14
|
+
[](https://github.com/decaf-ts/ui-decorators/actions/workflows/codeql-analysis.yml)[](https://github.com/decaf-ts/ui-decorators/actions/workflows/snyk-analysis.yaml)
|
|
15
|
+
[](https://github.com/decaf-ts/ui-decorators/actions/workflows/pages.yaml)
|
|
16
|
+
[](https://github.com/decaf-ts/ui-decorators/actions/workflows/release-on-tag.yaml)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
10
26
|
|
|
11
27
|
|
|
12
28
|
|
|
13
29
|
|
|
30
|
+
Documentation available [here](https://decaf-ts.github.io/ui-decorators/)
|
|
14
31
|
|
|
15
|
-
|
|
32
|
+
### Description
|
|
16
33
|
|
|
17
34
|
Adds a new Decorator ```uielement``` to add UI metadata to the model, that can be later interpreted by different rendering strategies
|
|
18
35
|
|
|
19
36
|
This package will:
|
|
20
|
-
|
|
37
|
+
- expose the basic api to enable each Model to be rendered according to a 'Rendering Strategy';
|
|
21
38
|
|
|
22
39
|
Extending this with the ```ui-decorators-web``` package.
|
|
23
|
-
|
|
24
|
-
|
|
40
|
+
- Use an HTML5 rendering strategy
|
|
41
|
+
- perform automatic From-end form validation, using native HTML5 APIs, extensible with custom validators and custom errors messages;
|
|
25
42
|
|
|
26
43
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
44
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
45
|
|
|
36
|
-
|
|
46
|
+
### How to Use
|
|
47
|
+
|
|
48
|
+
- [Initial Setup](../../workdocs/tutorials/For%20Developers.md#_initial-setup_)
|
|
49
|
+
- [Installation](../../workdocs/tutorials/For%20Developers.md#installation)
|
|
50
|
+
|
|
51
|
+
|
|
37
52
|
|
|
38
|
-
### Related
|
|
39
53
|
|
|
40
|
-
|
|
54
|
+
### Related
|
|
41
55
|
|
|
56
|
+
[](https://github.com/decaf-ts/decaf-ts)
|
|
57
|
+
[](https://github.com/decaf-ts/decorator-validation)
|
|
58
|
+
[](https://github.com/decaf-ts/db-decorators)
|
|
42
59
|
|
|
43
|
-
[](https://github.com/TiagoVenceslau/decorator-validation)
|
|
44
|
-
[](https://github.com/TiagoVenceslau/db-decorators)
|
|
45
|
-
[](https://github.com/TiagoVenceslau/dsu-blueprint)
|
|
46
60
|
|
|
47
61
|
### Social
|
|
48
62
|
|
|
49
|
-
[](https://www.linkedin.com/in/
|
|
63
|
+
[](https://www.linkedin.com/in/decaf-ts/)
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
#### Languages
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
## Getting help
|
|
76
|
+
|
|
77
|
+
If you have bug reports, questions or suggestions please [create a new issue](https://github.com/decaf-ts/ts-workspace/issues/new/choose).
|
|
78
|
+
|
|
79
|
+
## Contributing
|
|
80
|
+
|
|
81
|
+
I am grateful for any contributions made to this project. Please read [this](./workdocs/98-Contributing.md) to get started.
|
|
82
|
+
|
|
83
|
+
## Supporting
|
|
84
|
+
|
|
85
|
+
The first and easiest way you can support it is by [Contributing](./workdocs/98-Contributing.md). Even just finding a typo in the documentation is important.
|
|
86
|
+
|
|
87
|
+
Financial support is always welcome and helps keep both me and the project alive and healthy.
|
|
88
|
+
|
|
89
|
+
So if you can, if this project in any way. either by learning something or simply by helping you save precious time, please consider donating.
|
|
90
|
+
|
|
91
|
+
## License
|
|
50
92
|
|
|
51
|
-
|
|
93
|
+
This project is released under the [MIT License](./LICENSE.md).
|
|
52
94
|
|
|
53
|
-
|
|
95
|
+
By developers, for developers...
|