import { KbqToolTipModule } from '@koobiq/components/tooltip';

Selector: kbq-tooltip-component

Properties
Name Description
arrow: boolean
changeDetectorRef: ChangeDetectorRef
classMap: {}
closeOnInteraction: boolean
content: string | TemplateRef
context: { $implicit: any; }
defaultPaddings: boolean
destroyRef: DestroyRef
elementRef: ElementRef
header: string | TemplateRef
hovered: BehaviorSubject Stream that emits when the popup item is hovered.
offset: number
onHideSubject: Subject Subject for notifying that the tooltip has been hidden from the view
prefix: string
renderer: Renderer2
trigger: KbqPopUpTrigger
visibility: PopUpVisibility
visibleChange: EventEmitter
warning: boolean
Methods
addEventListenerForHide
afterHidden
Returns an observable that notifies when the tooltip has been hidden from view.
animationDone
animationStart
detectChanges
handleBodyInteraction
hide
Hides the popup after a specified delay. The hide timeout triggers the hiding of the popup by updating visibility and emitting relevant events. Also, it marks for check to ensure proper change detection, especially for parent components with OnPush strategy.
isTemplateRef
isVisible
markForCheck
setStickPosition
show
updateClassMap

Selector: [kbqTooltip]

Exported as: kbqTooltip
Properties
Name Description
@Input('kbqTooltipArrow')
arrow: boolean
@Input('kbqTooltipColor')
color: string
@Input('kbqTooltip')
content: string | TemplateRef
@Input('kbqTooltipContext')
context: any
@Input('kbqTooltipClass')
customClass: string
@Input('kbqTooltipDisabled')
disabled: boolean
@Input('kbqEnterDelay')
enterDelay: number
@Input()
forDisabledComponent: InputSignal>>
Input for controlling the disabled state of a component. The input expects a component containing `disabledSignal` property, which is a writable signal emitting boolean values.
@Input()
hideWithTimeout: boolean
Changes hiding behavior. By default, tooltip is hidden on mouseleave from trigger. Setting hideWithTimeout to true will delay tooltip hiding and will not hide when the mouse moves from trigger to tooltip.
@Input()
ignoreTooltipPointerEvents: InputSignal
Determines whether pointer events should be ignored on tooltips. When set to `true`, tooltip elements will not receive pointer events, allowing interactions to pass through to underlying elements. Defaults to `true`.
@Input('kbqLeaveDelay')
leaveDelay: number
@Input('kbqTooltipOffset')
offset: number
@Input('kbqRelativeToPointer')
relativeToPointer: boolean
Positions the tooltip relative to the mouse cursor. Only available for top and bottom kbqPlacement. Does not work with kbqPlacementPriority.
@Input('kbqPlacement')
tooltipPlacement: "top" | "topLeft" | "topRight" | "right" | "rightTop" | "rightBottom" | "left" | "leftTop" | "leftBottom" | "bottom" | "bottomLeft" | "bottomRight"
@Input('kbqPlacementPriority')
tooltipPlacementPriority: string | string[]
@Input('kbqVisible')
tooltipVisible: boolean
@Input('kbqTrigger')
trigger: string
@Output('kbqPlacementChange')
placementChange: EventEmitter
@Output('kbqVisibleChange')
visibleChange: EventEmitter
availablePositions: { [key: string]: ConnectionPositionPair; }
closingActionsSubscription: Subscription
container: HTMLElement
destroyRef: DestroyRef
detach: () => void
direction: Directionality
elementRef: ElementRef
focusMonitor: FocusMonitor
hostView: ViewContainerRef
hovered: BehaviorSubject Stream that emits when the popupTrigger is hovered.
instance: any
isOpen: boolean
listeners: Map
modifier: TooltipModifier
mouseEvent: MouseEvent
ngZone: NgZone
onPositionChange: ($event: ConnectedOverlayPositionChange) => void
originSelector: string
overlay: Overlay
overlayConfig: OverlayConfig
overlayRef: OverlayRef
parentPopup: KbqParentPopup
placement: "top" | "topLeft" | "topRight" | "right" | "rightTop" | "rightBottom" | "left" | "leftTop" | "leftBottom" | "bottom" | "bottomLeft" | "bottomRight"
placementPriority: string | string[]
portal: ComponentPortal
preventClose: boolean prevents closure by any event
scheduler: AsyncScheduler
scrollDispatcher: ScrollDispatcher
scrollStrategy: () => ScrollStrategy
scrollable: CdkScrollable
stickToWindow: "top" | "right" | "left" | "bottom"
strategy: FlexibleConnectedPositionStrategy
triggerName: string
visible: boolean
Methods
applyRelativeToPointer
clearListeners
closingActions
createOverlay
Create the overlay config and position strategy
focus
getAdjustedPositions
Returns a list of positions that are aligned with the element's dimensions and offsets.
getMouseLeaveListener
getOverlayHandleComponentType
getPrioritizedPositions
getPriorityPlacementStrategy
hide
initListeners
keydownHandler
resetOrigin
show
showForElement
method allows to show the tooltip relative to the element Use this approach when it is not possible to define a trigger in the template. For example: const tooltip = new KbqTooltipTrigger(); tooltip.showForElement(element);
showForMouseEvent
method allows to show the tooltip relative to the given mouse event.
touchendHandler
updateClassMap
updateData
updatePlacement
updatePlacementPriority
updatePosition
Updates the position of the current popover.
updateVisible
const KBQ_TOOLTIP_OPEN_TIME: InjectionToken<() => ScrollStrategy>;
const MIN_TIME_FOR_DELAY: number;
const KBQ_TOOLTIP_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;
Вопросы и предложения по документации
Если у вас есть вопросы или вы хотите внести свой вклад в написание документации, пожалуйста, создайте issue в нашем репозитории на GitHub.