Skip to content

Commit

Permalink
docs(tooltip): add $tooltipProvider docs
Browse files Browse the repository at this point in the history
Until now, the $tooltipProvider has been an undocumented feature, but as
there are now several options requested by the community at large, it is
finally included in the documentation.
  • Loading branch information
Josh David Miller authored and pkozlowski-opensource committed Jun 24, 2013
1 parent dfa5315 commit 6a4527b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/popover/docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@ will display:

The popover directives require the `$position` service.

The popover directive also supports various default configurations through the
$tooltipProvider. See the [tooltip](#tooltip) section for more information.

19 changes: 19 additions & 0 deletions src/tooltip/docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,22 @@ provided hide triggers:
For any non-supported value, the trigger will be used to both show and hide the
tooltip.

**$tooltipProvider**

Through the `$tooltipProvider`, you can change the way tooltips and popovers
behave by default; the attributes above always take precedence. The following
methods are available:

- `setTriggers( obj )`: Extends the default trigger mappings mentioned above
with mappings of your own. E.g. `{ 'openTrigger': 'closeTrigger' }`.
- `options( obj )`: Provide a set of defaults for certain tooltip and popover
attributes. Currently supports 'placement', 'animation', 'popupDelay', and
`appendToBody`. Here are the defaults:

<pre>
placement: 'top',
animation: true,
popupDelay: 0,
appendToBody: false
</pre>

0 comments on commit 6a4527b

Please sign in to comment.