components README

The project's README from github.com/angular/components. As one markdown file: README.md.

Official components for Angular

npm version Build status Gitter

The Angular team builds and maintains both common UI components and tools to help you build your own custom components. The team maintains several npm packages.

Package Description Docs
@angular/aria Collection of headless, accessible directives that implement common WAI-ARIA patterns Docs
@angular/cdk Library that helps you author custom UI components with common interaction patterns Docs
@angular/material Material Design UI components for Angular applications Docs
@angular/google-maps Angular components built on top of the Google Maps JavaScript API Docs
@angular/youtube-player Angular component built on top of the YouTube Player API Docs

Documentation, demos, and guides | Frequently Asked Questions | Community Google group | Contributing | StackBlitz Template

Getting started

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

Contributing

If you'd like to contribute, please follow our contributing guidelines. Please see our help wanted label for a list of issues with good opportunities for contribution. You can also use the good first issue label to find issues if you are just starting to contribute to the project.

About the team

The Angular Components team is part of the Angular team at Google. The team includes both Google employees and community contributors from around the globe.

Our team has two primary goals:

What do we mean by "high-quality" components?

Support policy

Angular Material and the CDK follow the same support and release policy as the Angular framework. For details on supported versions and update practices, see the Angular support policy and schedule.

Browser and screen reader support

The Angular Components team supports the most recent two versions of all major browsers: Chrome (including Android), Firefox, Safari (including iOS), and Edge.

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

components (angular/components)

Searching Database…

25K ·GitHub
Components
What is this?This is the official Angular team repository for component infrastructure and Material Design UI components for Angular apps, covering npm packages like @angular/material, @angular/cdk, and @angular/aria.
Is this one library or several packages?It is a monorepo of several npm packages: @angular/material (ready-made Material Design components), @angular/cdk (building blocks for custom components), @angular/aria (headless accessible directives), plus @angular/google-maps and @angular/youtube-player wrappers.
How do I add this to an Angular project?Follow the official Getting Started Guide to add Angular Material to your Angular application; the packages are installed via pnpm/npm from the Angular team's npm registry.
Do I need Angular already set up to use this?Yes, this is built on top of an existing Angular app and depends on core Angular packages like @angular/core, @angular/common, @angular/forms, and @angular/compiler.
Does it follow its own release schedule, or Angular's?Angular Material and the CDK follow the same support and release policy as the Angular framework itself, so you need to track Angular's versioning when upgrading.
Which browsers and screen readers are actually supported?The team supports the latest two versions of Chrome, Firefox, Safari, and Edge, and targets good UX with NVDA/JAWS on Windows, VoiceOver on macOS/iOS, TalkBack on Android, and ChromeVox on Chrome OS.
What makes a component 'high-quality' in this project's eyes?The team aims for internationalized and accessible components, straightforward APIs, broad test coverage, customizability within the Material Design spec, minimal performance cost, and clean documented code.
What is the difference between @angular/material and @angular/cdk?@angular/material provides ready-to-use Material Design styled components, while @angular/cdk gives you unstyled building blocks and interaction patterns for authoring your own custom components.
What are @angular/google-maps and @angular/youtube-player?They are thin Angular component wrappers built on top of the Google Maps JavaScript API and the YouTube Player API respectively.
What are similar projects?material, vuetify, chakra-ui, material-design-lite, base-ui, mdb-ui-kit, kumo, react-spectrum
Which topics is it in?wai-aria, design-tokens, material, responsive, angular, material-design, design-system, accessibility, component-library, ui-components, npm, frontend
Creator
angular
Size
154.2 MB
Stars
25K
Updated
CommitOct 16Releasev22.2.3Oct 14
Age
10y
Commits · 90 Days