{"id":18615054,"url":"https://github.com/andrewjbateman/angular-material-nav","last_synced_at":"2025-10-26T16:41:14.971Z","repository":{"id":39880620,"uuid":"186994727","full_name":"AndrewJBateman/angular-material-nav","owner":"AndrewJBateman","description":":clipboard: Angular app using Angular Material \u0026 Angular Material Schematics to create a responsive side navigation menu.","archived":false,"fork":false,"pushed_at":"2023-02-03T04:53:00.000Z","size":3890,"stargazers_count":5,"open_issues_count":9,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T06:51:16.485Z","etag":null,"topics":["angular","angular-material","angular-material15","angular15","breakpoint","css3","material","material-design","nav","observable","tutorial-code","typescript3"],"latest_commit_sha":null,"homepage":"","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/AndrewJBateman.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-05-16T09:19:47.000Z","updated_at":"2024-08-02T17:56:30.000Z","dependencies_parsed_at":"2023-02-18T03:15:45.895Z","dependency_job_id":null,"html_url":"https://github.com/AndrewJBateman/angular-material-nav","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewJBateman%2Fangular-material-nav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewJBateman%2Fangular-material-nav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewJBateman%2Fangular-material-nav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrewJBateman%2Fangular-material-nav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndrewJBateman","download_url":"https://codeload.github.com/AndrewJBateman/angular-material-nav/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248322238,"owners_count":21084333,"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","angular-material15","angular15","breakpoint","css3","material","material-design","nav","observable","tutorial-code","typescript3"],"created_at":"2024-11-07T03:27:57.793Z","updated_at":"2025-10-26T16:41:14.899Z","avatar_url":"https://github.com/AndrewJBateman.png","language":"TypeScript","readme":"# :zap: Angular Material Nav\n\n* Angular app using [Angular Material](https://material.angular.io/) \u0026 [Angular Material Schematics](https://material.angular.io/guide/schematics) to create a responsive side navigation menu.\n* **Note:** to open web links in a new window use: _ctrl+click on link_\n\n![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/angular-material-nav?style=plastic)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/angular-material-nav?style=plastic)\n![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/angular-material-nav?style=plastic)\n![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/angular-material-nav?style=plastic)\n\n## :page_facing_up: Table of contents\n\n* [:zap: Angular Material Nav](#zap-angular-material-nav)\n  * [:page\\_facing\\_up: Table of contents](#page_facing_up-table-of-contents)\n  * [:books: General info](#books-general-info)\n  * [:camera: Screenshots](#camera-screenshots)\n  * [:signal\\_strength: Technologies](#signal_strength-technologies)\n  * [:floppy\\_disk: Setup](#floppy_disk-setup)\n  * [:computer: Code Examples](#computer-code-examples)\n  * [:cool: Features](#cool-features)\n  * [:clipboard: Status \\\u0026 To-Do List](#clipboard-status--to-do-list)\n  * [:clap: Inspiration](#clap-inspiration)\n  * [:file\\_folder: License](#file_folder-license)\n  * [:envelope: Contact](#envelope-contact)\n\n## :books: General info\n\n* Sidenav menu with profile image and menu options is shown on lhs when in full-screen mode (\u003e700px - tablet size). Otherwise it is hidden and only shows when the burger menu icon is pressed\n* Sidenav menu is hidden at a screen width of 700px or less using an observable to compare 700px with actual screen width - see Code Example below\n* Profile image is a random female facial image that changes each time app is started or refreshed\n* [AfterViewInit interface lifecycle hook](https://angular.io/api/core/AfterViewInit) used once components view is instantiated\n\n## :camera: Screenshots\n\n![Example screenshot](./img/nav.png)\n\n## :signal_strength: Technologies\n\n* [Angular v15](https://angular.io/) JS framework\n* [Angular Material v15](https://material.angular.io/)\n* [Material Design Screen breakpoints](https://material.io/design/layout/responsive-layout-grid.html#breakpoints) \u0026 [Angular Breakpoint state](https://material.angular.io/cdk/layout/api) used to determine when side menu appears\n* [Angular Material Sidenav](https://material.angular.io/components/sidenav/overview) modes are default 'over', 'side' and 'push'. Accessibility: add role attribute\n* [Angular Material Icons](https://www.angularjswiki.com/angular/angular-material-icons-list-mat-icon-list/) list of icons, categorized but not searchable\n* [Unsplash random face image](https://unsplash.com/developers) used for profile\n\n## :floppy_disk: Setup\n\n* Run `npm i` to install dependencies.\n* Create [Unsplash account](https://unsplash.com/developers) and paste API key in `environment.ts`\n* Run `ng serve` for a dev server.\n* Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.\n* `npm run build` to create build file with Ahead of Time (AOT) compilation. Source map explorer set to false\n\n## :computer: Code Examples\n\n* `navigation.component.ts` nav component showing use of observable that is set true or false and controls if sidebar menu open or closed\n\n```typescript\n// breakpoint observer checks if width is over 700px.\n// If so use 'over' mode and close side nav\n// If less than 700px use 'side' mode \u0026 open side nav\nngAfterViewInit() {\n  this.observer\n    .observe([\"(max-width: 700px)\"])\n    .pipe(delay(1)) // delay 1mS\n    .subscribe((res) =\u003e {\n      if (res.matches) {\n        this.sidenav.mode = \"over\";\n        this.sidenav.close();\n      } else {\n        this.sidenav.mode = \"side\";\n        this.sidenav.open();\n      }\n    });\n}\n```\n\n## :cool: Features\n\n* sidebar collapses to burger when screen width \u003c 700px (small tablet). App doesn't do much else - just demonstrates @angular breakpointObserver.\n* [Angular breakpoints using the Material design system explained here](https://material.angular.io/cdk/layout/overview)\n\n## :clipboard: Status \u0026 To-Do List\n\n* Status: Working.\n* To-Do: Nothing\n\n## :clap: Inspiration\n\n* [Angular Material Breakpoint documentation](https://material.angular.io/cdk/layout/api)\n\n## :file_folder: License\n\n* This project is licensed under the terms of the MIT license.\n\n## :envelope: Contact\n\n* Repo created by [ABateman](https://github.com/AndrewJBateman), email: gomezbateman@yahoo.com\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewjbateman%2Fangular-material-nav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrewjbateman%2Fangular-material-nav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrewjbateman%2Fangular-material-nav/lists"}