{"id":16382704,"url":"https://github.com/kevlatus/ngx-drawer-layout","last_synced_at":"2025-04-07T22:29:57.680Z","repository":{"id":35033830,"uuid":"170583711","full_name":"kevlatus/ngx-drawer-layout","owner":"kevlatus","description":"Angular library for implementing a Material drawer layout.","archived":false,"fork":false,"pushed_at":"2023-01-07T11:05:18.000Z","size":6337,"stargazers_count":1,"open_issues_count":22,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T02:12:35.011Z","etag":null,"topics":["angular","angular-material","drawer","drawer-layout","layout","material-design"],"latest_commit_sha":null,"homepage":"https://kevlatus.github.io/ngx-drawer-layout","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevlatus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-13T21:40:28.000Z","updated_at":"2021-10-15T15:51:15.000Z","dependencies_parsed_at":"2023-01-15T12:30:25.880Z","dependency_job_id":null,"html_url":"https://github.com/kevlatus/ngx-drawer-layout","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevlatus%2Fngx-drawer-layout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevlatus%2Fngx-drawer-layout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevlatus%2Fngx-drawer-layout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevlatus%2Fngx-drawer-layout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevlatus","download_url":"https://codeload.github.com/kevlatus/ngx-drawer-layout/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247202551,"owners_count":20900799,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-material","drawer","drawer-layout","layout","material-design"],"created_at":"2024-10-11T04:06:06.934Z","updated_at":"2025-04-07T22:29:57.664Z","avatar_url":"https://github.com/kevlatus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca target=\"_blank\" href=\"https://www.npmjs.com/package/ngx-drawer-layout\"\u003e![](https://img.shields.io/npm/v/ngx-drawer-layout.svg)\u003c/a\u003e\n[![Build Status](https://github.com/kevlatus/ngx-drawer-layout/workflows/Test/badge.svg)](https://github.com/kevlatus/ngx-drawer-layout/actions)\n[![Coverage Status](https://coveralls.io/repos/github/kevlatus/ngx-drawer-layout/badge.svg?branch=main)](https://coveralls.io/github/kevlatus/ngx-drawer-layout?branch=main)\n\n# Angular Drawer Layout\n\nThis library provides [Angular](https://angular.io/) components for implementing a\n[Material Design Drawer](https://material.io/design/components/navigation-drawer.html).\nIt relies on the [Angular Material Library](https://material.angular.io/).\n\nCheck out [this demo](https://kevlatus.github.io/ngx-drawer-layout/) to see it in action.\n\n## Installing\n\nBefore installing, make sure to add Angular Material to your project. When using Angular CLI, you can run:\n\n```\nng add @angular/material\n```\n\nFor alternative installation refer to the [quick start guide](https://material.angular.io/guide/getting-started).\n\nUsing npm, you can install the library with:\n\n```\nnpm install --save ngx-drawer-layout\n```\n\n### Enabling Material theming\n\nIf you want to benefit from Material theming, you need to use Angular Material\nwith [a custom theme](https://material.angular.io/guide/theming#defining-a-custom-theme).\nThen, you can add theming to the drawer layout like this:\n\n```scss\n@import '~@angular/material/theming';\n@import '~ngx-drawer-layout/theming'; // \u003c-- include SASS lib file\n\n@include mat-core();\n\n$primary: mat-palette($mat-indigo);\n$accent: mat-palette($mat-pink, A200, A100, A400);\n$warn: mat-palette($mat-red);\n$theme: mat-light-theme($primary, $accent, $warn);\n\n@include angular-material-theme($theme);\n@include ngx-drawer-layout-theme($theme); // \u003c-- include the drawer layout theme\n```\n\n## Usage\n\n**1. Import the DrawerLayoutModule**\n\n```javascript\nimport { BrowserModule } from '@angular/platform-browser';\nimport { NgModule } from '@angular/core';\nimport { DrawerLayoutModule } from 'ngx-drawer-layout';\n\n@NgModule({\n  imports: [\n    BrowserModule,\n    DrawerLayoutModule, // \u003c-- import module\n  ],\n  bootstrap: [AppComponent],\n})\nexport class AppModule {}\n```\n\n**2. Use the DrawerLayoutComponent**\n\n```html\n\u003cngx-drawer-layout\u003e\n  \u003cmat-toolbar ngxDrawerLayoutHeader\u003e\n    \u003cbutton ngxDrawerToggle\u003eToggle\u003c/button\u003e\n    \u003cdiv\u003eNGX Drawer Layout Demo\u003c/div\u003e\n  \u003c/mat-toolbar\u003e\n\n  \u003cdiv ngxDrawer\u003e\n    \u003cdiv\u003eDrawer Content\u003c/div\u003e\n  \u003c/div\u003e\n\n  \u003cdiv ngxDrawerLayoutContent\u003e\n    \u003cdiv\u003eApp Content\u003c/div\u003e\n  \u003c/div\u003e\n\u003c/ngx-drawer-layout\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevlatus%2Fngx-drawer-layout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevlatus%2Fngx-drawer-layout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevlatus%2Fngx-drawer-layout/lists"}