Tooltip

The igxTooltip and the igxTooltipTarget directives provide us with the ability to create a fully customizable tooltip and attach it to any element on our page. While most tooltips have a limited number of available positions, with the igxTooltipTarget directive we can specify any position we want on the page while keeping it in relation to the target (anchor) and provide various other overlay settings like scroll strategies and custom animations!

Demo


Usage

The first step is to import the IgxTooltipModule in the app.module.ts file.

// app.module.ts

...
import {
    IgxTooltipModule
} from 'igniteui-angular';

@NgModule({
    ...
    imports: [IgxTooltipModule],
})
export class AppModule {}

Simple tooltip

Let's say we want to create a simple text tooltip like the one above. In our case, we're using our awesome IgxAvatar as the element, so we start by importing the IgxAvatarModule first.

// app.module.ts

...
import {
    IgxTooltipModule,
    IgxAvatarModule
} from 'igniteui-angular';

@NgModule({
    ...
    imports: [IgxTooltipModule, IgxAvatarModule],
})
export class AppModule {}

Tooltip target

The avatar will be our target and all we have to do is set the igxTooltipTarget directive on it, which basically marks our element as one that has a tooltip.

<!--simpleTooltip.component.html-->

<igx-avatar class="avatar" #target="tooltipTarget" igxTooltipTarget
            src="assets/images/avatar/10.jpg" size="medium" [roundShape]="true">
</igx-avatar>

Tooltip

Now let's create the tooltip element itself! Since we want a simple text tooltip, we will define an ordinary div element with text inside and set the igxTooltip directive on it, which marks it as a tooltip.

<!--simpleTooltip.component.html-->

<div #tooltipRef="tooltip" igxTooltip>
    Her name is Madelyn James
</div>

Attach tooltip to target

Now that we have both our target and tooltip defined, all that's left for us to do is assign the tooltip's reference to the igxTooltipTarget selector of the target.

<!--simpleTooltip.component.html-->

<igx-avatar class="avatar" #target="tooltipTarget" [igxTooltipTarget]="tooltipRef"
            src="assets/images/avatar/10.jpg" size="medium" [roundShape]="true">
</igx-avatar>

<div #tooltipRef="tooltip" igxTooltip>
    Her name is Madelyn James
</div>

If everything went well, you should see the sample shown in the Tooltip Demo section.

Show/Hide delay settings

What if we want to control the amount of time that should pass before showing and hiding the tooltip? For this purpose we can use the showDelay and the hideDelay properties of the igxTooltipTarget directive. Both properties are of type number and take time in milliseconds.

Note

The built-in UI interaction behavior of the IgxTooltipTargetDirective and its respective API methods work by taking showDelay and hideDelay property values into account. Showing and hiding the tooltip through the API of the IgxTooltipDirective does not take the showDelay and hideDelay property values into account. If necessary, such logic would have to be implemented manually according to the application's specifics.

Rich tooltip

Customizing and styling the content of our tooltip has never been easier with the igxTooltip directive! Since the tooltip itself is an ordinary element in our markup, we can basically improve its content by adding any elements we need and have the ability to style them accordingly!

Let's expand on the use of the igxTooltip and use it to provide more details for a specific location on a map! We'll use a simple div to represent our map, the IgxAvatar for a logo in our tooltip and the IgxIcon for the location icon on our map. For this purpose, we will get their respective modules.

// app.module.ts

...
import {
    IgxTooltipModule,
    IgxAvatarModule,
    IgxIconModule,
} from 'igniteui-angular';

@NgModule({
    ...
    imports: [IgxTooltipModule, IgxAvatarModule, IgxIconModule],
})
export class AppModule {}

We will also use the following styles for our application:

/* richTooltip.component.css */

.location:hover {
    cursor: pointer;
}

.map {
    overflow: hidden;
    display: flex;
    align-items: center;
    justify-content: center;
    width: 200px;
    height: 252px;
    background-image: url(assets/images/card/media/infragisticsMap.png);
    border: 1px solid #D4D4D4;
}

.locationTooltip {
    width: 310px;
    background-color: var(--igx-grays-700);
    padding: 3px;
    font-size: 13px;
}

.locationTooltipContent {
    display: flex;
    justify-content: center;
    align-items: center;
}

.logo {
    margin-right: 10px;
    min-width: 25px;
    width: 45px;
    height: 45px;
}

Let's start by creating our map. We need a simple div that has for a background an image with a map. Also, we will add an icon that will indicate the position of our location! Since we want to provide more details for this location, our icon will obviously be the tooltip target.

<!--richTooltip.component.html-->

<div class="map">
    <igx-icon class="location" color="blue" fontSet="material"
    [igxTooltipTarget]="locationTooltip">location_on</igx-icon>
    ...
</div>

Now for the tooltip! For its content, we will create a container that will be populated with some text information elements and an avatar. Then we will simply attach the tooltip to the target and include some nice CSS styling!

<!--richTooltip.component.html-->

<div class="wrapper">
    <div class="map">
        <igx-icon class="location" color="blue" fontSet="material"
        [igxTooltipTarget]="locationTooltip">location_on</igx-icon>

        <div class="locationTooltip" #locationTooltip="tooltip" igxTooltip>
            <div class="locationTooltipContent">
                <igx-avatar class="logo" src="assets/images/card/avatars/igLogo.png"
                    size="medium" [roundShape]="false"></igx-avatar>
                <div>
                    <div>Infragistics Inc. HQ</div>
                    <div>2 Commerce Dr, Cranbury, NJ 08512, USA</div>
                </div>
            </div>
        </div>
    </div>
</div>

If all went well, this is how our location and tooltip should look like:


Overlay configuration

Both the igxTooltip and igxTooltipTarget directives use the IgxOverlayService to open and close the respective tooltip element.

The igxTooltipTarget directive exposes an overlaySettings property (inherited from the igxToggleAction), which can be used to customize the animations of our tooltip, its position in the UI and a lot more! If this property is not set, then default overlay settings will be used.

Note

Any property that is set through the overlaySettings will override the same property from the default overlay settings and will have a direct impact on the tooltip.

Styling

To get started with styling the tooltip, we need to import the index file, where all the theme functions and component mixins live:

@import '~igniteui-angular/lib/core/styles/themes/index';

Following the simplest approach, we create a new theme that extends the igx-tooltip-theme and accepts the $text-color, $background and the $border-radius parameters.

$dark-tooltip: igx-tooltip-theme(
    $text-color: #ECAA53,
    $background: #011627,
    $border-radius: 6px
);
Note

In order to style any additional components that are used as part of the tooltip's content (such as IgxButton, IgxSwitch, etc.), an additional theme should be created that is specific to the respective component and placed under the tooltip's scope only (so it does not affect the rest of the application).

Since the tooltip uses the IgxOverlayService, in order for our custom theme to reach down the tooltip that we want to style, we will provide a specific outlet where the tooltip will be placed in the DOM when it is visible.

<igx-avatar #target="tooltipTarget" [igxTooltipTarget]="tooltipRef"
            [igxToggleOutlet]="outlet">
</igx-avatar>

<div #outlet="overlay-outlet" igxOverlayOutlet>
    <div #tooltipRef="tooltip" igxTooltip>
        Her name is Madelyn James
    </div>
</div>
Note

In order to learn more about various options for providing themes to elements that are shown by using the IgxOverlayService, you can take a look at this link.

Including Themes

The last step is to include the component theme in our application.

If $legacy-support is set to true, include the component theme like that:

 @include igx-tooltip($dark-tooltip);
Note

If the component is using an Emulated ViewEncapsulation, it is necessary to penetrate this encapsulation using ::ng-deep

:host {
     ::ng-deep {
        @include igx-tooltip($dark-tooltip);
    }
}

If $legacy-support is set to false(default), include the component css variables like that:

@include igx-css-vars($dark-tooltip);
Note

If the component is using an Emulated ViewEncapsulation, you still have to use :host because you need a global selector in order to override the variables.

:host {
    @include igx-css-vars($dark-tooltip);
}

So now our styled tooltip should look like this:

Demo


Accessibility

Elements with the igxTooltip directive have an autogenerated id property (if not set by the developer), a tooltip role and the aria-hidden attribute that is automatically updated depending on whether the tooltip is visible or not. By setting the aria-describedby attribute of the target to its respective tooltip's id, a reference will be provided to the tooltip element. This provides screenreaders the information needed to read out the tooltip's contents when the end-user triggers the tooltip.

Extra care should be taken in the following scenarios:

  • The tooltip's content is too complex to be automatically interpreted.
  • The tooltip is used with a manually implemented behavior (e.g. manually show/hide) instead of the built-in one.
  • The target element is unfocusable.

API References

In this article we learned how to create, configure and style awesome tooltips for the elements on our page! We also used some additional Ignite UI for Angular components like icons and avatars to improve on the design of our application! The respective APIs are listed below:

Additional components and/or directives that were used:

Styles:

Additional Resources

Our community is active and always welcoming to new ideas.