Angular PrimeNG Sidebar Size

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 Sidebar Size in Angular PrimeNG. We will also learn about the properties along with their syntaxes that will be used in the code.

The Sidebar component is used to make an element that overlays at the edges of the screen. Sidebar size can be used to adjust the size of the sidebar using the fixed values or by using the already defined values as p-sidebar–sm, p-sidebar-md, and p-sidebar-lg.

Syntax:

<p-sidebar 
    [(visible)]="display" 
    styleClass="...."
    [style]="{width:'...'}">
</p-sidebar>

<p-button 
    (click)="..."
    label="...">
</p-button>

Angular PrimeNG Sidebar Size Properties:

• visible: It specifies the visibility of the dialog. It is of the boolean data type, the default value is false.
• styleClass: It is used to set the style class of the component. It is of string data type & the default value is null.
• style: It is used to set the inline style of the component. It is of string data type & the default value is null.

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:

• Run the below command to see the output:

ng serve --open

Example 1: Below is the example code that illustrates the use of the Angular PrimeNG Sidebar Size using already defined values.

app.component.html

<h1 style="color: green">GeeksforGeeks</h1>
<h5>Angular PrimeNG Sidebar Size</h5>

<p-sidebar
    [(visible)]="gfg1"
    styleClass="p-sidebar-sm">
    <h2>This is small sidebar</h2>

    <p-button
          type="button"
          (click)="gfg1 = false"
          label="OK"
          styleClass="p-button-info">
    </p-button>

    <p-button
          type="button"
          (click)="gfg1 = false"
          label="Cancel"
          styleClass="p-button-danger p-ml-2">
    </p-button>
</p-sidebar>


<p-sidebar
   [(visible)]="gfg2"
   styleClass="p-sidebar-md">
  <h2>This is Medium Sidebar</h2>

  <p-button
        type="button"
        (click)="gfg2 = false"
        label="OK"
        styleClass="p-button-info">
  </p-button>

  <p-button
        type="button"
        (click)="gfg2 = false"
        label="Cancel"
        styleClass="p-button-danger p-ml-2">
  </p-button>
</p-sidebar>


<p-sidebar
    [(visible)]="gfg3"
    styleClass="p-sidebar-lg">
    <h2>This is Large Sidebar</h2>

    <p-button
          type="button"
          (click)="gfg3 = false"
          label="OK"
          styleClass="p-button-info">
    </p-button>

    <p-button
          type="button"
          (click)="gfg3 = false"
          label="Cancel"
          styleClass="p-button-danger p-ml-2">
    </p-button>
</p-sidebar>

<p-button
      (click)="gfg1 = true"
      label="Small Sidebar!">
</p-button>

<p-button
      (click)="gfg2 = true"
      label="Medium Sidebar!"
      styleClass="p-mx-2">
</p-button>

<p-button
      (click)="gfg3 = true"
      label="Large Sidebar!">
</p-button>

app.component.ts

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

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.scss']
})

export class AppComponent {}

app.module.ts

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { ButtonModule } from "primeng/button";
import { SidebarModule } from "primeng/sidebar";

@NgModule({
imports: [
    BrowserModule,
    BrowserAnimationsModule,
    SidebarModule,
    ButtonModule,
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})

export class AppModule {}

Output:

Example 2: Below is another example code that illustrates the use of the Angular PrimeNG Sidebar Size using fixed values.

app.component.html

<h1 style="color: green">GeeksforGeeks</h1>
<h5>Angular PrimeNG Sidebar Size</h5>

<p-sidebar
    [(visible)]="gfg"
    [style]="{width:'60em'}">
    <h2>This is sidebar has 60em size</h2>

    <p-button
          type="button"
          (click)="gfg = false"
          label="OK"
          styleClass="p-button-info">
    </p-button>

    <p-button
          type="button"
          (click)="gfg = false"
          label="Cancel"
          styleClass="p-button-danger p-ml-2">
    </p-button>
</p-sidebar>

<p-button
        (click)="gfg = true"
        label="Small Sidebar!">
</p-button>

app.component.ts

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

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.scss']
})
export class AppComponent {}

app.module.ts

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { BrowserAnimationsModule }
    from "@angular/platform-browser/animations";
import { AppComponent } from "./app.component";
import { ButtonModule } from "primeng/button";
import { SidebarModule } from "primeng/sidebar";

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    SidebarModule,
    ButtonModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})

export class AppModule {}

Output:

Reference: https://primefaces.org/primeng/sidebar