Incomplete typing for ngTooltip directive #3845

aha-tech · 2020-09-05T10:42:30Z

Bug description:

The input for the ngTooltip directive is defined as

  /**
   * The string content or a `TemplateRef` for the content to be displayed in the tooltip.
   *
   * If the content if falsy, the tooltip won't open.
   */
  @Input()
  set ngbTooltip(value: string | TemplateRef<any>) {

As the comment notes, the input can be falsy, however, the only falsy value allowed by the types is the empty string. It would be nice if the typing also allod for null and undefined. Running angular/typescript in strict mode makes it rather inconvenient to bind ngTooltip to a nullable property at the moment.

Link to minimally-working StackBlitz that reproduces the issue:

https://stackblitz.com/edit/angular-jhnsp4-yzls3r?file=src/app/tooltip-basic.html

Versions of Angular, ng-bootstrap and Bootstrap:

Angular: 10.1

ng-bootstrap: 7.0.0

Bootstrap: 4.5.2

The text was updated successfully, but these errors were encountered:

The documentation says that falsy values are accepted, but in strict mode, only the empty string could actually be passed. fix ng-bootstrap#3845

This makes it consistent with the behavior of tooltip. It also makes more sense since the title is an optional input, and its default value is thus undefined (which, in strict mode, is neither a string nor a TemplateRef). Note that a test checked that no title was displayed when the title was empty, but it actually checked that no title was displayed if the title was undefined. And it *did* display an empty title if the title was an empty string. Now, the title is displayed only is it is truthy. refs ng-bootstrap#3845

The documentation says that falsy values are accepted, but in strict mode, only the empty string could actually be passed. fix ng-bootstrap#3845

This makes it consistent with the behavior of tooltip. It also makes more sense since the title is an optional input, and its default value is thus undefined (which, in strict mode, is neither a string nor a TemplateRef). Note that a test checked that no title was displayed when the title was empty, but it actually checked that no title was displayed if the title was undefined. And it *did* display an empty title if the title was an empty string. Now, the title is displayed only is it is truthy. refs ng-bootstrap#3845

This makes it consistent with the behavior of tooltip. It also makes more sense since the title is an optional input, and its default value is thus undefined (which, in strict mode, is neither a string nor a TemplateRef). Note that a test checked that no title was displayed when the title was empty, but it actually checked that no title was displayed if the title was undefined. And it *did* display an empty title if the title was an empty string. Now, the title is displayed only is it is truthy. refs #3845

benouat added the component: tooltip label Sep 7, 2020

maxokorokov closed this as completed in b713e38 Nov 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incomplete typing for ngTooltip directive #3845

Incomplete typing for ngTooltip directive #3845

aha-tech commented Sep 5, 2020 •

edited

Incomplete typing for ngTooltip directive #3845

Incomplete typing for ngTooltip directive #3845

Comments

aha-tech commented Sep 5, 2020 • edited

Bug description:

Link to minimally-working StackBlitz that reproduces the issue:

Versions of Angular, ng-bootstrap and Bootstrap:

aha-tech commented Sep 5, 2020 •

edited