1
- # Material Design for Angular
1
+ # Components and Material Design for Angular
2
2
[ ![ npm version] ( https://badge.fury.io/js/%40angular%2Fmaterial.svg )] ( https://www.npmjs.com/package/%40angular%2Fmaterial )
3
3
[ ![ Build status] ( https://circleci.com/gh/angular/material2.svg?style=svg )] ( https://circleci.com/gh/angular/material2 )
4
4
[ ![ Gitter] ( https://badges.gitter.im/angular/material2.svg )] ( https://gitter.im/angular/material2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge )
5
5
6
- This is the home for the Angular team's Material Design components built for and with Angular.
6
+ This is the home for the Angular team's UI components built for and with Angular.
7
+ These include Material Design components and the Angular Component Development Kit (CDK).
7
8
8
9
#### Quick links
9
10
[ Documentation, demos, and guides] [ aio ] |
10
11
[ Google group] ( https://groups.google.com/forum/#!forum/angular-material2 ) |
11
12
[ Contributing] ( https://github.com/angular/material2/blob/master/CONTRIBUTING.md ) |
12
- [ Plunker Template] ( https://goo.gl/uDmqyY ) |
13
13
[ StackBlitz Template] ( https://goo.gl/wwnhMV )
14
14
15
15
### Getting started
@@ -21,10 +21,11 @@ Check out our [directory of design documents](https://github.com/angular/materia
21
21
for more insight into our process.
22
22
23
23
If you'd like to contribute, you must follow our [ contributing guidelines] ( https://github.com/angular/material2/blob/master/CONTRIBUTING.md ) .
24
- You can look through the issues (which should be up-to-date on who is working on which features
24
+ You can look through the GitHub issues (which should be up-to-date on who is working on which features
25
25
and which pieces are blocked) and make a comment.
26
- Also see our [ ` help wanted ` ] ( https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 )
27
- label.
26
+
27
+ Please see our [ ` help wanted ` ] ( https://github.com/angular/material2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 )
28
+ label for a list of issues where we could use help from the community.
28
29
29
30
#### High level stuff planned for Q1 → Q2 2019 (January - June):
30
31
* Most of the Angular Material team is on loan to the framework team
@@ -81,19 +82,9 @@ label.
81
82
| ---------------- | ------------------------------------------------------ | ------------ |
82
83
| theming | | [ Guide] [ 20 ] |
83
84
| typography | | [ Guide] [ 27 ] |
84
- | layout | See [ angular/flex-layout] [ lay_rp ] | [ Uncyclo ] [ 0 ] |
85
+ | layout | See [ CDK Layout ] [ cdk-layout ] or [ @ angular/flex-layout ] [ lay_rp ] | - |
85
86
| cdk | | [ Docs] [ 34 ] |
86
87
87
-
88
- #### In progress, planned, and non-planned features
89
-
90
- | Feature | Status | Docs | Issue |
91
- | ------------------| -------------------------------------| --------------| ----------------|
92
- | fab speed-dial | Not started, not planned | - | [ #860 ] [ 0860 ] |
93
- | fab toolbar | Not started, not planned | - | - |
94
- | bottom-nav | Not started, not planned | - | [ #408 ] [ 0408 ] |
95
-
96
- [ 0 ] : https://github.com/angular/flex-layout/wiki
97
88
[ 1 ] : https://material.angular.io/components/button/overview
98
89
[ 2 ] : https://material.angular.io/components/card/overview
99
90
[ 3 ] : https://material.angular.io/components/checkbox/overview
@@ -124,7 +115,7 @@ label.
124
115
[ 28 ] : https://material.angular.io/components/table/overview
125
116
[ 29 ] : https://material.angular.io/components/paginator/overview
126
117
[ 30 ] : https://material.angular.io/components/sort/overview
127
- [ 31 ] : https://tina-material-tree.firebaseapp.com/simple-tree
118
+
128
119
[ 32 ] : https://material.angular.io/components/expansion/overview
129
120
[ 33 ] : https://material.angular.io/components/stepper/overview
130
121
[ 34 ] : https://material.angular.io/cdk/categories
@@ -135,35 +126,17 @@ label.
135
126
[ 39 ] : https://material.angular.io/cdk/drag-drop/overview
136
127
[ 40 ] : https://material.angular.io/cdk/scrolling/overview#virtual-scrolling
137
128
138
- [ 0107 ] : https://github.com/angular/material2/issues/107
139
- [ 0119 ] : https://github.com/angular/material2/issues/119
140
- [ 0108 ] : https://github.com/angular/material2/issues/108
141
- [ 0114 ] : https://github.com/angular/material2/issues/114
142
- [ 0115 ] : https://github.com/angular/material2/issues/115
143
- [ 0118 ] : https://github.com/angular/material2/issues/118
144
- [ 0546 ] : https://github.com/angular/material2/issues/546
145
- [ 0117 ] : https://github.com/angular/material2/issues/117
146
- [ 0120 ] : https://github.com/angular/material2/issues/120
147
- [ 0123 ] : https://github.com/angular/material2/issues/123
148
- [ 0205 ] : https://github.com/angular/material2/issues/205
149
- [ 0860 ] : https://github.com/angular/material2/issues/860
150
- [ 0408 ] : https://github.com/angular/material2/issues/408
151
- [ 0508 ] : https://github.com/angular/material2/issues/508
152
- [ 0823 ] : https://github.com/angular/material2/issues/823
153
- [ 0581 ] : https://github.com/angular/material2/issues/581
154
- [ 4191 ] : https://github.com/angular/material2/pull/4191
155
- [ 0995 ] : https://github.com/angular/material2/pull/995
156
- [ 0474 ] : https://github.com/angular/material2/pull/474
157
-
158
129
[ aio ] : https://material.angular.io
159
130
[ getting-started ] : https://material.angular.io/guide/getting-started
160
131
[ lay_rp ] : https://github.com/angular/flex-layout
132
+ [ cdk-layout ] : https://material.angular.io/cdk/layout/overview
161
133
162
134
163
- ## The goal of Angular Material
164
- Our goal is to build a set of high-quality UI components built with Angular and TypeScript,
165
- following the Material Design spec. These
166
- components will serve as an example of how to write Angular code following best practices.
135
+ ## The goal of Angular Material and the CDK
136
+ Our goal is to build a set of high-quality UI components built with Angular and TypeScript.
137
+ These include foundational components and services, found in the CDK, and components that follow
138
+ the Material Design spec. These components serve as an example of how to build Angular UI components
139
+ that follow best practices.
167
140
168
141
### What do we mean by "high-quality"?
169
142
* Internationalized and accessible so that all users can use them.
@@ -172,13 +145,15 @@ components will serve as an example of how to write Angular code following best
172
145
* Behavior is well-tested with both unit and integration tests.
173
146
* Customizable within the bounds of the Material Design specification.
174
147
* Performance cost is minimized.
175
- * Code is clean and well-documented to serve as an example for Angular devs .
148
+ * Code is clean and well-documented to serve as an example for Angular developers .
176
149
177
150
## Browser and screen reader support
178
151
Angular Material supports the most recent two versions of all major browsers:
179
- Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge
180
-
181
- We also aim for great user experience with the following screen readers:
182
- * NVDA and JAWS with IE / FF / Chrome (on Windows).
183
- * VoiceOver with Safari on iOS and Safari / Chrome on OSX.
184
- * TalkBack with Chrome on Android.
152
+ Chrome (including Android), Firefox, Safari (including iOS), and IE11 / Edge.
153
+
154
+ We aim for great user experience with the following screen readers:
155
+ * ** Windows** : NVDA and JAWS with IE11 / FF / Chrome.
156
+ * ** macOS** : VoiceOver with Safari / Chrome.
157
+ * ** iOS** : VoiceOver with Safari
158
+ * ** Android** : Android Accessibility Suite (formerly TalkBack) with Chrome.
159
+ * ** Chrome OS** : ChromeVox with Chrome.
0 commit comments