Skip to content

SiTooltipService documentation

A service to create tooltips for specific elements. Use this if the tooltip directive is not suitable. Must not be used outside element-ng.

Attributes and Methods

NameTypeDefaultDescription
createTooltip(...)
(config: { describedBy: string, element: ElementRef, injector: Injector, placement: ("end" | "start" | "top" | "bottom" | "auto") }) => TooltipRefParameters
  • config: { describedBy: string, element: ElementRef, injector: Injector, placement: ("end" | "start" | "top" | "bottom" | "auto") }

Types Documentation

TooltipRef is attached to a specific element. Use it to show or hide a tooltip for that element.
Constructor
(overlayRef: OverlayRef, element: ElementRef, describedBy: string, injector: Injector) => {}
Parameters
overlayRef: OverlayRef
element: ElementRef
describedBy: string
injector?: Injector
Properties
describedBy: string
element: ElementRef
injector?: Injector
overlayRef: OverlayRef
Methods
destroy: () => void
hide: () => void
(content: (Type<any> | TranslatableString | TemplateRef<any>)) => void
Parameters
content: (Type<any> | TranslatableString | TemplateRef<any>)
(string & Translatable)
Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality.
Translatable
import

Except where otherwise noted, content on this site is licensed under MIT License.