{"id":24910515,"url":"https://github.com/angular-material-extensions/pages","last_synced_at":"2025-07-13T17:09:59.447Z","repository":{"id":31713499,"uuid":"128675477","full_name":"angular-material-extensions/pages","owner":"angular-material-extensions","description":"Open source library for angular apps to illustrate custom material pages content with steps (ideal for tutorials and explanations purposes)","archived":false,"fork":false,"pushed_at":"2022-01-10T22:39:44.000Z","size":27454,"stargazers_count":51,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T10:04:07.786Z","etag":null,"topics":["angular","angular-apps","angular-library","explanation","material","material-components","material-design","material-extensions","material-ui","pages","turorial"],"latest_commit_sha":null,"homepage":"https://angular-material-extensions.github.io/pages","language":"CSS","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/angular-material-extensions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"angular-material-extensions","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":"npm/@angular-material-extensions/pages","community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://github.com/AnthonyNahas","anahas.de"]}},"created_at":"2018-04-08T19:38:19.000Z","updated_at":"2025-01-14T09:04:26.000Z","dependencies_parsed_at":"2022-08-07T16:30:53.714Z","dependency_job_id":null,"html_url":"https://github.com/angular-material-extensions/pages","commit_stats":null,"previous_names":["anthonynahas/ngx-material-pages"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/angular-material-extensions/pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Fpages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Fpages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Fpages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Fpages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/angular-material-extensions","download_url":"https://codeload.github.com/angular-material-extensions/pages/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Fpages/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265175567,"owners_count":23722661,"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-apps","angular-library","explanation","material","material-components","material-design","material-extensions","material-ui","pages","turorial"],"created_at":"2025-02-02T03:36:51.410Z","updated_at":"2025-07-13T17:09:59.427Z","avatar_url":"https://github.com/angular-material-extensions.png","language":"CSS","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg height=\"256px\" width=\"256px\" style=\"text-align: center;\" \n  src=\"https://cdn.jsdelivr.net/gh/angular-material-extensions/pages@master/assets/angular-material-extensions-logo.png\"\u003e\n\u003c/p\u003e\n\n\n# @angular-material-extensions/pages - Open source library for Angular Apps to illustrate custom material pages content with steps (ideal for tutorials and explanation purposes) - Angular V9 supported\n\n[![npm version](https://badge.fury.io/js/%40angular-material-extensions%2Fpages.svg)](https://badge.fury.io/js/%40angular-material-extensions%2Fpages)\n[![npm demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://angular-material-extensions.github.io/pages)\n[![Join the chat at https://gitter.im/angular-material-extensions/Lobby](https://badges.gitter.im/angular-material-extensions/Lobby.svg)](https://gitter.im/angular-material-extensions/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![CircleCI branch](https://img.shields.io/circleci/project/github/angular-material-extensions/pages/master.svg?label=circleci)](https://circleci.com/gh/angular-material-extensions/pages)\n[![Coverage Status](https://coveralls.io/repos/github/angular-material-extensions/pages/badge.svg?branch=master)](https://coveralls.io/github/angular-material-extensions/pages?branch=master)\n[![dependency Status](https://david-dm.org/angular-material-extensions/pages/status.svg)](https://david-dm.org/angular-material-extensions/pages)\n[![devDependency Status](https://david-dm.org/angular-material-extensions/pages/dev-status.svg?branch=master)](https://david-dm.org/angular-material-extensions/pages#info=devDependencies)\n[![Greenkeeper Badge](https://badges.greenkeeper.io/angular-material-extensions/pages.svg)](https://greenkeeper.io/)\n[![license](https://img.shields.io/github/license/angular-material-extensions/pages.svg?style=flat-square)](https://github.com/angular-material-extensions/pages/blob/master/LICENSE)\n[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/gdi2290/awesome-angular)\n\n\n\u003e This Github project has been transferred to the angular material extensions monorepo [angular-material-extensions/components](https://github.com/angular-material-extensions/components)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"@angular-material-extensions/pages\" style=\"text-align: center;\"\n   src=\"assets/demo.gif\"\u003e\n\u003c/p\u003e\n\n\nDo you need an illustration for your explanations and tutorials ? Or maybe an alternative way of pagination ?\nAre you using [angular](https://angular.io/) to build wonderful pwa ?\nYou favorite front-end framework is [angular material](https://material.angular.io/) ?\n\n@angular-material-extensions/pages is the right UI component for you!\nYou build wonderful and comprehensive tutorials pages by providing an outlook and content for each\nstep of your explanation.\n\nTry it out! \n\n## Built by and for developers :heart:\nDo you have any question or suggestion ? Please do not hesitate to contact us!\nAlternatively, provide a PR | open an appropriate issue [here](https://github.com/angular-material-extensions/pages/issues)\n\nIf did you this project, support [angular-material-extensions](https://github.com/angular-material-extensions) \nby starring :star: and sharing it :loudspeaker:\n\n## Table of Contents\n- [Demo](#demo)\n- [Dependencies](#dependencies)\n- [Peer Dependencies](#peerDependencies)\n- [Additional Requirements - material (Include a theme)](#additional-requirements-material-theme)\n- [Additional Requirements - material icons](#additional-requirements-material-icons)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Run Demo App Locally](#run-demo-app-locally)\n- [Other Angular Libraries](#other-angular-libraries)\n- [Support](#support)\n- [License](#license)\n\n---\n\n## [Demo](https://angular-material-extensions.github.io/pages)\n\nView all the directives and components in action at [https://angular-material-extensions.github.io/pages](https://angular-material-extensions.github.io/pages)\n\n## Dependencies\n* [Angular](https://angular.io) (*requires*) tested with V9\n- if you are still using angular v5 or lower, please use the following version `1.2.1`\n\n\n\u003e This project has been renamed from [@angular-material-extensions/pages](https://www.npmjs.com/package/@angular-material-extensions/pages) to [@angular-material-extensions/pages](https://github.com/angular-material-extensions/pages)\n\n\u003ca name=\"peerDependencies\"/\u003e\n\n## Peer Dependencies\n- [angular animations v7.x](https://www.npmjs.com/package/@angular/animations)\n- [angular material v7.x](https://www.npmjs.com/package/@angular/material)\n- [angular cdk v7.x](https://www.npmjs.com/package/@angular/cdk)\n\n\u003e [learn more about angular material and cdk](https://material.angular.io/guide/getting-started#step-1-install-angular-material-and-angular-cdk)\n\n\u003e if you need a built in theme --\u003e please let me know\n```bash\nnpm i -s @angular/animations @angular/material @angular/cdk\n```\n\nor use `angular schematics` like e.g:\n\n```bash\nng add @angular/material \n```\n\n\n\u003ca name=\"additional-requirements-material-theme\"/\u003e\n\n### Additional requirements Theme (Material Design)\n- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)\n\n\u003ca name=\"additional-requirements-material-icons\"/\u003e\n\n## Additional Requirements - Import the material design icons [learn more](https://material.angular.io/guide/getting-started#step-6-optional-add-material-icons)\n\n- The easiest way to import material design icons is to provide a link in your `index.html` file like below:\n\n```html\n\u003clink href=\"https://fonts.googleapis.com/icon?family=Material+Icons\" rel=\"stylesheet\"\u003e\n```\n\n- alternative solution:\n\n1. Install of the official npm module of the material design icons\n\n```bash\nnpm i -s material-design-icons\n```\n\n2. Import them in your `angular.json` file\n\n```json\n\"styles\": [\n        \"styles.css\",\n        \"../node_modules/material-design-icons/iconfont/material-icons.css\"\n      ],\n```  \n\n\n----\n\n\u003ca name=\"installation\"/\u003e\n\n##  [Installation](https://angular-material-extensions.github.io/pages/getting-started)\n\nInstall above dependencies via *npm*. \n\nNow install `@angular-material-extensions/pages` via:\n```shell\nnpm install --save @angular-material-extensions/pages\n```\n\n---\n##### SystemJS\n\u003e**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle.\nIn your systemjs config file, `map` needs to tell the System loader where to look for `@angular-material-extensions/pages`:\n```js\nmap: {\n  '@angular-material-extensions/pages': 'node_modules/@angular-material-extensions/pages/bundles/@angular-material-extensions/pages.umd.js',\n}\n```\n---\n\nOnce installed you need to import the main module:\n```js\nimport { MatPagesModule } from '@angular-material-extensions/pages';\n```\nThe only remaining part is to list the imported module in your application module. The exact method will be slightly\ndifferent for the root (top-level) module for which you should end up with the code similar to (notice ` MatPagesModule .forRoot()`):\n\nNB: please do not forget to import the angular animations module in your root component too! (usally app.component.ts)\n```js\nimport { MatPagesModule } from '@angular-material-extensions/pages';\nimport {BrowserAnimationsModule} from '@angular/platform-browser/animations';\n\n@NgModule({\n  declarations: [AppComponent, ...],\n  imports: [MatPagesModule.forRoot(),\n  BrowserAnimationsModule,\n   ...],  \n  bootstrap: [AppComponent]\n})\nexport class AppModule {\n}\n```\n\nOther modules in your application can simply import ` MatPagesModule `:\n\n```js\nimport { MatPagesModule } from '@angular-material-extensions/pages';\n\n@NgModule({\n  declarations: [OtherComponent, ...],\n  imports: [MatPagesModule, ...], \n})\nexport class OtherModule {\n}\n```\n\n## Add a material theme - [help](https://material.angular.io/guide/getting-started#step-4-include-a-theme)\nThe easiest way is to add \n```css\n@import '~@angular/material/prebuilt-themes/deeppurple-amber.css';\n```\nto you `styles.css` files\n\n[learn more](https://material.angular.io/guide/theming)\n\n## Add a material icons - [help](https://material.angular.io/guide/getting-started#step-6-optional-add-material-icons)\nThe easiest way is to add \n```html\n\u003clink href=\"https://fonts.googleapis.com/icon?family=Material+Icons\" rel=\"stylesheet\"\u003e\n```\nto you `index.html` files\n\n[learn more](https://google.github.io/material-design-icons/)\n\n\n\u003ca name=\"usage\"/\u003e\n\n## [Usage](https://angular-material-extensions.github.io/pages/getting-started)\n\nThis library consists of 4 essential components.\n\n1. `mat-pages` the main container that hold the pages incl. the outlook view and the content\n2. `mat-page-loader` the container of each page. This component should have two nested elements\n which are the outlook and the content components (see below)\n3. `mat-page-outlook` the outlook view of a page. This can contain a custom component, custom layout or just a title.\n4. `mat-page-content` this is the content view of the page. This can be anything!!\n\n5. Example:\n\n```html\n\u003cmat-pages\u003e\n    \u003cmat-page-loader\u003e\n      \u003cmat-page-outlook\u003e\n        \u003c!-- put your own outlook view for the first page --\u003e\n      \u003c/mat-page-outlook\u003e\n      \u003cmat-page-content\u003e\n        \u003c!-- put your own content view for the first page --\u003e\n      \u003c/mat-page-content\u003e\n    \u003c/mat-page-loader\u003e\n    \u003cmat-page-loader\u003e\n      \u003cmat-page-outlook\u003e\n        \u003c!-- put your own outlook view for the second page --\u003e\n      \u003c/mat-page-outlook\u003e\n      \u003cmat-page-content\u003e\n        \u003c!-- put your own content view for the second page --\u003e\n      \u003c/mat-page-content\u003e\n    \u003c/mat-page-loader\u003e\n  \u003c/mat-pages\u003e\n```\n\n--- \n\n\u003ca name=\"documentation\"/\u003e\n\n## [Documentation](https://angular-material-extensions.github.io/pages/doc/index.html)\n\nPlease checkout the full documentation [here](https://angular-material-extensions.github.io//pages/doc/index.html) \nor follow the official [tutorial](https://angular-material-extensions.github.io//pages/getting-started)\n\n--- \n\n\n\u003ca name=\"run-demo-app-locally\"/\u003e\n\n## Run Demo App Locally\n\n- [clone this repo](https://github.com/angular-material-extensions/pages.git) by running\n```bash\n$ git clone https://github.com/angular-material-extensions/pages.git\n```\n\n- link the **@angular-material-extensions/pages** package\n\n```bash\n$ gulp link\n```\n\n- build the library\n\n```bash\n$ gulp build\n```\n\n- navigate to the demo app directory\n```bash\n$ cd demo\n```\n\n- install the dependencies\n```bash\n$ npm i\n```\n\n- run/start/serve the app\n```bash\n$ npm run start\n```\nor\n```bash\n$ ng serve --open\n```\n- the app is now hosted on `http://localhost:4200/`\n\n\n## Where are @angular-material-extensions/pages being used ? Here are some examples\n- [ngx-auth-firebaseui](https://ngx-auth-firebaseui.firebaseapp.com/getting-started)\n- [@angular-material-extensions/pages](https://angular-material-extensions.github.io/pages/getting-started)\n- [@angular-material-extensions/password-strength](https://angular-material-extensions.github.io/password-strength/getting-started)\n- [@angular-material-extensions/contacts](https://angular-material-extensions.github.io/contacts/getting-started)\n- [@angular-material-extensions/faq](https://angular-material-extensions.github.io/faq/getting-started)\n- [@angular-material-extensions/combination-generator](https://angular-material-extensions.github.io/combination-generator/getting-started)\n\n\u003ca name=\"other-angular-libraries\"/\u003e\n\n## Other Angular Libraries\n- [ngx-auth-firebaseui](https://github.com/AnthonyNahas/ngx-auth-firebaseui)\n- [ngx-linkifyjs](https://github.com/AnthonyNahas/ngx-linkifyjs)\n- [@firebaseui/ng-bootstrap](https://github.com/firebaseui/ng-bootstrap)\n- [@angular-material-extensions/password-strength](https://github.com/angular-material-extensions/password-strength)\n- [@angular-material-extensions/link-preview](https://github.com/angular-material-extensions/link-preview)\n- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)\n- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)\n- [@angular-material-extensions/jumbotron](https://github.com/angular-material-extensions/jumbotron)\n- [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq)\n- [@angular-material-extensions/fab-menu](https://github.com/angular-material-extensions/fab-menu)\n- [@angular-material-extensions/select-country](https://github.com/angular-material-extensions/select-country)\n- [@angular-material-extensions/combination-generator](https://github.com/angular-material-extensions/combination-generator)\n\n---\n\n## Support\n+ Drop an email to: [Anthony Nahas](mailto:anthony.na@hotmail.de) and I will help you\n+ or open an appropriate [issue](https://github.com/angular-material-extensions/pages/issues)\n+ let us chat on [Gitter](https://gitter.im/angular-material-extensions/Lobby)\n \n ---\n \n## License\n\nCopyright (c) 2018 [Anthony Nahas](mailto:anthony.na@hotmail.de). Licensed under the MIT License (MIT)\n","funding_links":["https://github.com/sponsors/angular-material-extensions","https://tidelift.com/funding/github/npm/@angular-material-extensions/pages","https://github.com/AnthonyNahas","anahas.de"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular-material-extensions%2Fpages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangular-material-extensions%2Fpages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular-material-extensions%2Fpages/lists"}