Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@angular-material-extensions/faq

3.0.4 • Public • Published

@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

npm version npm demo Join the chat at https://gitter.im/angular-material-extensions/Lobby CircleCI branch Coverage Status dependency Status devDependency Status Greenkeeper Badge license

This project has been renamed from ngx-material-faq to @angular-material-extensions/faq

@angular-material-extensions/faq

Built by and for developers ❤️

Do you have any question or suggestion ? Please do not hesitate to contact us! Alternatively, provide a PR | open an appropriate issue here

If you like this project, support angular-material-extensions by starring ⭐️ and sharing it 📢

Table of Contents

Demo

View all the directives and components in action at https://angular-material-extensions.github.io/faq

Dependencies

  • Angular v7.x (requires Angular 2 or higher) - Angular V7 - Material V6 are now supported

Requirements (peer dependencies):

npm i @angular/cdk @angular/material @angular/flex-layout @angular/animations @angular/forms 

Additional requirements Theme (Material Design)

Additional Requirements - Import the material design icons learn more

  • The easiest way to import material design icons is to provide a link in your index.html file like below:
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  • alternative solution:
  1. Install of the official npm module of the material design icons
npm i -s material-design-icons
  1. Import them in your angular.json file
"styles"[
        "styles.css",
        "../node_modules/material-design-icons/iconfont/material-icons.css"
      ],

Installation

Install above dependencies via npm.

Now install @angular-material-extensions/faq via:

npm install -s @angular-material-extensions/faq

SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for @angular-material-extensions/faq:

map: {
  '@angular-material-extensions/faq': 'node_modules/@angular-material-extensions/faq/bundles/faq.umd.js',
}

Once installed you need to import the main module:

import { MatFaqModule } from '@angular-material-extensions/faq';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice MatFaqModule .forRoot()):

import { MatFaqModule } from '@angular-material-extensions/faq';
 
@NgModule({
  declarations: [AppComponent, ...],
  imports: [MatFaqModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import MatFaqModule:

import { MatFaqModule } from '@angular-material-extensions/faq';
 
@NgModule({
  declarations: [OtherComponent, ...],
  imports: [MatFaqModule, ...], 
})
export class OtherModule {
}

Usage

angular-material-extensions

add the mat-faq or the mat-faq-admin element to your template:

mat-material-faq

This component aims to list the provided frequently asked questions

@angular-material-extensions/faq

<mat-faq [faqList]="list"></mat-faq>
import {Component, OnInit, ViewEncapsulation} from '@angular/core';
import {FaqItem} from '@angular-material-extensions/faq';
 
export class HomeComponent implements OnInit {
  
    ngOnInit() {
    }
 
  list: FaqItem[] = [
    {
          question: 'Why does it think the jQuery plugin is missing?',
          answer: 'Remember: load jQuery before AngularJS if you are using jQuery plugins!'
        },
        {
          question: 'How do I access the DOM from a controller?',
          answer: 'DO NOT perform DOM selection/traversal from the controller. The HTML hasn\'t rendered yet. Look up \'directives\'.'
        }
  ];
  
 }
 

mat-faq-admin

This component is actually for admin purposes, like to add a frequently asked question to the backend, firebase ... and so on..

mat-faq-admin

<mat-faq-admin [title]="'Admin'" (onFAQItemAdded)="onNewFaqItem($event)"></mat-faq-admin>

in your component

import {Component, OnInit, ViewEncapsulation} from '@angular/core';
import {FaqItem} from '@angular-material-extensions/faq';
 
export class HomeComponent implements OnInit {
  
   ngOnInit() {
      }
 
  faq: FaqItem[] = [];
  
  onNewFaqItem(faqItem: FaqItem) {
      console.log('on new faqItem -> ', faqItem);
      this.faq.splice(0, 0, faqItem);
    }
  
 } 

Documentation

Please checkout the full documentation here or follow the official tutorial

Run Demo App Locally

$ git clone https://github.com/angular-material-extensions/faq.git
  • link the @angular-material-extensions/faq package
$ gulp link
  • navigate to the demo app directory
cd demo
  • install the dependencies
$ npm i
  • run/start/serve the app
$ npm run start

or

$ ng serve --open
  • the app is now hosted by http://localhost:4200/

Development

  1. clone this repo
  2. Install the dependencies by running npm i
$ npm run build
  1. Link the library
$ gulp link
  1. Navigate to the demo app's directory
  • cd demo _ npm i _ npm start

Other Angular Libraries


Support

Built by and for developers ❤️ we will help you 👊


jetbrains logo

This project is supported by jetbrains with 1 ALL PRODUCTS PACK OS LICENSE incl. webstorm


License

Copyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)

Install

npm i @angular-material-extensions/faq

DownloadsWeekly Downloads

90

Version

3.0.4

License

MIT

Unpacked Size

63.6 kB

Total Files

19

Last publish

Collaborators

  • avatar