Skip to content

Commit a4ba585

Browse files
authored
fix: position the material text-area bottom bar (#3359)
1 parent dea35ea commit a4ba585

10 files changed

Lines changed: 126 additions & 4 deletions

File tree

‎packages/text-area/src/vaadin-text-area.d.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
55
*/
66
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
7+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
78
import { InputFieldMixin } from '@vaadin/field-base/src/input-field-mixin.js';
89
import { PatternMixin } from '@vaadin/field-base/src/pattern-mixin.js';
910
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
@@ -76,7 +77,7 @@ export interface TextAreaEventMap extends HTMLElementEventMap, TextAreaCustomEve
7677
* @fires {CustomEvent} invalid-changed - Fired when the `invalid` property changes.
7778
* @fires {CustomEvent} value-changed - Fired when the `value` property changes.
7879
*/
79-
declare class TextArea extends PatternMixin(InputFieldMixin(ThemableMixin(ElementMixin(HTMLElement)))) {
80+
declare class TextArea extends ResizeMixin(PatternMixin(InputFieldMixin(ThemableMixin(ElementMixin(HTMLElement))))) {
8081
/**
8182
* Maximum number of characters (in Unicode code points) that the user can enter.
8283
*/

‎packages/text-area/src/vaadin-text-area.js‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import '@vaadin/input-container/src/vaadin-input-container.js';
77
import { html, PolymerElement } from '@polymer/polymer';
88
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
9+
import { ResizeMixin } from '@vaadin/component-base/src/resize-mixin.js';
910
import { InputFieldMixin } from '@vaadin/field-base/src/input-field-mixin.js';
1011
import { LabelledInputController } from '@vaadin/field-base/src/labelled-input-controller.js';
1112
import { PatternMixin } from '@vaadin/field-base/src/pattern-mixin.js';
@@ -59,8 +60,9 @@ registerStyles('vaadin-text-area', inputFieldShared, { moduleId: 'vaadin-text-ar
5960
* @mixes ElementMixin
6061
* @mixes PatternMixin
6162
* @mixes ThemableMixin
63+
* @mixes ResizeMixin
6264
*/
63-
export class TextArea extends PatternMixin(InputFieldMixin(ThemableMixin(ElementMixin(PolymerElement)))) {
65+
export class TextArea extends ResizeMixin(PatternMixin(InputFieldMixin(ThemableMixin(ElementMixin(PolymerElement))))) {
6466
static get is() {
6567
return 'vaadin-text-area';
6668
}
@@ -140,6 +142,7 @@ export class TextArea extends PatternMixin(InputFieldMixin(ThemableMixin(Element
140142
disabled="[[disabled]]"
141143
invalid="[[invalid]]"
142144
theme$="[[theme]]"
145+
on-scroll="__scrollPositionUpdated"
143146
>
144147
<slot name="prefix" slot="prefix"></slot>
145148
<slot name="textarea"></slot>
@@ -197,7 +200,26 @@ export class TextArea extends PatternMixin(InputFieldMixin(ThemableMixin(Element
197200
super.connectedCallback();
198201

199202
this._inputField = this.shadowRoot.querySelector('[part=input-field]');
203+
204+
// Wheel scrolling results in async scroll events. Preventing the wheel
205+
// event, scrolling manually and then synchronously updating the scroll position CSS variable
206+
// allows us to avoid some jumpy behavior that would occur on wheel otherwise.
207+
this._inputField.addEventListener('wheel', (e) => {
208+
e.preventDefault();
209+
this._inputField.scrollTop += e.deltaY;
210+
this.__scrollPositionUpdated();
211+
});
212+
200213
this._updateHeight();
214+
this.__scrollPositionUpdated();
215+
}
216+
217+
/**
218+
* @protected
219+
* @override
220+
*/
221+
_onResize() {
222+
this.__scrollPositionUpdated();
201223
}
202224

203225
/** @protected */
@@ -216,6 +238,12 @@ export class TextArea extends PatternMixin(InputFieldMixin(ThemableMixin(Element
216238
this.addEventListener('animationend', this._onAnimationEnd);
217239
}
218240

241+
/** @private */
242+
__scrollPositionUpdated() {
243+
this._inputField.style.setProperty('--_text-area-vertical-scroll-position', '0px');
244+
this._inputField.style.setProperty('--_text-area-vertical-scroll-position', this._inputField.scrollTop + 'px');
245+
}
246+
219247
/** @private */
220248
_onAnimationEnd(e) {
221249
if (e.animationName.indexOf('vaadin-text-area-appear') === 0) {

‎packages/text-area/test/dom/__snapshots__/text-area.test.snap.js‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ snapshots["vaadin-text-area shadow default"] =
1212
>
1313
</span>
1414
</div>
15-
<vaadin-input-container part="input-field">
15+
<vaadin-input-container
16+
part="input-field"
17+
style="--_text-area-vertical-scroll-position:0px;"
18+
>
1619
<slot
1720
name="prefix"
1821
slot="prefix"
@@ -58,6 +61,7 @@ snapshots["vaadin-text-area shadow disabled"] =
5861
<vaadin-input-container
5962
disabled=""
6063
part="input-field"
64+
style="--_text-area-vertical-scroll-position:0px;"
6165
>
6266
<slot
6367
name="prefix"
@@ -104,6 +108,7 @@ snapshots["vaadin-text-area shadow readonly"] =
104108
<vaadin-input-container
105109
part="input-field"
106110
readonly=""
111+
style="--_text-area-vertical-scroll-position:0px;"
107112
>
108113
<slot
109114
name="prefix"
@@ -150,6 +155,7 @@ snapshots["vaadin-text-area shadow invalid"] =
150155
<vaadin-input-container
151156
invalid=""
152157
part="input-field"
158+
style="--_text-area-vertical-scroll-position:0px;"
153159
>
154160
<slot
155161
name="prefix"
@@ -195,6 +201,7 @@ snapshots["vaadin-text-area shadow theme"] =
195201
</div>
196202
<vaadin-input-container
197203
part="input-field"
204+
style="--_text-area-vertical-scroll-position:0px;"
198205
theme="align-right"
199206
>
200207
<slot

‎packages/text-area/test/text-area.test.js‎

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { expect } from '@esm-bundle/chai';
2-
import { fixtureSync, oneEvent } from '@vaadin/testing-helpers';
2+
import { fixtureSync, nextFrame, oneEvent } from '@vaadin/testing-helpers';
33
import sinon from 'sinon';
44
import '../src/vaadin-text-area.js';
55

@@ -340,6 +340,60 @@ describe('text-area', () => {
340340
)
341341
);
342342
});
343+
344+
describe('--_text-area-vertical-scroll-position CSS variable', () => {
345+
function wheel({ element = inputField, deltaY = 0 }) {
346+
const e = new CustomEvent('wheel', { bubbles: true, cancelable: true });
347+
e.deltaY = deltaY;
348+
e.deltaX = 0;
349+
element.dispatchEvent(e);
350+
return e;
351+
}
352+
353+
function getVerticalScrollPosition() {
354+
return textArea.shadowRoot
355+
.querySelector('[part="input-field"]')
356+
.style.getPropertyValue('--_text-area-vertical-scroll-position');
357+
}
358+
359+
beforeEach(() => {
360+
textArea.style.height = '100px';
361+
textArea.value = 'a\nb\nc\nd\ne\nf\ng\nh\ni\nj\nk\nl\nm\nn\no\np\nq\nr\ns\nt\nu\nv\nw\nx\ny\nz';
362+
});
363+
364+
it('should be 0 initially', () => {
365+
expect(getVerticalScrollPosition()).to.equal('0px');
366+
});
367+
368+
it('should update value on scroll', async () => {
369+
inputField.scrollTop = 10;
370+
await nextFrame();
371+
expect(getVerticalScrollPosition()).to.equal('10px');
372+
});
373+
374+
it('should update value on wheel', async () => {
375+
wheel({ deltaY: 10 });
376+
expect(getVerticalScrollPosition()).to.equal('10px');
377+
});
378+
379+
it('should scroll on wheel', async () => {
380+
wheel({ deltaY: 10 });
381+
expect(inputField.scrollTop).to.equal(10);
382+
});
383+
384+
it('should cancel wheel event', () => {
385+
const e = wheel({ deltaY: 10 });
386+
expect(e.defaultPrevented).to.be.true;
387+
});
388+
389+
it('should update value on resize', async () => {
390+
inputField.scrollTop = 10;
391+
await nextFrame();
392+
textArea.style.height = `${inputField.scrollHeight}px`;
393+
await nextFrame();
394+
expect(getVerticalScrollPosition()).to.equal('0px');
395+
});
396+
});
343397
});
344398

345399
describe('pattern', () => {
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { css, registerStyles } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
2+
3+
/* hide caret */
4+
registerStyles(
5+
'vaadin-text-area',
6+
css`
7+
::slotted(textarea) {
8+
caret-color: transparent;
9+
}
10+
`
11+
);
1.26 KB
Loading

‎packages/text-area/test/visual/lumo/text-area.test.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { fixtureSync } from '@vaadin/testing-helpers/dist/fixture.js';
22
import { visualDiff } from '@web/test-runner-visual-regression';
3+
import '../common.js';
34
import '../../../theme/lumo/vaadin-text-area.js';
45

56
describe('text-area', () => {
@@ -58,6 +59,13 @@ describe('text-area', () => {
5859
await visualDiff(div, 'invalid');
5960
});
6061

62+
it('scrolled', async () => {
63+
element.style.height = '70px';
64+
element.value = 'a\nb\nc\nd\ne';
65+
element.focus();
66+
await visualDiff(div, 'scrolled');
67+
});
68+
6169
it('error message', async () => {
6270
element.label = 'Label';
6371
element.errorMessage = 'This field is required';
946 Bytes
Loading

‎packages/text-area/test/visual/material/text-area.test.js‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { fixtureSync } from '@vaadin/testing-helpers/dist/fixture.js';
22
import { visualDiff } from '@web/test-runner-visual-regression';
3+
import '../common.js';
34
import '../../../theme/material/vaadin-text-area.js';
45

56
describe('text-area', () => {
@@ -58,6 +59,13 @@ describe('text-area', () => {
5859
await visualDiff(div, 'invalid');
5960
});
6061

62+
it('scrolled', async () => {
63+
element.style.height = '70px';
64+
element.value = 'a\nb\nc\nd\ne';
65+
element.focus();
66+
await visualDiff(div, 'scrolled');
67+
});
68+
6169
it('error message', async () => {
6270
element.label = 'Label';
6371
element.errorMessage = 'This field is required';

‎packages/text-area/theme/material/vaadin-text-area-styles.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ const textArea = css`
2121
white-space: pre-wrap; /* override "nowrap" from <vaadin-text-field> */
2222
align-self: stretch; /* override "baseline" from <vaadin-text-field> */
2323
}
24+
25+
[part='input-field']::before,
26+
[part='input-field']::after {
27+
bottom: calc(var(--_text-area-vertical-scroll-position) * -1);
28+
}
2429
`;
2530

2631
registerStyles('vaadin-text-area', [inputFieldShared, textArea], { moduleId: 'material-text-area' });

0 commit comments

Comments
 (0)