Skip to content
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

Improve documentation for core-icon when using custom icon sets #738

Closed
kbenjamin opened this issue Sep 1, 2014 · 2 comments
Closed

Improve documentation for core-icon when using custom icon sets #738

kbenjamin opened this issue Sep 1, 2014 · 2 comments

Comments

@kbenjamin
Copy link

Re: http://www.polymer-project.org/docs/elements/core-elements.html#core-icon

The method for using custom icon sets is not clear and also in error in the documentation for core-icon:

Example using icon cherry from custom iconset fruit:

<core-icon icon="fruit:cherry"></core-icon>
See core-iconset and core-iconset-svg for more information about how to use a 
custom iconset.

See core-icons for the default set of icons. To use the default set of icons you'll 
need to include an import for core-icons.html. To use a different built-in set of 
icons, you'll need to include an import for core-icons/iconsets/<iconset>.html.

Firstly, additional icon sets are located in core-icons/<iconset>.html.

Second, the fruit:cherry example does not make it clear that additional icon sets are
identified by an HTML ID and that fruit is the ID for that icon set.
A better example would be to use one of the existing icon sets for an example i.e.

<link rel="import" href="../core-icons/social-icons.html"> // iconset HTML ID is 'social'
<link rel="import" href="../core-icons/av-icons.html"> // iconset HTML ID is 'av'
<core-icon icon="social:public"></core-icon> // icon from the custom social-icons iconset
<core-icon icon="av:volume-mute"></core-icon> // icon from the custom av-icons iconset

In addition, some similar language in the demo for http://www.polymer-project.org/components/core-icons/demo.html would be helpful.

Lastly, the [<iconset id>:]<icon id> syntax should be documented in the API reference, as well.

Otherwise, keep up all the great work and thanks!

@tjsavage
Copy link
Contributor

tjsavage commented Sep 2, 2014

auto-moving this issue to Polymer/old-docs-site#629 and closing this one

@tjsavage tjsavage closed this as completed Sep 2, 2014
@tjsavage
Copy link
Contributor

tjsavage commented Sep 2, 2014

Thanks for the feedback! Moving this to the docs repo to get some attention there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants