Skip to content

Commit

Permalink
docs(improve readme regarding styles) (#128)
Browse files Browse the repository at this point in the history
* docs(readme) describe arrow usage on attach-popover

* docs(readme) improve example rendering

* Update README.md
  • Loading branch information
mostafa-sakhiri authored and kybishop committed Apr 23, 2018
1 parent 836f7d5 commit b9ef250
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Tooltips and popovers made easy.
Just drop an `{{#attach-tooltip}}` or `{{#attach-popover}}` in a parent and your popper is ready to go!

```html
```hbs
<button>
Click me
Expand Down Expand Up @@ -163,6 +163,12 @@ module.exports = function(environment) {

The full list of editable defaults can be seen [here](https://github.com/kybishop/ember-attacher/blob/master/addon/defaults.js).

## Styles

`ember-attacher` provides [styles](https://github.com/kybishop/ember-attacher/blob/master/addon/styles/addon.scss#L85) for the default tooltip class, `ember-attacher-tooltip`, but no styles are included for `{{attach-popover}}`.

Example styling for a popover [can be found in the dummy app](https://github.com/kybishop/ember-attacher/blob/master/tests/dummy/app/styles/app.scss#L132). Note how the arrow must also be styled to match the popover (background color, size, etc.)

## Testing

Use the `isVisible()` test helper to check if an attachment is visible.
Expand Down

0 comments on commit b9ef250

Please sign in to comment.