Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

docs: Add optional dependencies to getting started guide. #5123

Closed
wants to merge 1 commit into from
Closed

docs: Add optional dependencies to getting started guide. #5123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/app/partials/getting-started.tmpl.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,22 @@ <h3>Including Angular Material and its dependencies</h3>
<li><a href="https://github.com/angular/material#cdn">Using a CDN</a> (example below)</li>
</ul>

<h3>Include Optional Dependencies</h3>
<p>
Angular Material integrates with some additional libraries which you may optionally include:
</p>
<ul style="margin-bottom: 2em;">
<li>
<a href="https://docs.angularjs.org/api/ngMessages">ngMessages</a>
- Provides a consistent mechanism for displaying form errors and other messages.
</li>

<li>
<a href="https://docs.angularjs.org/api/ngRoute">ngRoute</a>
- Provides a clean routing system for your application.
</li>
</ul>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably have

  • some verbiage about requirements for AngularJS 1.3.19 (or higher), or 1.4.7 (or higher), 1.5.x.
  • an explicit notice regarding the dependency on ngMaterial: angular.module("<yourAppName>", ['ngMaterial'])

<iframe height='272' scrolling='no' data-default-tab="html"
src='//codepen.io/marcysutton/embed/OPbpKm?height=272&theme-id=11083'
frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'>
Expand Down