Skip to content

Latest commit

 

History

History
151 lines (132 loc) · 9.5 KB

README.md

File metadata and controls

151 lines (132 loc) · 9.5 KB

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

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 alpha and under active development. During alpha, breaking API and behavior changes will be occurring regularly.

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

  • Initial version of md-select
  • Continued bug bashing
  • Initial versions of autocomplete and chips
  • AoT compile e2e app
  • Continue work on https://material.angular.io site
  • Major refactoring for md-input
  • Tabs animations
  • Expanding e2e test coverage

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-circle 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 Initial version, needs enhancements README -
ripples Available README #108
dialog Available README #114
snackbar / toast Available README #115
select Will be released in alpha.11 - #118
textarea Started - #546
autocomplete Design started - #117
chips Started - #120
theming Available, need guidance overlays Guide -
prod build Not started - -
docs site UX design and tooling in progress - -
typography Not started - #205
layout Design in-progress, prototyped - -
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 Not started - #581
stepper Not started - #508

"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.