Skip to content

Commit 2ec1f1f

Browse files
authored
refactor: rename tooltip.textGenerator to generator (#4616)
1 parent b2623bc commit 2ec1f1f

12 files changed

Lines changed: 28 additions & 28 deletions

File tree

‎dev/grid.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
};
3232

3333
const tooltip = document.querySelector('[slot="tooltip"]');
34-
tooltip.textGenerator = ({column, item}) => {
34+
tooltip.generator = ({column, item}) => {
3535
return column && column.path && item ? `Tooltip ${column.path} ${item.name}` : '';
3636
};
3737
</script>

‎dev/menu-bar.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
];
3636

3737
const tooltip = document.querySelector('[slot="tooltip"]');
38-
tooltip.textGenerator = ({ item }) => item.tooltip;
38+
tooltip.generator = ({ item }) => item.tooltip;
3939
</script>
4040
</head>
4141

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ describe('tooltip', () => {
3838
flushGrid(grid);
3939

4040
tooltip = grid.querySelector('vaadin-tooltip');
41-
tooltip.textGenerator = ({ column, item }) => {
41+
tooltip.generator = ({ column, item }) => {
4242
return column && column.path && item ? `${column.path}: ${item[column.path]}` : '';
4343
};
4444
});

‎integration/tests/menu-bar-tooltip.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ describe('menu-bar with tooltip', () => {
4545
buttons = menuBar._buttons;
4646

4747
tooltip = menuBar.querySelector('vaadin-tooltip');
48-
tooltip.textGenerator = ({ item }) => item && `${item.text} tooltip`;
48+
tooltip.generator = ({ item }) => item && `${item.text} tooltip`;
4949
});
5050

5151
it('should set manual on the tooltip to true', () => {

‎packages/avatar-group/src/vaadin-avatar-group.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ class AvatarGroup extends ResizeMixin(ElementMixin(ThemableMixin(PolymerElement)
132132
on-keydown="_onOverflowKeyDown"
133133
aria-haspopup="listbox"
134134
>
135-
<vaadin-tooltip slot="tooltip" text-generator="[[__overflowTextGenerator]]"></vaadin-tooltip>
135+
<vaadin-tooltip slot="tooltip" generator="[[__overflowTextGenerator]]"></vaadin-tooltip>
136136
</vaadin-avatar>
137137
</div>
138138
<vaadin-avatar-group-overlay

‎packages/avatar-group/test/avatar-group.test.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ describe('avatar-group', () => {
8282
expect(overflow.abbr).to.equal('+3');
8383
});
8484

85-
it('should set text generator on the overflow avatar tooltip', () => {
85+
it('should set generator on the overflow avatar tooltip', () => {
8686
const overflow = group.$.overflow;
8787
const items = group.items;
8888
const tooltip = overflow.querySelector('vaadin-tooltip');

‎packages/component-base/src/tooltip-controller.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ type TooltipPosition =
2424
*/
2525
export class TooltipController extends SlotController {
2626
/**
27-
* Object with properties passed to `textGenerator`
27+
* Object with properties passed to `generator`
2828
* function to be used for generating tooltip text.
2929
*/
3030
context: Record<string, unknown>;
@@ -52,7 +52,7 @@ export class TooltipController extends SlotController {
5252
target: HTMLElement;
5353

5454
/**
55-
* Set a context object to be used by text generator.
55+
* Set a context object to be used by generator.
5656
*/
5757
setContext(context: Record<string, unknown>): void;
5858

‎packages/component-base/src/tooltip-controller.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export class TooltipController extends SlotController {
4848
}
4949

5050
/**
51-
* Set a context object to be used by text generator.
51+
* Set a context object to be used by generator.
5252
* @param {object} context
5353
*/
5454
setContext(context) {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ declare class Tooltip extends ThemePropertyMixin(ElementMixin(HTMLElement)) {
7878
static setDefaultHoverDelay(delay: number): void;
7979

8080
/**
81-
* Object with properties passed to `textGenerator`
81+
* Object with properties passed to `generator`
8282
* function to be used for generating tooltip text.
8383
*/
8484
context: Record<string, unknown>;
@@ -158,7 +158,7 @@ declare class Tooltip extends ThemePropertyMixin(ElementMixin(HTMLElement)) {
158158
* Use the `context` property to provide argument
159159
* that can be passed to the generator function.
160160
*/
161-
textGenerator: (context: Record<string, unknown>) => string;
161+
generator: (context: Record<string, unknown>) => string;
162162
}
163163

164164
declare global {

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
9898
static get properties() {
9999
return {
100100
/**
101-
* Object with properties passed to `textGenerator`
101+
* Object with properties passed to `generator`
102102
* function to be used for generating tooltip text.
103103
*/
104104
context: {
@@ -212,7 +212,7 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
212212
* Use the `context` property to provide argument
213213
* that can be passed to the generator function.
214214
*/
215-
textGenerator: {
215+
generator: {
216216
type: Object,
217217
},
218218

@@ -238,7 +238,7 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
238238
}
239239

240240
static get observers() {
241-
return ['__textGeneratorChanged(_overlayElement, textGenerator, context)'];
241+
return ['__generatorChanged(_overlayElement, generator, context)'];
242242
}
243243

244244
/**
@@ -328,7 +328,7 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
328328

329329
/** @private */
330330
__tooltipRenderer(root) {
331-
root.textContent = typeof this.textGenerator === 'function' ? this.textGenerator(this.context) : this.text;
331+
root.textContent = typeof this.generator === 'function' ? this.generator(this.context) : this.text;
332332
}
333333

334334
/** @private */
@@ -655,13 +655,13 @@ class Tooltip extends ThemePropertyMixin(ElementMixin(PolymerElement)) {
655655
}
656656

657657
/** @private */
658-
__textGeneratorChanged(overlayElement, textGenerator, context) {
658+
__generatorChanged(overlayElement, generator, context) {
659659
if (overlayElement) {
660-
if (textGenerator !== this.__oldTextGenerator || context !== this.__oldContext) {
660+
if (generator !== this.__oldTextGenerator || context !== this.__oldContext) {
661661
overlayElement.requestContentUpdate();
662662
}
663663

664-
this.__oldTextGenerator = textGenerator;
664+
this.__oldTextGenerator = generator;
665665
this.__oldContext = context;
666666
}
667667
}

0 commit comments

Comments
 (0)