Skip to content

docs(icon): add overview file #2306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 21, 2016
Merged

docs(icon): add overview file #2306

merged 3 commits into from
Dec 21, 2016

Conversation

mmalerba
Copy link
Contributor

No description provided.

@mmalerba mmalerba requested a review from jelbourn December 20, 2016 23:36
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 20, 2016
# md-icon

`md-icon` is a component that displays an icon, which can be a font glyph or an SVG image.

Copy link
Member

Choose a reason for hiding this comment

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

How about

`md-icon` makes it easier to use _vector-based_ icons in your app. 
This directive supports both icon fonts and SVG icons, but not bitmap-based formats (png, jpg, etc.).


Note that all SVG icons are fetched via XmlHttpRequest, and due to the same-origin policy their URLs
must be on the same domain as the containing page, or their servers must be configured to allow
cross-domain access.
Copy link
Member

Choose a reason for hiding this comment

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

We need to note in here that, to guard against XSS, any URLs given to the MdIconRegistry must be marked as trusted resource URLs by using Angular's DomSantizer service.

@mmalerba
Copy link
Contributor Author

Done

@jelbourn
Copy link
Member

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Dec 21, 2016
@jelbourn jelbourn merged commit c10f1f7 into angular:master Dec 21, 2016
@mmalerba mmalerba deleted the icon-docs branch December 25, 2016 23:36
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants