Home

Awesome

<p align="center"> <img alt="angular-material-extensions's logo" height="256px" width="256px" style="text-align: center;" src="https://cdn.rawgit.com/angular-material-extensions/contacts/master/assets/angular-material-extensions-logo.svg"> </p> # @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

<p align="center"> <img alt="@angular-material-extensions/contacts" style="text-align: center;" src="https://raw.githubusercontent.com/angular-material-extensions/contacts/HEAD/assets/demo2.gif"> </p> <p align="center"> <img alt="@angular-material-extensions/contacts" style="text-align: center;" src="https://raw.githubusercontent.com/angular-material-extensions/contacts/HEAD/assets/demo3.gif"> </p>

Built by and for developers :heart:

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 :star: and sharing it :loudspeaker:

Table of Contents

<a name="demo"/>

Demo

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

<a name="features"/>

Features

<a name="dependencies"/>

Dependencies

<a name="peerDependencies"/>

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
<a name="additional-requirements-material-theme"/>

Additional requirements Theme (Material Design)

<a name="additional-requirements-material-icons"/>

Additional Requirements - Import the material design icons learn more

<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  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"
      ],

<a name="installation"/>

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 {
}
<a name="usage"/>

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;
}
<a name="documentation"/>

Documentation

Please checkout the full documentation here or follow the official tutorial

<a name="run-demo-app-locally"/>

Run Demo App Locally

$ git clone https://github.com/angular-material-extensions/contacts.git
$ gulp link
$ cd demo
$ npm i
$ npm run start

or

$ ng serve --open
<a name="development"/>

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
  1. Navigate to the demo app
<a name="other-angular-libraries"/>

Other Angular Libraries

<a name="support"/>

Support

Built by and for developers :heart: we will help you :punch:


jetbrains logo

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


<a name="license"/>

License

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