Angular PrimeNG Slide Menu Properties

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 see how to use SlideMenu Properties in Angular PrimeNG. We will also learn about the properties, along with their syntaxes that will be used in the code.

The SlideMenu component is used to display the menu list in the form of a sliding animation which helps to see the menu items in a stepwise manner.

Angular PrimeNG Slide Menu Properties:

• model: It is an array of menu items. It accepts the array data type & the default value is null.
• popup: It defines if the menu would be displayed as a popup. It is of the boolean data type & the default value is false.
• style: It is an inline style of the component. It accepts the string data type & the default value is null.
• styleClass: It is the style class of the component. It accepts the string data type & the default value is null.
• easing: It is the animation to use for sliding. It accepts the string data type & the default value is ease-out.
• effectDuration: It is the duration of the sliding animation in milliseconds. It accepts any data type as input & the default value is 250.
• backLabel: It is the label of an element to navigate back. It accepts the string data type & the default value is back.
• menuWidth: It is the width of the submenus. It accepts the number data type as input & the default value is 180.
• viewportHeight: It is the height of the scrollable area, a scrollbar appears if a menu height is longer than this value. It accepts the number data type as input & the default value is 175.
• appendTo: It is the target element to attach the overlay, the valid values are “body” or a local ng-template variable of another element. It accepts any data type as input & the default value is null.
• baseZIndex: It is the base zIndex value to use in layering. It accepts the number data type as input & the default value is 0.
• autoZIndex: It specifies whether to automatically manage the layering. It is of the boolean data type & the default value is true.
• showTransitionOptions: These are the transition options to show the animation. It accepts the string data type & the default value is .12s cubic-bezier(0, 0, 0.2, 1).
• hideTransitionOptions: These are the transition options to hide the animation. It accepts the string data type & the default value is .1s linear.

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: After the complete installation, it will look like the following

Steps to run the application: To run the above file, run the below command:

ng serve --save

Example 1: This is the basic example that shows how to use Angular PrimeNG SlideMenu Properties.

• app.component.html:

HTML

<h1 style="color:green">GeeksforGeeks</h1>
<h5>PrimeNG SlideMenu Properties</h5>
<p-slideMenu [model]="gfg" ></p-slideMenu>

• app.component.ts:

Javascript

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

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

export class AppComponent {
    gfg: MenuItem[];

    ngOnInit() {
        this.gfg = [
            {
                label: 'Courses',
                icon: 'pi pi-pencil',
                items: [
                    {
                        label: 'DSA-Self Paced',
                    },
                    {
                        label: 'System Design',
                    },
                ],
            },
            {
                label: 'Tutorials',
                icon: 'pi pi-youtube',
                items: [
                    {
                        label: 'Angular Js',
                    },
                    {
                        label: 'React Js',
                    },
                ],
            },
            {
                label: 'Jobs',
                icon: 'pi pi-id-card',
                items: [
                    {
                        label: 'GfG Jobathon',
                    },
                    {
                        label: 'Post a Job',
                    },
                ],
            },
            {
                label: 'Practice',
                icon: 'pi pi-code',
                items: [
                    {
                        label: 'Problem of the day',
                    },
                    {
                        label: 'SDE Sheet',
                    },
                ],
            },
        ];
    }
}

• app.module.ts:

Javascript

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BrowserAnimationsModule }
    from '@angular/platform-browser/animations';
import { AppComponent }   from './app.component';
import { SlideMenuModule } from 'primeng/slidemenu';
import { ButtonModule } from 'primeng/button';

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

export class AppModule { }

Output:

Example 2: This is another basic example that shows how to use Angular PrimeNG SlideMenu Properties using a button popup.

• app.component.html:

HTML

<h1 style="color:green">GeeksforGeeks</h1>
<h5>PrimeNG SlideMenu Properties</h5>

<button #btn type="button" pButton
    label="GeeksforGeeks"
    (click)="menu.toggle($event)">
</button>

<p-slideMenu #menu
    [model]="gfg" [popup]="true"
    [viewportHeight]="250">
</p-slideMenu>

• app.component.ts:

Javascript

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

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

export class AppComponent {
    gfg: MenuItem[];

    ngOnInit() {
        this.gfg = [
            {
                label: 'Courses',
                icon: 'pi pi-pencil',
                items: [
                    {
                        label: 'DSA-Self Paced',
                    },
                    {
                        label: 'System Design',
                    },
                ],
            },
            {
                label: 'Tutorials',
                icon: 'pi pi-youtube',
                items: [
                    {
                        label: 'Angular Js',
                    },
                    {
                        label: 'React Js',
                    },
                ],
            },
            {
                label: 'Jobs',
                icon: 'pi pi-id-card',
                items: [
                    {
                        label: 'GfG Jobathon',
                    },
                    {
                        label: 'Post a Job',
                    },
                ],
            },
            {
                label: 'Practice',
                icon: 'pi pi-code',
                items: [
                    {
                        label: 'Problem of the day',
                    },
                    {
                        label: 'SDE Sheet',
                    },
                ],
            },
        ];
    }
}

• app.module.ts:

Javascript

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BrowserAnimationsModule }
    from '@angular/platform-browser/animations';
import { AppComponent }   from './app.component';
import { SlideMenuModule } from 'primeng/slidemenu';
import { ButtonModule } from 'primeng/button';

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

export class AppModule { }

Output:

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