Skip to main content

Angular Sample To Generate QR Code Using @techiediaries/ngx-qrcode


In this article, we are going to explore and implement a QR Code generator in the angular application using @techiediaries/ngx-qrcode library.

QR Code:

The quick response, or QR, Code is a two-dimensional version of the BarCode able to convey a wide variety of information almost instantly with the scan of a mobile device.

An Overview On @techiediaries/ngrx-qrcode And It's Configurations:

The @techiediaries/ngrx-qrcode is the angular library to generate a QR Code in an angular application.
The 'NgxQRCodeModule' is QR Code angular module, that will be imported from the '@tehiediaries/ngrx-qrcode'. Using this library we can set up the QRCode generator angular component with basic configuration values. All the configurations are accepted as 'Input()' directive values of the QR Code component. Configuration input parameters are as follows:
  • elementType - this input parameter is used to define the rendering type of QR Code whether like an Image or Canvas.
  • cssClass - this input parameter to add custom CSS class.
  • alt - this input parameter to render string value in case of failed render code.
  • value - this input parameter accepts our secret data or value which will be encrypted and render in QR Code. This is the QR Scanner going to get on scanning our QR Code.
  • version - this represents the version number.
  • errorCorrectionLevel - this input parameter is to define the level of damage to the QR Code. Based on this level QL code image will be generated, by any reason image got damaged or defaced then also QR code scanner can able to scan it.
  • margin - this input parameter defines the margin around the QR Code around it.
  • scale - this input parameter to resize or scale the lines in the QR Code.
  • width- this input parameter to define the size to render the QR Code image.
  • colorDark - this input parameter to define the color of the lines of the QR Code.
  • colorLight - this input parameter to define the background color of the QR Code.

Create An Angular Sample Application:

To implement a QR Code generator let's begin by creating an angular sample application.
Command To Install Angular CLI:(If not installed on your system previously)

npm install -g @angular/cli
Angular CLI Command To Create Angular App:

ng new your_project_name
Command To Run App:

ng serve

Install QR Code NPM Package:

To integrate the QR Code generator we need to install '@techiediaries/ngx-qrcode' third-party library.
Command To Install QR Code:

npm install @techiediaries/ngx-qrcode --save
After running the command check for its presence in the 'dependencies' property in package.json as below.

Add NgxQRCodeModule Into AppModule:

Now import NgxQRCodeModule into AppModule to make QR Code features available at the time of application starts.
src/app.module.ts:
import { NgxQRCodeModule } from '@techiediaries/ngx-qrcode';
// code hidden for display purpose

@NgModule({
  imports: [NgxQRCodeModule]
})
export class AppModule {}

Declare QR Code Component:

Let's add the QR Code component HTML tab in the app.component.html file as below.
src/app.component.html:
<ngx-qrcode [value]='value'></ngx-qrcode>
'[value]' input property it accepts that secret data stored by QR Code. This data will be the heart of the QR Code. The QR Code scanner will fetch this data on scanning.
src/app.component.ts:
export class AppComponent {
  value = 'This is my barcode secret data';
}
'value' variable that contains the data for our bar code.

Now run the application and the QR Code appears as below.

And use the scanner on your mobile, we can download free scanners also to use. After scanning you can observe the output as below.

elementType Input Property:

elementType Input property of QR Code component to define whether to render the QR Code as Image or Canvas. The '@techiediaries/ngx-code' provides enum with 3 different values like:
  • NgxQrCodeElementTypes.URL,
  • NgxQrCodeElementTypes.IMG,
  • NgxQrCodeElementTypes.CANVAS
Enum types 'URL', 'IMG' both render image tag with src value as base64 image(Note: don't know why they provided 2 types of enum type for same type rendering). By default QR Code component render with of elementType value with 'URL'.

Let's generate the Canvas image for QR Code.
src/app.component.ts:
import { NgxQrcodeElementTypes } from '@techiediaries/ngx-qrcode';
// some code hidden for display purpos
export class AppComponent {
  value = 'This is my barcode secret data';
  elementType = NgxQrcodeElementTypes.CANVAS;
}
  • (Line: 1) imported 'NgxQrCodeElementTypes' enum from '@techiediaries/ngx-qrcode' library.
  • (Line: 5) for 'elementType' variable assigns the value of 'CANVAS'.
src/app.component.html:
<ngx-qrcode 
[value]='value' 
[elementType]='elementType'
></ngx-qrcode>
  • (Linet: 3) '[elementType]' input directive declared.
Now run the application and open chrome browser developer's tools to check rendered HTML output.

errorCorrectionLevel Input Propery:

QR Codes in the physical environment is their ability to sustain "damage" and continue to function even when the part of the QR Code image is obscured, defaced, or removed. So we can determine or set the QR Code image to work with a range of parameters using the 'error correction level'.

There are 4 error correction levels used for QR codes, with each one adding different amounts of "backup" data depending on how much damage the QR code is expected to suffer in its intended environment, and hence how much error correction may be required.
  • Level L- up to 7% damage.
  • Level M - up to 15% damage.
  • Level Q - up to 25% damage.
  • Level H - up to 30% damage.
The '@techiediaries/ngx-qrcode' library provides enum like 'NgxQrcodeErrorCorrectionLevels' with 4  values like:
  • NgxQrcodeErrorCorrectionLevels.LOW
  • NgxQrcodeErrorCorrectionLevels.MEDIUM
  • NgxQrcodeErrorCorrectionLevels.QUARTILE
  • NgxQrcodeErrorCorrectionLevels.HIGH
Default value used by QR Code component for 'errorCorrectionLevel' property is 'NgxQrcodeErrorCorrectionLevels.MEDIUM'. To change the default value do as below.
src/app.component.ts:
import { NgxQrcodeErrorCorrectionLevels } from '@techiediaries/ngx-qrcode';

export class AppComponent {
  value = 'This is my barcode secret data';
  errorCorrectionLevel = NgxQrcodeErrorCorrectionLevels.HIGH
}
src/app.component.html:
<ngx-qrcode 
[value]='value' 
[errorCorrectionLevel] = 'errorCorrectionLevel'

></ngx-qrcode>

From the above image, we can observe an increase in damage level the change in the scales of the QR Code.

margin Input Property:

'margin' input property applies the margin for QR Code image rendering. The default value set for 'margin' property is '4'.
src/app.component.ts:
export class AppComponent {
  value = 'This is my barcode secret data';
  margin = 80;
}
src/app.component.html:
<ngx-qrcode 
[value]='value' 
[margin] = 'margin'
></ngx-qrcode>

scale Input Property:

'scale' input property helps to increase or reduce the lines or stripes or scales of the QR Code. The default 'scale' was set to '4'.
src/app.component.ts:
export class AppComponent {
  value = 'This is my barcode secret data';
  scale = 15
}
src/app.component.html:
<ngx-qrcode 
[value]='value' 
[scale]='scale'

></ngx-qrcode>

colorDark Input Property:

'colorDark' input property to change scales or lines of the QRCode. The default 'colorDark' set to 'black' color.
src/app.component.ts:
export class AppComponent {
  value = 'This is my barcode secret data';
  redColor = '#FF0000'
}
src/app.component.html:
<ngx-qrcode 
[value]='value' 
[colorDark]='redColor'

></ngx-qrcode>

colorLight Input Property:

'colorLight' input property is used to change the background color of the QR Code. The default background color is white.
src/app.component.ts:
export class AppComponent {
  value = 'This is my barcode secret data';
  backgroundColor = '#33BBFF'
}
src/app.component.html:
<ngx-qrcode 
[value]='value' 
[colorLight]='backgroundColor'

></ngx-qrcode>

Wrapping Up:

Hopefully, I think this article delivered some useful information on creating a QR Code generator in Angular application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Support Me!
Buy Me A Coffee PayPal Me

Follow Me:

Comments

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

NestJS File Upload

In this article, we are going to understand the steps to create a file uploading endpoint in the NestJS application. Key Features In NestJS File Upload: Let us know some key features of NestJS file upload before implementing a sample application. FileInterceptor: The 'FileInterceptor' will be decorated on top of the file upload endpoint. This interceptor will read single file data from the form posted to the endpoint. export declare function FilesInterceptor(fieldName: string, localOptions?: MulterOptions): Type<NestInterceptor>; Here we can observe the 'fieldName' first input parameter this value should be a match with our 'name' attribute value on the form file input field. So our interceptor read our files that are attached to the file input field. Another input parameter of 'MulterOptions' that provides configuration like file destination path, customizing file name, etc. FilesInterceptor: The 'FilesInterceptor' will be decorated on t

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http