Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Fixed the doc so the events match the actual directive events.
  • Loading branch information
jordanburke committed May 21, 2016
1 parent c28dfcb commit 09eed6c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ an AngularJS wrapper around a jquery plugin, this directive still uses chardin.j
`data-intro`: Text to show with the instructions
`data-position`: (`left`, `top`, `right`, `bottom`), where to place the text with respect to the element

Additionally this directive provides delegation of chardin.js start and stop events via, help-overlay-start and
help-overlay-stop:
Additionally this directive provides delegation of chardin.js start and stop events via, overlay-start-callback and
overlay-stop-callback:

```HTML
<body help-overlay="showHelp" help-overlay-start="startFn(event)" help-overlay-stop="stopFn(event)">...</body>
<body help-overlay="showHelp" overlay-start-callback="startFn(event)" overlay-stop-callback="stopFn(event)">...</body>
```

events being passed are the original chardin.js event objects.
Expand Down

0 comments on commit 09eed6c

Please sign in to comment.