Components.ContextualHelp Class
Item Index
Methods
Properties
Methods
addListeners
privateapplyPlacement
privatePosition the tooltip/popover
Parameters:
-
offsetObject -
placementObject
enter
privateCalled when a show event has been received
Parameters:
-
eObject
getViewportAdjustedDelta Top: number, left: number
privateParameters:
-
placementObject -
posObject -
actualWidthObject -
actualHeightObject
Returns:
}
hide
privateHide the tooltip/popover
leave
privateCalled when a hide event has been received
Parameters:
-
eObject
removeListeners
privatereplaceArrow
privatePosition the tooltip/popover's arrow
Parameters:
-
deltaObject -
dimensionObject -
isVerticalObject
show
privateShow the tooltip/popover
toggle
privateCalled for a click event
Parameters:
-
eObject
Properties
_renderInPlace boolean
privatearrowElement object
privateThe jQuery object of the arrow element.
autoPlacement boolean
publicWhen true it will dynamically reorient the tooltip/popover. For example, if placement is "left", the
tooltip/popover will display to the left when possible, otherwise it will display right.
Default: false
delay number
publicDelay showing and hiding the tooltip/popover (ms). Individual delays for showing and hiding can be specified by using the
delayShow and delayHide properties.
Default: 0
delayHide number
publicDelay hiding the tooltip/popover. This property overrides the general delay set with the delay property.
Default: 0
delayShow number
publicDelay showing the tooltip/popover. This property overrides the general delay set with the delay property.
Default: 0
fade boolean
publicSet to false to disable fade animations.
Default: true
hoverState string
privateCurrent hover state, 'in', 'out' or null
in boolean
privateUsed to apply Bootstrap's "in" class
Default: false
inDom boolean
privateinState {InState}
privateCurrent state for events
overlayElement object
privateThe jQuery object of the overlay element.
overlayId string
privateThe id of the overlay element.
renderInPlace boolean
publicIf true component will render in place, rather than be wormholed.
Default: false
timer unknown
privateEmber.run timer
title string
publicHow to position the tooltip/popover - top | bottom | left | right
Default: 'top'
title string
publictransitionDuration number
publicThe duration of the fade transition
Default: 150
triggerElement string
publicThe DOM element that triggers the tooltip/popover. By default it is the parent element of this component. You can set this to any jQuery selector to have any other element trigger the tooltip/popover. With the special value of "parentView" you can attach the tooltip/popover to the parent component's element.
triggerEvents array|string
publicThe event(s) that should trigger the tooltip/popover - click | hover | focus. You can set this to a single event or multiple events, given as an array or a string separated by spaces.
Default: 'hover focus'
triggerTargetElement {jQuery}
privateusesTransition boolean
privateUse CSS transitions when showing/hiding?
viewportElement object
privateThe jQuery object of the viewport element.
viewportPadding number
publicTake a padding into account for keeping the tooltip/popover within the bounds of the element given by viewportSelector.
Default: 0
viewportSelector string
publicKeeps the tooltip/popover within the bounds of this element when autoPlacement is true. Can be any valid jQuery selector.
Default: 'body'
visible boolean
publicYou can programmatically show the tooltip/popover by setting this to true
Default: false
Events
onHidden
public
This action is called when the tooltip/popover has finished being hidden from the user (will wait for CSS transitions to complete).
onHide
public
This action is called immediately when the tooltip/popover is about to be hidden.
onShow
public
This action is called immediately when the tooltip/popover is about to be shown.
onShown
public
This action will be called when the tooltip/popover has been made visible to the user (will wait for CSS transitions to complete).