Skip to content

Commit 74180a3

Browse files
authored
feat: add tooltip support to vaadin-icon (#4521)
1 parent d47abbb commit 74180a3

6 files changed

Lines changed: 20 additions & 3 deletions

File tree

‎dev/icon.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@
1010
<script type="module">
1111
import '@vaadin/icon';
1212
import '@vaadin/icons/vaadin-iconset.js';
13+
import '@vaadin/tooltip';
1314
</script>
1415
</head>
1516

1617
<body>
17-
<vaadin-icon icon="vaadin:phone"></vaadin-icon>
18+
<vaadin-icon icon="vaadin:phone">
19+
<vaadin-tooltip slot="tooltip" text="Icon tooltip text"></vaadin-tooltip>
20+
</vaadin-icon>
1821
</body>
1922
</html>

‎integration/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"@vaadin/email-field": "23.3.0-alpha0",
2020
"@vaadin/grid": "23.3.0-alpha0",
2121
"@vaadin/grid-pro": "23.3.0-alpha0",
22+
"@vaadin/icon": "23.3.0-alpha0",
2223
"@vaadin/integer-field": "23.3.0-alpha0",
2324
"@vaadin/number-field": "23.3.0-alpha0",
2425
"@vaadin/message-input": "23.3.0-alpha0",

‎integration/tests/component-tooltip.test.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { DatePicker } from '@vaadin/date-picker';
1010
import { DateTimePicker } from '@vaadin/date-time-picker';
1111
import { Details } from '@vaadin/details';
1212
import { EmailField } from '@vaadin/email-field';
13+
import { Icon } from '@vaadin/icon';
1314
import { IntegerField } from '@vaadin/integer-field';
1415
import { MessageInput } from '@vaadin/message-input';
1516
import { MultiSelectComboBox } from '@vaadin/multi-select-combo-box';
@@ -37,6 +38,7 @@ import { mouseenter, mouseleave } from '@vaadin/tooltip/test/helpers.js';
3738
{ tagName: DateTimePicker.is, applyShouldNotShowCondition: (element) => element.querySelector('input').click() },
3839
{ tagName: Details.is, targetSelector: '[part="summary"]', position: 'bottom-start' },
3940
{ tagName: EmailField.is },
41+
{ tagName: Icon.is },
4042
{ tagName: IntegerField.is },
4143
{ tagName: MessageInput.is },
4244
{ tagName: MultiSelectComboBox.is, applyShouldNotShowCondition: (comboBox) => comboBox.click() },

‎packages/icon/src/vaadin-icon.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* Copyright (c) 2021 - 2022 Vaadin Ltd.
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
6+
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
67
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
78
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
89
import type { IconSvgLiteral } from './vaadin-icon-svg.js';
@@ -46,7 +47,7 @@ import type { IconSvgLiteral } from './vaadin-icon-svg.js';
4647
* }
4748
* ```
4849
*/
49-
declare class Icon extends ThemableMixin(ElementMixin(HTMLElement)) {
50+
declare class Icon extends ThemableMixin(ElementMixin(ControllerMixin(HTMLElement))) {
5051
/**
5152
* The name of the icon to use. The name should be of the form:
5253
* `iconset_name:icon_name`. When using `vaadin-icons` it is possible

‎packages/icon/src/vaadin-icon.js‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
66
import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
7+
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
78
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
9+
import { TooltipController } from '@vaadin/component-base/src/tooltip-controller.js';
810
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
911
import { ensureSvgLiteral, renderSvg } from './vaadin-icon-svg.js';
1012
import { Iconset } from './vaadin-iconset.js';
@@ -51,10 +53,11 @@ const DEFAULT_ICONSET = 'vaadin';
5153
* ```
5254
*
5355
* @extends HTMLElement
56+
* @mixes ControllerMixin
5457
* @mixes ThemableMixin
5558
* @mixes ElementMixin
5659
*/
57-
class Icon extends ThemableMixin(ElementMixin(PolymerElement)) {
60+
class Icon extends ThemableMixin(ElementMixin(ControllerMixin(PolymerElement))) {
5861
static get template() {
5962
return html`
6063
<style>
@@ -87,6 +90,8 @@ class Icon extends ThemableMixin(ElementMixin(PolymerElement)) {
8790
preserveAspectRatio="xMidYMid meet"
8891
aria-hidden="true"
8992
></svg>
93+
94+
<slot name="tooltip"></slot>
9095
`;
9196
}
9297

@@ -147,6 +152,9 @@ class Icon extends ThemableMixin(ElementMixin(PolymerElement)) {
147152
ready() {
148153
super.ready();
149154
this.__svgElement = this.shadowRoot.querySelector('svg');
155+
156+
this._tooltipController = new TooltipController(this);
157+
this.addController(this._tooltipController);
150158
}
151159

152160
/** @private */
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
import type { ControllerMixinClass } from '@vaadin/component-base/src/controller-mixin';
12
import type { Icon, IconSvgLiteral } from '../../vaadin-icon';
23

34
const assertType = <TExpected>(actual: TExpected) => actual;
45

56
const icon = document.createElement('vaadin-icon');
67
assertType<Icon>(icon);
8+
assertType<ControllerMixinClass>(icon);
79

810
assertType<IconSvgLiteral | null>(icon.svg);

0 commit comments

Comments
 (0)