Agorapulse Angular 2 Material

Usage no npm install needed!

<script type="module">
  import agorapulseMaterial from 'https://cdn.skypack.dev/@agorapulse/material';


Custom notes

All the needed files path: /src/lib/core/theming/ap-theme:

This folder has all the custom components for agorapulse, the shared assets, the pallete of colors used, some custom variables and the file agorapulse-theme.scss. The main use for this file is to create the ap-theme of material, and import all the custom components, assets, fonts, etc.

How to test Agorapulse theme

First clone. Do npm install

npm i

Now run it in http://localhost:4200/ui-kit with npm run demo-app

Navigate to UI-KIT at the top of the side-menu to check the custom Agorapulse components.


Set link path to auto update files in another custom project npm config set @agorapulse/material:dir ../project-dir/

Then do: npm run link

You need to build the components (not the demo-app). See "How to build".

How to Build

Requeriments npm i -g gulp

To build the components in dev mode: gulp build:components

To build the components in release mode: gulp build:release

To bring up a local server: gulp serve:devapp

This will automatically watch for changes and rebuild. The browser should refresh automatically when changes are made.

How to Publish

Bump src/lib/package.json version.

Then just do gulp publish --tag=latest

npm login credentials and access to https://www.npmjs.com/package/@agorapulse/material required.

Desired output:

Publishing material...
  Executing "npm publish --access public --tag latest"...
  stdout: + @agorapulse/material@2.0.0-alpha.11-2-ap.1

How to publish to gh-pages

Build demo app: gulp build:devapp

Copy all dist folder from master branch to gh-pages branch

Then push the changes

Material Design for Angular 2

npm version Build Status Gitter

This is the home for the Angular team's Material Design components built on top of Angular 2.

Quick links

Google group, Contributing, Plunker Template


The latest release of Angular Material can be installed from npm

npm install @angular/material

Playing with the latest changes from master is also possible

npm install https://github.com/angular/material2-builds.git

Getting started

See our Getting Started Guide if you're building your first project with Angular Material 2.

Project status

Angular Material 2 is currently in beta and under active development. During beta, new features will be added regularly and APIs will evolve based on user feedback.

Check out our directory of design documents for more insight into our process.

If you'd like to contribute, you must follow our contributing guidelines. You can look through the issues (which should be up-to-date on who is working on which features and which pieces are blocked) and make a comment. Also see our Good for community contribution label.

High level items planned for January 2017:

  • Initial version of md-autocomplete
  • Prototyping for data-table
  • Improvements to https://material.angular.io
  • Continued expanding e2e test coverage
  • More work on scroll / resize handling for overlays
  • Screenshot tests
  • Better development automation

Feature status:

Feature Status Docs Issue
button Available README -
cards Available README -
checkbox Available README -
radio Available README -
input Available README -
sidenav Available README -
toolbar Available README -
list Available README #107
grid-list Available README -
icon Available README -
progress-spinner Available README -
progress-bar Available README -
tabs Available README -
slide-toggle Available README -
button-toggle Available README -
slider Available README -
menu Available README #119
tooltip Available README -
ripples Available README #108
dialog Available README #114
snackbar / toast Available README #115
select Available - #118
textarea Available - -
autocomplete In-progress - #117
chips Initial version, features evolving - #120
theming Available, need guidance overlays Guide -
docs site UX design and tooling in progress - -
typography Not started - #205
fab speed-dial Not started - #860
fab toolbar Not started - -
bottom-sheet Not started - -
bottom-nav Not started - #408
virtual-repeat Not started - #823
datepicker Not started - #675
data-table Design in-progress - #581
stepper Not started - #508
layout see angular/flex-layout - -

"Available" means that the components or feature is published and available for use, but may still be missing some behaviors or polish.

The goal of Angular Material

Our goal is to build a set of high-quality UI components built with Angular 2 and TypeScript, following the Material Design spec. These components will serve as an example of how to write Angular code following best practices.

What do we mean by "high-quality"?

  • Internationalized and accessible so that all users can use them.
  • Straightforward APIs that don't confuse developers.
  • Behave as expected across a wide variety of use-cases without bugs.
  • Behavior is well-tested with both unit and integration tests.
  • Customizable within the bounds of the Material Design specification.
  • Performance cost is minimized.
  • Code is clean and well-documented to serve as an example for Angular devs.

Browser and screen reader support

Angular Material supports the most recent two versions of all major browsers: Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge

We also aim for great user experience with the following screen readers:

  • NVDA and JAWS with IE / FF / Chrome (on Windows).
  • VoiceOver with Safari on iOS and Safari / Chrome on OSX.
  • TalkBack with Chrome on Android.