Skip to content
This repository was archived by the owner on May 29, 2019. It is now read-only.

Issue #5615 (Document popover-enable) #5626

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
17 changes: 11 additions & 6 deletions src/popover/docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,18 @@ All these settings are available for the three types of popovers.
<small class="badge">C</small>
_(Default: `true`, Config: `animation`)_ -
Should it fade in and out?

* `popover-append-to-body`
<small class="badge">$</small>
<small class="badge">C</small>
_(Default: `false`, Config: `appendToBody`)_ -
Should the popover be appended to '$body' instead of the parent element?


* `popover-enable`
<small class="badge">$</small>
_(Default: `true`)_ -
Is it enabled? It will enable or disable the configured popover-trigger.

* `popover-is-open`
<i class="glyphicon glyphicon-eye-open"></i>
_(Default: `false`)_ -
Expand All @@ -43,7 +48,7 @@ All these settings are available for the three types of popovers.
<small class="badge">C</small>
_(Default: `top`, Config: `placement`)_ -
Passing in 'auto' separated by a space before the placement will enable auto positioning, e.g: "auto bottom-left". The popover will attempt to position where it fits in the closest scrollable ancestor. Accepts:

* `top` - popover on top, horizontally centered on host element.
* `top-left` - popover on top, left edge aligned with host element left edge.
* `top-right` - popover on top, right edge aligned with host element right edge.
Expand All @@ -56,7 +61,7 @@ All these settings are available for the three types of popovers.
* `right` - popover on right, vertically centered on host element.
* `right-top` - popover on right, top edge aligned with host element top edge.
* `right-bottom` - popover on right, bottom edge aligned with host element bottom edge.

* `popover-popup-close-delay`
<small class="badge">C</small>
_(Default: `0`, Config: `popupCloseDelay`)_ -
Expand All @@ -69,7 +74,7 @@ All these settings are available for the three types of popovers.

* `popover-title` -
A string to display as a fancy title.

* `popover-trigger`
_(Default: `click`)_ -
What should trigger a show of the popover? Supports a space separated list of event names (see below).
Expand Down Expand Up @@ -101,7 +106,7 @@ methods are available:
* `setTriggers(obj)`
_(Example: `{ 'openTrigger': 'closeTrigger' }`)_ -
Extends the default trigger mappings mentioned above with mappings of your own.

* `options(obj)` -
Provide a set of defaults for certain tooltip and popover attributes. Currently supports the ones with the <small class="badge">C</small> badge.

Expand Down