-
-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add angular 18 compatibility note
- Loading branch information
Showing
2 changed files
with
39 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,26 +2,24 @@ | |
|
||
`angularx-qrcode` - a fast and easy-to-use Ivy compatible Ionic and Angular QR Code Generator library | ||
|
||
- [Features](#features) | ||
- [Installation](#installation) | ||
- [Demo App](#demo-app) | ||
- [Usage & Example Implementations](#usage-and-example-implementations) | ||
- [Available Parameters](#available-parameters) | ||
- [Contribute](#contribute) | ||
- [Sponsoring](#sponsoring) | ||
- [License](#license) | ||
|
||
## Features | ||
|
||
- Compatible with **Angular** and Ionic | ||
- Compatible with **Angular 18** and **Ionic** | ||
- Ivy compiler support, AOT, SSR (Server Side Rendering) | ||
- Under active development | ||
- Accessibility (a11y) attributes supported (alt, aria-label, title) | ||
- Support for images | ||
- Trusted and used by thousands of developers like you | ||
- Easy to use, [sample web app](#demo-app) included | ||
|
||
`angularx-qrcode` is compatible with Ionic 3/4/5/6/7/8 and Angular 4/5/6/7/8/9/10/11/12/13/14/15/16/17/18+ with support for the Ivy compiler. It is a drop-in replacement for the no-longer-maintained angular component ng2-qrcode and based on node-qrcode. | ||
|
||
- [Installation](#installation) | ||
- [Demo App](#demo-app) | ||
- [Usage & Example Implementations](#usage-and-example-implementations) | ||
- [Available Parameters](#available-parameters) | ||
- [Contribute](#contribute) | ||
- [Sponsoring](#sponsoring) | ||
- [License](#license) | ||
|
||
## Installation | ||
|
||
**Angular 18 and Ionic with angularx-qrcode 18** | ||
|
@@ -48,36 +46,31 @@ npm install [email protected] --save | |
yarn add [email protected] | ||
``` | ||
|
||
**Older supported angular versions** | ||
|
||
``` | ||
# angular 15 and Ionic | ||
npm install [email protected] --save | ||
# angular 14 and Ionic | ||
npm install [email protected] --save | ||
# angular 13 and Ionic | ||
npm install [email protected] --save | ||
# angular 12 and Ionic | ||
npm install [email protected] --save | ||
# angular 11 and Ionic | ||
npm install [email protected] --save | ||
# angular 10 and Ionic | ||
npm install [email protected] --save | ||
# angular 9 and Ionic | ||
npm install angularx-qrcode@~2.3.7 --save | ||
# angular 8 and Ionic | ||
npm install angularx-qrcode@~2.1.4 --save | ||
# angular 5/6/7 | ||
npm install [email protected] --save | ||
# Angular 4 | ||
npm install [email protected] --save | ||
``` | ||
**All supported angular versions** | ||
|
||
| Angular Version | angularx-qrcode Version | | ||
| --------------- | ----------------------- | | ||
| ^18 | ^18.0.2 | | ||
| ^17 | ^17.0.1 | | ||
| ^16 | ^16.0.2 | | ||
| ^15 | ^15.0.1 | | ||
| ^14 | ^14.0.0 | | ||
| ^13 | ^13.0.15 | | ||
| ^12 | ^12.0.3 | | ||
| ^11 | ^11.0.0 | | ||
| ^10 | ^10.0.12 | | ||
| ^9 | ^2.3.7 | | ||
| ^8 | ^2.1.4 | | ||
| ^5 / ^6 / ^7 | ^1.6.4 | | ||
| ^4 | ^1.0.3 | | ||
|
||
# Demo App | ||
|
||
**[Working online demo of Angular QR Code Generator](https://cordobo.github.io/angularx-qrcode/)** | ||
|
||
The source for the demo angular app is available in [`projects/demo-app`](projects/demo-app). Run the command | ||
The source for the working angular app is available in [`projects/demo-app`](projects/demo-app). | ||
|
||
Run the command: | ||
|
||
``` | ||
npm start | ||
|