{"id":24910502,"url":"https://github.com/angular-material-extensions/faq","last_synced_at":"2025-10-16T21:31:52.984Z","repository":{"id":57097714,"uuid":"131198895","full_name":"angular-material-extensions/faq","owner":"angular-material-extensions","description":"Angular Library built with material design in order to provide a reusable faq (frequently asked questions) component for every project. Ask, Answer and List","archived":false,"fork":false,"pushed_at":"2022-01-10T22:41:47.000Z","size":49608,"stargazers_count":29,"open_issues_count":45,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-21T18:06:24.665Z","etag":null,"topics":["angular","faq","library","material-design","ngx"],"latest_commit_sha":null,"homepage":"https://angular-material-extensions.github.io/faq","language":"JavaScript","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/faq","community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://github.com/AnthonyNahas","anahas.de"]}},"created_at":"2018-04-26T19:01:48.000Z","updated_at":"2024-07-31T16:58:30.000Z","dependencies_parsed_at":"2022-08-20T18:10:29.141Z","dependency_job_id":null,"html_url":"https://github.com/angular-material-extensions/faq","commit_stats":null,"previous_names":["anthonynahas/ngx-material-faq"],"tags_count":8,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Ffaq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Ffaq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Ffaq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular-material-extensions%2Ffaq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/angular-material-extensions","download_url":"https://codeload.github.com/angular-material-extensions/faq/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236664633,"owners_count":19185531,"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","faq","library","material-design","ngx"],"created_at":"2025-02-02T03:36:47.699Z","updated_at":"2025-10-16T21:31:45.893Z","avatar_url":"https://github.com/angular-material-extensions.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg height=\"256px\" width=\"256px\" style=\"text-align: center;\" src=\"https://cdn.rawgit.com/angular-material-extensions/faq/master/demo/src/assets/logo.svg\"\u003e\n\u003c/p\u003e\n\n# @angular-material-extensions/faq - Angular Library built with material design in order to provide a reusable faq (frequently asked questions) component for every project. Ask, Answer and List\n\n[![npm version](https://badge.fury.io/js/%40angular-material-extensions%2Ffaq.svg)](https://badge.fury.io/js/%40angular-material-extensions%2Ffaq)\n[![npm demo](https://img.shields.io/badge/demo-online-ed1c46.svg)](https://angular-material-extensions.github.io/faq)\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/faq/master.svg?label=circleci)](https://circleci.com/gh/angular-material-extensions/faq)\n[![Coverage Status](https://coveralls.io/repos/github/angular-material-extensions/faq/badge.svg?branch=master)](https://coveralls.io/github/angular-material-extensions/faq?branch=master)\n[![dependency Status](https://david-dm.org/angular-material-extensions/faq/status.svg)](https://david-dm.org/angular-material-extensions/faq)\n[![devDependency Status](https://david-dm.org/angular-material-extensions/faq/dev-status.svg?branch=master)](https://david-dm.org/angular-material-extensions/faq#info=devDependencies)\n[![Greenkeeper Badge](https://badges.greenkeeper.io/angular-material-extensions/faq.svg)](https://greenkeeper.io/)\n[![license](https://img.shields.io/github/license/angular-material-extensions/faq.svg?style=flat-square)](https://github.com/angular-material-extensions/faq/blob/master/LICENSE)\n\n\u003e This project has been renamed from [ngx-material-faq](https://www.npmjs.com/package/ngx-material-faq) to [@angular-material-extensions/faq](https://github.com/angular-material-extensions/faq)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"@angular-material-extensions/faq\" style=\"text-align: center;\"\n   src=\"https://raw.githubusercontent.com/angular-material-extensions/faq/HEAD/assets/demo.gif\"\u003e\n\u003c/p\u003e\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/faq/issues)\n\nIf you like 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- [Development](#development)\n- [Other Angular Libraries](#other-angular-libraries)\n- [Support](#support)\n- [License](#license)\n\n\u003ca name=\"demo\"/\u003e\n\n## [Demo](https://angular-material-extensions.github.io/faq)\n\nView all the directives and components in action at [https://angular-material-extensions.github.io/faq](https://angular-material-extensions.github.io/faq)\n\n\u003ca name=\"dependencies\"/\u003e\n\n## Dependencies\n* [Angular v7.x](https://angular.io) (*requires* Angular 2 or higher) - Angular V7 - Material V6 are now supported\n\n\u003ca name=\"peerDependencies\"/\u003e\n\n### Requirements (peer dependencies):\n- [angular flex-layout v7.x](https://www.npmjs.com/package/@angular/flex-layout)\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- [angular animations v7.x](https://www.npmjs.com/package/@angular/animations)\n- [angular forms v7.x](https://www.npmjs.com/package/@angular/forms)\n\n```bash\nnpm i @angular/cdk @angular/material @angular/flex-layout @angular/animations @angular/forms \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/faq/getting-started)\nInstall above dependencies via *npm*. \n\nNow install `@angular-material-extensions/faq` via:\n```shell\nnpm install -s @angular-material-extensions/faq\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/faq`:\n```js\nmap: {\n  '@angular-material-extensions/faq': 'node_modules/@angular-material-extensions/faq/bundles/faq.umd.js',\n}\n```\n---\n\nOnce installed you need to import the main module:\n```js\nimport { MatFaqModule } from '@angular-material-extensions/faq';\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 ` MatFaqModule .forRoot()`):\n```js\nimport { MatFaqModule } from '@angular-material-extensions/faq';\n\n@NgModule({\n  declarations: [AppComponent, ...],\n  imports: [MatFaqModule.forRoot(), ...],  \n  bootstrap: [AppComponent]\n})\nexport class AppModule {\n}\n```\n\nOther modules in your application can simply import ` MatFaqModule `:\n\n```js\nimport { MatFaqModule } from '@angular-material-extensions/faq';\n\n@NgModule({\n  declarations: [OtherComponent, ...],\n  imports: [MatFaqModule, ...], \n})\nexport class OtherModule {\n}\n```\n\n\u003ca name=\"usage\"/\u003e\n\n## [Usage](https://angular-material-extensions.github.io/faq/getting-started)\n\n\nangular-material-extensions\n\nadd the `mat-faq` or the `mat-faq-admin` element to your template:\n\n\n### mat-material-faq\n\n**This component aims to list the provided frequently asked questions**\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"@angular-material-extensions/faq\" style=\"text-align: center;\"\n   src=\"https://raw.githubusercontent.com/angular-material-extensions/faq/HEAD/assets/demo-mat-faq.png\"\u003e\n\u003c/p\u003e\n\n```html\n\u003cmat-faq [faqList]=\"list\"\u003e\u003c/mat-faq\u003e\n```\n\n```typescript\nimport {Component, OnInit, ViewEncapsulation} from '@angular/core';\nimport {FaqItem} from '@angular-material-extensions/faq';\n\nexport class HomeComponent implements OnInit {\n  \n    ngOnInit() {\n    }\n\n  list: FaqItem[] = [\n    {\n          question: 'Why does it think the jQuery plugin is missing?',\n          answer: 'Remember: load jQuery before AngularJS if you are using jQuery plugins!'\n        },\n        {\n          question: 'How do I access the DOM from a controller?',\n          answer: 'DO NOT perform DOM selection/traversal from the controller. The HTML hasn\\'t rendered yet. Look up \\'directives\\'.'\n        }\n  ];\n  \n }\n \n ```\n\n### mat-faq-admin\n\n**This component is actually for admin purposes, like to add a frequently \nasked question to the backend, firebase ... and so on..**\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"mat-faq-admin\" style=\"text-align: center;\"\n   src=\"https://raw.githubusercontent.com/angular-material-extensions/faq/HEAD/assets/demo-mat-faq-admin.png\"\u003e\n\u003c/p\u003e\n\n```html\n\u003cmat-faq-admin [title]=\"'Admin'\" (onFAQItemAdded)=\"onNewFaqItem($event)\"\u003e\u003c/mat-faq-admin\u003e\n```\n\nin your component\n\n```typescript\nimport {Component, OnInit, ViewEncapsulation} from '@angular/core';\nimport {FaqItem} from '@angular-material-extensions/faq';\n\nexport class HomeComponent implements OnInit {\n  \n   ngOnInit() {\n      }\n\n  faq: FaqItem[] = [];\n  \n  onNewFaqItem(faqItem: FaqItem) {\n      console.log('on new faqItem -\u003e ', faqItem);\n      this.faq.splice(0, 0, faqItem);\n    }\n  \n } \n```\n\n\u003ca name=\"documentation\"/\u003e\n\n## [Documentation](https://angular-material-extensions.github.io/faq/doc/index.html)\n\nPlease checkout the full documentation [here](https://angular-material-extensions.github.io//faq/doc/index.html) \nor follow the official [tutorial](https://angular-material-extensions.github.io//faq/getting-started)\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/faq.git) by running\n```bash\n$ git clone https://github.com/angular-material-extensions/faq.git\n```\n\n- link the **@angular-material-extensions/faq** package\n```bash\n$ gulp link\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 by `http://localhost:4200/`\n\n\n\u003ca name=\"development\"/\u003e\n\n## Development\n\n1. clone this [repo](https://github.com/angular-material-extensions/faq.git)\n2. Install the dependencies by running `npm i`\n\n```bash\n$ npm run build\n```\n\n4. Link the library \n ```bash\n $ gulp link\n ```\n  \n 5. Navigate to the demo app's directory\n  - `cd demo`\n  _ `npm i`\n  _ `npm start`\n\n---\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- [@firebaseui/ng-bootstrap](https://github.com/firebaseui/ng-bootstrap)\n- [ngx-linkifyjs](https://github.com/anthonynahas/ngx-linkifyjs)\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/pages](https://github.com/angular-material-extensions/pages)\n- [@angular-material-extensions/google-maps-autocomplete](https://github.com/angular-material-extensions/google-maps-autocomplete)\n- [@angular-material-extensions/jumbotron](https://github.com/angular-material-extensions/jumbotron)\n- [@angular-material-extensions/contacts](https://github.com/angular-material-extensions/contacts)\n---\n\n\u003ca name=\"support\"/\u003e\n\n## Support\n+ Drop an email to: [Anthony Nahas](mailto:anthony.na@hotmail.de)\n+ or open an appropriate [issue](https://github.com/angular-material-extensions/faq/issues)\n+ let us chat on [Gitter](https://gitter.im/angular-material-extensions/Lobby)\n \n Built by and for developers :heart: we will help you :punch:\n\n---\n\n![jetbrains logo](assets/jetbrains-variant-4_logos/jetbrains-variant-4.png)\n\nThis project is supported by [jetbrains](https://www.jetbrains.com/) with 1 ALL PRODUCTS PACK OS LICENSE incl. [webstorm](https://www.jetbrains.com/webstorm)\n\n---\n\n## License\n\nCopyright (c) 2018 [Anthony Nahas](https://github.com/AnthonyNahas). Licensed under the MIT License (MIT)\n\n","funding_links":["https://github.com/sponsors/angular-material-extensions","https://tidelift.com/funding/github/npm/@angular-material-extensions/faq","https://github.com/AnthonyNahas","anahas.de"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular-material-extensions%2Ffaq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangular-material-extensions%2Ffaq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular-material-extensions%2Ffaq/lists"}