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.

Sign up for GitHub

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

docs: Explicit imports #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Explicit imports #13

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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ The `HeroIcon` component supports the following arguments:
- `@icon` - the name of the icon to render
- `@type` - one of `outline`, `solid`, `mini` or `micro`

### Explicit imports

When using with [ember-template-imports](https://github.com/ember-template-imports/ember-template-imports) you will need to import the component using following path:

```js
import HeroIcon from 'ember-heroicons/components/hero-icon';
```

### Custom configuration

By default, all icons for all types will be available within your application. Additionally, the default icon `type`, if not specified, will be `outline`.
Expand Down