Socket
Socket
Sign inDemoInstall

@angular-material-extensions/contacts

Package Overview
Dependencies
14
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @angular-material-extensions/contacts

Angular Library to manage contacts and users with a material design


Version published
Weekly downloads
1
Maintainers
1
Created
Weekly downloads
 

Changelog

Source

3.1.2 (2019-03-23)

Bug Fixes

  • demo: updated angular and other dependencies (dff9b40)
  • demo: updated angular to v7.2.10 and other deps incl. material and flexlayout (aab4c82)
  • demo: updated angular to v7.2.4 and other dependencies (5b8df7f)
  • package: added material ripple to the contacts row (24da248)
  • package: added schematics support #72 (db933eb)
  • package: updated angular and other dependencies (316f018)
  • package: updated angular to v7.2.10 and other deps incl. material and flexlayout (9ffdc15)
  • package: updated angular to v7.2.4 and other dependencies (0fc2353)
  • package: updated the schematics libs version (d26b704)

Features

  • package: added angular schematics support (636cefd)

Features

  • demo: updated angular to v7 (de24c8e)
  • package: added support of angular v7 (6386a76)
  • package: updated angular to v7.0.1 (7a0db70)

Readme

Source

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

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 :heart: we will help you :punch:


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)

Keywords

FAQs

Last updated on 23 Mar 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc