11<div align =" center " >
22 <a href =" https://www.ProAngular.com " target =" _blank " >
3- <img src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/public/images/pro-angular-logo.png" />
3+ <img
4+ src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/public/images/pro-angular-logo.png"
5+ />
46 </a >
57 <h1 align =" center " >
6- <a href="https://www.ProAngular.com" target="_blank">Pro Angular</a>: Form Components
8+ @proangular/pro-form
79 </h1 >
8- <a href =" https://github.com/ProAngular/pro-form " target =" _blank " >
9- View Github Repository
10- </a >
1110 <p align =" center " >
12- An abstraction of Angular Material form controls that speeds up form building with drop in, standalone inputs, unified labels, hints, and errors, plus helpers like scroll to first error and focus on invalid. Built for modern Angular and plugs straight into Reactive Forms to cut boilerplate.
11+ <a href="https://www.ProAngular.com" target="_blank">
12+ ProAngular
13+ </a> |
14+ <a href="https://github.com/ProAngular/pro-form" target="_blank">
15+ GitHub Repo
16+ </a> |
17+ <a href="https://www.npmjs.com/@proangular/pro-form" target="_blank">
18+ NPM Package
19+ </a> |
20+ <a href="https://www.ProAngular.com/demos/pro-form" target="_blank">
21+ Demo Page
22+ </a>
23+ </p >
24+ <p align =" center " >
25+ An abstraction of Angular Material form controls that speeds up form
26+ building with drop in, standalone inputs, unified labels, hints, and
27+ errors, plus helpers like scroll to first error and focus on invalid.
28+ Built for modern Angular and plugs straight into Reactive Forms to cut
29+ boilerplate.
1330 </p >
1431</div >
1532
1633<!-- -------------------------------------------------------------------------->
1734<!-- -------------------------------------------------------------------------->
1835<!-- -------------------------------------------------------------------------->
1936
20- [ ![ npm] ( https://badgen.net/badge/icon/npm?icon=npm&label )] ( https://www.npmjs.com/@proangular/pro-form )
21- [ ![ GitHub] ( https://badgen.net/badge/icon/GitHub?icon=github&label )] ( https://github.com/ProAngular/pro-form )
22- [ ![ TypeScript] ( https://badgen.net/badge/icon/TypeScript?icon=typescript&label )] ( https://github.com/ProAngular/pro-form/search?l=typescript )
23- [ ![ npm Version] ( https://badge.fury.io/js/@proangular%2Fngx-scroll-top.svg )] ( https://www.npmjs.com/@proangular/pro-form )
24- [ ![ Node Version] ( https://badgen.net/npm/node/@proangular/pro-form )] ( https://www.npmjs.com/@proangular/pro-form )
25- [ ![ Package Downloads] ( https://badgen.net/npm/dw/@proangular/pro-form )] ( https://www.npmjs.com/@proangular/pro-form )
26- [ ![ Size] ( https://img.shields.io/bundlephobia/minzip/@proangular/pro-form.svg )] ( https://bundlephobia.com/result?p=ProAngular/pro-form )
27- [ ![ Demo Status] ( https://badgen.net/badge/Demo/Online/green )] ( https://www.ProAngular.com/demos/pro-form )
28- [ ![ Website Status] ( https://img.shields.io/website?down_color=lightgrey&down_message=Offline&label=Website&up_color=green&up_message=Online&url=https%3A%2F%2Fwww.proangular.com )] ( https://www.proangular.com )
29- [ ![ Sponsors] ( https://img.shields.io/github/sponsors/proangular?label=Sponsors )] ( https://github.com/sponsors/ProAngular )
30- [ ![ License] ( https://img.shields.io/npm/l/express.svg?maxAge=2592000 )] ( /LICENSE )
31- [ ![ GitHub Package Status] ( https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-gpr.yml/badge.svg )] ( https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-gpr.yml )
32- [ ![ npmjs Package Status] ( https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-npmjs.yml/badge.svg )] ( https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-npmjs.yml )
37+ <p align =" center " >
38+ <a href =" https://www.npmjs.com/@proangular/pro-form " target =" _blank " >
39+ <img src="https://badge.fury.io/js/@proangular%2Fpro-form.svg" >
40+ </a >
41+ <a href =" https://bundlephobia.com/result?p=ProAngular/pro-form " target =" _blank " >
42+ <img src="https://img.shields.io/bundlephobia/minzip/@proangular/pro-form.svg" >
43+ </a >
44+ <a href =" /LICENSE " target =" _blank " >
45+ <img src="https://img.shields.io/npm/l/express.svg?maxAge=2592000" >
46+ </a >
47+ </p >
48+
49+ <!--
50+ <p align="center">
51+ <a href="https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-gpr.yml" target="_blank">
52+ <img src="https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-gpr.yml/badge.svg" >
53+ </a>
54+ <a href="https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-npmjs.yml" target="_blank">
55+ <img src="https://github.com/ProAngular/pro-form/actions/workflows/on-merge-main-deploy-npmjs.yml/badge.svg" >
56+ </a>
57+ </p>
58+ -->
3359
3460<!-- -------------------------------------------------------------------------->
3561<!-- -------------------------------------------------------------------------->
3662<!-- -------------------------------------------------------------------------->
3763
38- ## Index <a name =" index " ></a >
39-
40- - [ Preview] ( #preview )
41- - [ Description] ( #description )
42- - [ Installation] ( #installation )
43- - [ Prerequisites] ( #prerequisites )
44- - [ Install Pro Form Components] ( #install-pro-form-components )
45- - [ Usage] ( #usage )
46- - [ Compatibility] ( #compatibility )
47- - [ Development] ( #development )
48- - [ Licensing] ( #licensing )
49- - [ Wrapping Up] ( #wrapping-up )
64+ <p align =" center " >
65+ <code >ng add @proangular/pro-form </code >
66+ </p >
67+ <p align =" center " >
68+ <img src =" .github/images/screenshots/screenshot.png " />
69+ </p >
70+ <p align =" center " >
71+ <a href =" https://www.ProAngular.com/demos/pro-form " target =" _blank " >Click here to preview it live!</a >
72+ </p >
5073
5174<!-- -------------------------------------------------------------------------->
5275<!-- -------------------------------------------------------------------------->
5376<!-- -------------------------------------------------------------------------->
5477
55- ## Preview <a name =" preview " ></a >
56-
57- Preview the live demo below to see the Pro Form Components in action:
58-
59- https://www.ProAngular.com/demos/pro-form
78+ ## 📇 Index <a name =" index " ></a >
6079
61- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
80+ - [ 📄 Description] ( #description )
81+ - [ 📦 Installation] ( #installation )
82+ - [ 📋 Prerequisites] ( #prerequisites )
83+ - [ 📥 Install Pro Form Components] ( #install-pro-form-components )
84+ - [ 💻 Usage] ( #usage )
85+ - [ 🔄 Compatibility] ( #compatibility )
86+ - [ 🔨 Development] ( #development )
87+ - [ ⚖️ Licensing] ( #licensing )
88+ - [ 🏁 Wrapping Up] ( #wrapping-up )
6289
6390<!-- -------------------------------------------------------------------------->
6491<!-- -------------------------------------------------------------------------->
6592<!-- -------------------------------------------------------------------------->
6693
67- ## Description <a name =" description " ></a >
94+ ## 📄 Description <a name =" description " ></a >
6895
6996This project provides a collection of custom, reactive form components built
7097upon Angular Material. Designed for seamless integration into any Angular
@@ -106,18 +133,18 @@ Each component is designed to be easily customized and extended to meet your
106133specific needs. They are built using Angular Material and Angular CDK, ensuring
107134that they are accessible, responsive, and performant.
108135
109- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
136+ <p align =" right " >[ <a href =" #index " >🔍 Index</a > ]</p >
110137
111138<!-- -------------------------------------------------------------------------->
112139<!-- -------------------------------------------------------------------------->
113140<!-- -------------------------------------------------------------------------->
114141
115- ## Installation <a name =" installation " ></a >
142+ ## 📦 Installation <a name =" installation " ></a >
116143
117144Using Node Package Manager ([ NPM] [ url-node-js ] ) in a new terminal window run the
118145following commands to install the required dependencies.
119146
120- ### Prerequisites <a name =" prerequisites " ></a >
147+ ### 📋 Prerequisites <a name =" prerequisites " ></a >
121148
122149** Angular Material**
123150
@@ -128,7 +155,7 @@ https://material.angular.io/guide/theming
128155ng add @angular/material
129156```
130157
131- ### Install Pro Form Components <a name =" install-pro-form-components " ></a >
158+ ### 📥 Install Pro Form Components <a name =" install-pro-form-components " ></a >
132159
133160``` bash
134161ng add @proangular/pro-form@latest
140167npm install @proangular/pro-form --save
141168```
142169
143- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
170+ <p align =" right " >[ <a href =" #index " >🔍 Index</a > ]</p >
144171
145172<!-- -------------------------------------------------------------------------->
146173<!-- -------------------------------------------------------------------------->
147174<!-- -------------------------------------------------------------------------->
148175
149- ## Usage <a name =" usage " ></a >
176+ ## 💻 Usage <a name =" usage " ></a >
150177
151178Import one or all of the following custom form components to use in your Angular
152179application where used:
@@ -231,13 +258,13 @@ application where used:
231258> ![ Info] [ img-info ] See an the example form code [ here] [ url-example-form-code ] ,
232259> or a live demo [ here] [ url-demo ] .
233260
234- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
261+ <p align =" right " >[ <a href =" #index " >🔍 Index</a > ]</p >
235262
236263<!-- -------------------------------------------------------------------------->
237264<!-- -------------------------------------------------------------------------->
238265<!-- -------------------------------------------------------------------------->
239266
240- ## Compatibility <a name =" compatibility " ></a >
267+ ## 🔄 Compatibility <a name =" compatibility " ></a >
241268
242269| Angular version | @proangular/pro-form | Install |
243270| --------------- | -------------------- | ------------------------------- |
@@ -246,13 +273,13 @@ application where used:
246273| v18 | ------ | Untested |
247274| v17 | ------ | Untested |
248275
249- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
276+ <p align =" right " >[ <a href =" #index " >🔍 Index</a > ]</p >
250277
251278<!-- -------------------------------------------------------------------------->
252279<!-- -------------------------------------------------------------------------->
253280<!-- -------------------------------------------------------------------------->
254281
255- ## Development <a name =" development " ></a >
282+ ## 🔨 Development <a name =" development " ></a >
256283
257284Please submit all issues, and feature requests here:
258285[ https://github.com/ProAngular/pro-form/issues ] [ url-new-issue ]
@@ -281,26 +308,26 @@ Contribution:
281308
282309Thank you for any and all contributions!
283310
284- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
311+ <p align =" right " >[ <a href =" #index " >🔍 Index</a > ]</p >
285312
286313<!-- -------------------------------------------------------------------------->
287314<!-- -------------------------------------------------------------------------->
288315<!-- -------------------------------------------------------------------------->
289316
290- ## Licensing <a name =" licensing " ></a >
317+ ## ⚖️ Licensing <a name =" licensing " ></a >
291318
292319This project is licensed under the ** MIT** License. See the
293320[ LICENSE] ( LICENSE.md ) file for the pertaining license text.
294321
295322` SPDX-License-Identifier: MIT `
296323
297- <p align =" right " >[ <a href =" #index " >Index</a > ]</p >
324+ <p align =" right " >[ <a href =" #index " >🔍 Index</a > ]</p >
298325
299326<!-- -------------------------------------------------------------------------->
300327<!-- -------------------------------------------------------------------------->
301328<!-- -------------------------------------------------------------------------->
302329
303- ## Wrapping Up <a name =" wrapping-up " ></a >
330+ ## 🏁 Wrapping Up <a name =" wrapping-up " ></a >
304331
305332Thank you to the entire Angular team and community for such a great framework to
306333build upon. If you have any questions, please let me know by opening an issue
0 commit comments