Skip to content
Angular Library to manage contacts and users with a material design
JavaScript TypeScript HTML CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci feat(project): added cricleci configuration for build and test Apr 23, 2018
.github feat(project): initial commit after project generation Apr 22, 2018
assets docs(project): added the angular material extensions'logo to the readme Oct 28, 2018
config feat(project): initial commit after project generation Apr 22, 2018
demo fix(package): updated the schematics libs version Mar 23, 2019
docs fix(package): added schematics support #72 Mar 12, 2019
src fix(package): updated the schematics libs version Mar 23, 2019
.editorconfig feat(project): initial commit after project generation Apr 22, 2018
.gitignore feat(project): initial commit after project generation Apr 22, 2018
.travis.yml chore(release): bump version number to 3.0.0 Jun 14, 2018
.yo-rc.json fix(package): updated the schematics libs version Mar 23, 2019
CHANGELOG.md
LICENSE feat(project): added license Apr 22, 2018
README.md
commitlint.config.js chore(package): added commitlint file Feb 11, 2019
greenkeeper.json chore: add Greenkeeper config file May 1, 2018
gulpfile.js feat(package): added angular schematics support Mar 14, 2019
karma.conf.js test(project): added karma config Apr 22, 2018
package-lock.json fix(package): updated angular to v7.2.10 and other deps incl. materia… Mar 23, 2019
package.json chore(release): bump version number to 3.1.2 Mar 23, 2019
tsconfig.json feat(project): initial commit after project generation Apr 22, 2018
tslint.json
webpack.config.js feat(project): initial commit after project generation Apr 22, 2018

README.md

angular-material-extensions's logo

# @angular-material-extensions/contacts - Angular Library to manage contacts and users with a material design (Angular V7 supported)

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

This project has been moved from ngx-material-contacts to @angular-material-extensions/contacts

@angular-material-extensions/contacts

@angular-material-extensions/contacts

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 did 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/contacts

Features

  • Display contacts in a table including name, email, phone number and photo
  • Delete a contact via event onContactRemoved
  • Add a contact via event onContactAdded
  • Validation for adding a new contact incl. name, email and phone number form controls

Dependencies

Requirements (peer dependencies) - please install the packages before using @angular-material-extensions/contacts:

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

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/contacts via:

npm install --save @angular-material-extensions/contacts

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/contacts:

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

Once installed you need to import the main module:

import { MatContactsModule } from '@angular-material-extensions/contacts';

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 MatContactsModule .forRoot()):

import { MatContactsModule } from '@angular-material-extensions/contacts';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [MatContactsModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import MatContactsModule:

import { MatContactsModule } from '@angular-material-extensions/contacts';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [MatContactsModule, ...], 
})
export class OtherModule {
}

Usage

add the @angular-material-extensions/contacts element to your template:

<mat-contacts [contacts]="contacts"
              [readonly]="false"
              (onContactAdded)="addContact($event)"
              (onContactRemoved)="removeContact($event)">
</mat-contacts>

in your component -->

const CONTACT_DATA: Contact[] = [
  {
    id: 'RnCSW7Y88iTx',
    name: 'Anthony Nahas',
    email: 'anthony.na@your_domain.com',
    photoURL: '../../../assets/profiles/17p60.png',
    phoneNumber: '+1-202-555-0169'
  },
  {
    id: 'KXgJviXd4EL9',
    name: 'Amanda Lee',
    email: 'amanda.lee@@angular-material-extensions/contacts.de',
    photoURL: '../../../assets/profiles/1p60.png',
    phoneNumber: '+1-502-555-0156'
  }
  ]
export class HomeComponent implements OnInit {

  contacts = CONTACT_DATA;
  
  ngOnInit() {
      console.log('my contacts: ', this.contacts);
    }
  
  addContact(contact: Contact) {
      console.log('on new contact: ', contact);
      // do whatever you want with the added contact
    }
  
    removeContact(contact: Contact) {
      console.log('on removed contact: ', contact);
      // do whatever you want with the deleted contact
    }

  }
  

Contact's interface

export interface Contact {
  id?: string;
  name: string;
  email: string;
  photoURL?: string;
  phoneNumber?: string;
}

Documentation

Please checkout the full documentation here or follow the official tutorial

Run Demo App Locally

$ git clone https://github.com/angular-material-extensions/contacts.git
  • link the @angular-material-extensions/contacts 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
  3. build the library npm run build or gulp build
$ npm run build
  1. Link the library
  • gulp link
  1. Navigate to the demo app
  • 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)

You can’t perform that action at this time.