Skip to content

[v19.0.1] Documentation updates. #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CodyTolene merged 1 commit into from
Feb 11, 2025
Merged

[v19.0.1] Documentation updates. #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 45 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<p align="center">
<a href="https://www.ProAngular.com" target="_blank">
<img src="public/images/pro-angular-logo.png" />
<img src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/public/images/pro-angular-logo.png" />
</a>
<h1 align="center">
<a href="https://www.ProAngular.com" target="_blank">Pro Angular</a>: Form Components
</h1>
</p>

<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->

[![npm](https://badgen.net/badge/icon/npm?icon=npm&label)](https://www.npmjs.com/@proangular/pro-form)
[![GitHub](https://badgen.net/badge/icon/GitHub?icon=github&label)](https://github.com/ProAngular/pro-form)
[![TypeScript](https://badgen.net/badge/icon/TypeScript?icon=typescript&label)](https://github.com/ProAngular/pro-form/search?l=typescript)
Expand All @@ -23,6 +27,10 @@
[![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)
[![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)

<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->

## Index <a name="index"></a>

- [Preview](#preview)
Expand Down Expand Up @@ -156,29 +164,47 @@ application where used:

...

// or component
// Or import to component
@Component({
...
imports: [
+ InputComponent,
...
],
})

...

// Then use in template
+ <form [formGroup]="formGroup">
+ <pro-input [formControl]="formGroup.controls.input" />
+ <pro-input-checkbox ... />
+ <pro-input-datepicker ... />
+ <pro-input-dropdown ... />
+ <pro-input-radio ... />
+ <pro-input-textarea ... />
+ <pro-input-timepicker ... />
+ <pro-input-toggle ... />
+ ...
+ </form>
```

> ![Info][img-info] See an the example form code [here][url-example-form-code],
> or a live demo [here][url-demo].

<p align="right">[ <a href="#index">Index</a> ]</p>

<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->

## Compatibility <a name="usage"></a>
## Compatibility <a name="compatibility"></a>

| Angular version | @proangular/pro-form | Status |
| --------------- | -------------------- | ---------- |
| v19 | v19.0.0 | Compatible |
| v18 | ------ | Untested |
| v17 | ------ | Untested |
| Angular version | @proangular/pro-form | Install |
| --------------- | -------------------- | ------------------------------- |
| v19 | v19.x.x | ng add @proangular/pro-form@^19 |
| v18 | ------ | Untested |
| v17 | ------ | Untested |

<p align="right">[ <a href="#index">Index</a> ]</p>

Expand Down Expand Up @@ -240,18 +266,23 @@ Thank you to the entire Angular team and community for such a great framework to
build upon. If you have any questions, please let me know by opening an issue
[here][url-new-issue].

| Type | Info |
| :------------------------------------------------------------------------ | :------------------------------------------------------------- |
| <img width="48" src=".github/images/ng-icons/email.svg" /> | webmaster@codytolene.com |
| <img width="48" src=".github/images/simple-icons/github.svg" /> | https://github.com/sponsors/CodyTolene |
| <img width="48" src=".github/images/simple-icons/buymeacoffee.svg" /> | https://www.buymeacoffee.com/codytolene |
| <img width="48" src=".github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |
| Type | Info |
| :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/.github/images/ng-icons/email.svg" /> | webmaster@codytolene.com |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/.github/images/simple-icons/github.svg" /> | https://github.com/sponsors/CodyTolene |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/.github/images/simple-icons/buymeacoffee.svg" /> | https://www.buymeacoffee.com/codytolene |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/.github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |

Fin. Happy programming friend!

Cody Tolene

<!-- LINKS -->

[img-info]:
https://raw.githubusercontent.com/ProAngular/pro-form/refs/heads/main/.github/images/ng-icons/info.svg
[url-demo]: https://www.ProAngular.com/demos/pro-form
[url-example-form-code]:
https://github.com/ProAngular/pro-form/blob/main/src/app/form/form.component.html
[url-new-issue]: https://github.com/ProAngular/pro-form/issues
[url-node-js]: https://nodejs.org/
2 changes: 1 addition & 1 deletion ng-package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
"lib": {
"entryFile": "src/app/public/public.ts"
},
"allowedNonPeerDependencies": ["@angular/material"]
"allowedNonPeerDependencies": []
}
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@proangular/pro-form",
"version": "19.0.0",
"version": "19.0.1",
"description": "A predefined set of reactive and reusable form input components based on Angular Material.",
"author": "Pro Angular <webmaster@proangular.com>",
"homepage": "https://www.proangular.com",
Expand Down