Angular PrimeNG InputSwitch Component

Angular PrimeNG is an open-source framework with a rich set of native Angular UI components that are used for great styling and this framework is used to make responsive websites with very much ease. In this article, we will know how to use the InputSwitch component in Angular PrimeNG. We will learn about the properties, events & styling along with their syntaxes that will be used in the code.

InputSwitch component: It allows a user to make a switch between the two values ie, selecting either of the values by toggle it.

Properties:

• style: It is used to set the inline style of the element. It is of string data type, the default value is null.
• styleClass: It is used to set the style class of the element. It is of string data type, the default value is null.
• tabindex: It is used to set the index of the element in tabbing order. It is of number datatype, the default value is null.
• inputId: It is an ID identifier of the underlying input element. It is of string data type, the default value is null.
• name: It is used to set the name of the input element. It is of string data type, the default value is null.
• ariaLabelledBy: This property establishes relationships between the component and label(s) where its value should be one or more element IDs. It is of string data type, the default value is null.
• disabled: It specifies that the element should be disabled. It is of the boolean datatype, the default value is false.
• readonly: it specifies that the component cannot be edited. It is of the boolean datatype, the default value is false.

Event:

• onChange: It is a callback that is fired on state change.

Styling:

• p-inputswitch: It is a container element.
• p-inputswitch-checked: It is a container element in the active state.
• p-inputswitch-slider: It is a slider element behind the handle.

Creating Angular application & module installation:

• Step 1: Create an Angular application using the following command.

  ng new appname

• Step 2: After creating your project folder i.e. appname, move to it using the following command.

  cd appname

• Step 3: Install PrimeNG in your given directory.

  npm install primeng --save
  npm install primeicons --save

Project Structure: It will look like the following:

Example 1: This is the basic example that shows how to use the InputSwitch component.

app.component.html

<h2>GeeksforGeeks</h2>
<h5>PrimeNG InputSwitch component</h5>
<p-inputSwitch></p-inputSwitch>

app.component.ts

import { Component } from "@angular/core";
import { MenuItem } from "primeng/api";

@Component({
  selector: "my-app",
  templateUrl: "./app.component.html",
})
export class AppComponent {}

app.module.ts

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { FormsModule } from "@angular/forms";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";

import { AppComponent } from "./app.component";
import { InputSwitchModule } from "primeng/inputswitch";

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    InputSwitchModule,
    FormsModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})
export class AppModule {}

Output:

Example 2: In this example, we are making an inputSwitch Preselecte, using disabled & read-only property.

app.component.html

<h2>GeeksforGeeks</h2>
<h5>PrimeNG InputSwitch Component</h5>
<p-inputSwitch [(ngModel)]="gfg"></p-inputSwitch>
<p-inputSwitch disabled="true"></p-inputSwitch>
<p-inputSwitch readonly="true"></p-inputSwitch>

app.component.ts

import { Component } from '@angular/core';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html'
})
export class AppComponent {
  gfg: boolean = true;
}

app.module.ts

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { FormsModule } from "@angular/forms";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";

import { AppComponent } from "./app.component";

import { InputSwitchModule } from "primeng/inputswitch";

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    InputSwitchModule,
    FormsModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})
export class AppModule {}

Output:

Reference: https://primefaces.org/primeng/showcase/#/inputswitch