Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | import { LightningElement, api } from 'lwc';
import {
dispatchCustomEvent,
reflectAttribute,
normalizeBoolean,
normalizeInput,
hasSlotText,
} from 'sds/utils';
import 'sds/privateThemeProvider';
export default class Textarea extends LightningElement {
static shadowSupportMode = 'native';
_ariaInvalid = false;
_cols;
_disabled = false;
_helptext;
_invalid = false;
_maxlength;
_minlength;
_name;
_placeholder;
_readonly = false;
_required = false;
_rows;
_spellcheck;
_validityMessage;
_value;
_wrap;
_helpTextElement;
_textAreaElement;
_formElement;
@api id = 'textarea-id';
@api label = 'Textarea Label';
/**
* Private getter to set the aria-invalid attribute on the textarea element
*/
get ariaInvalid() {
return this._ariaInvalid;
}
/**
* The visible width of the text control, in average character widths.
*
* @type {string}
*/
@api
get cols() {
return this._cols;
}
set cols(value) {
this._cols = normalizeInput(value);
}
/**
* Makes the element not mutable, interactable, or focusable.
*
* @type {boolean}
* @default false
*/
@api
get disabled() {
return this._disabled;
}
set disabled(value) {
this._disabled = normalizeBoolean(value);
reflectAttribute(this, 'disabled', this._disabled);
}
/**
* Returns the closest form element
* @returns {HTMLElement} - the form element
* @private
*/
get formElement() {
this._formElement = this._formElement || this.template.host.closest('form');
return this._formElement;
}
/**
* Returns the help text element, if it exists
* Used to dynamically add/remove the associated ID to the textarea element if help text is present
*
* @returns {object} help text element
* @private
*/
get helpText() {
this._helpTextElement = this._helpTextElement || this.template.querySelector('[part="help-text"]');
return this._helpTextElement;
}
/**
* Allows customer to set invalid state on textarea
* An example would be if the textarea is required and the value is empty on form submit,
* since we are not using native form validation, we need to offer the ability set the
* invalid state on the textarea
*/
@api
get invalid() {
return this._invalid;
}
set invalid(value) {
this._invalid = normalizeBoolean(value);
reflectAttribute(this, 'invalid', this._invalid);
}
/**
* Specifies the maximum number of characters allowed in the textarea.
* Will invalidate if more characters are entered.
*
* Current bug with LWC does not allow for maxlength, seems like its a reserved attribute of the compiler
*
* @type {string}
*/
@api
get maxLength() {
return this._maxlength;
}
set maxLength(value) {
this._maxlength = normalizeInput(value);
}
/**
* Specifies the minimum number of characters allowed in the textarea.
* Will invalidate if fewer characters are entered.
*
* @type {string}
*/
@api
get minLength() {
return this._minlength;
}
set minLength(value) {
this._minlength = normalizeInput(value);
}
/**
* The name of the textarea element, used on form submit.
*
* @type {string}
*/
@api
get name() {
return this._name;
}
set name(value) {
this._name = normalizeInput(value);
}
/**
* Placeholder text of the textarea element.
*
* @type {string}
*/
@api
get placeholder() {
return this._placeholder;
}
set placeholder(value) {
this._placeholder = normalizeInput(value);
}
/**
* Readonly indicates that the user cannot modify the value of the input.
*
* @type {boolean}
* @default false
*/
@api
get readOnly() {
return this._readonly;
}
set readOnly(value) {
this._readonly = normalizeBoolean(value);
reflectAttribute(this, 'readonly', this._readonly);
}
/**
* Determines if the textarea is required or not.
*
* @type {boolean}
* @default false
*/
@api
get required() {
return this._required;
}
set required(value) {
this._required = normalizeBoolean(value);
reflectAttribute(this, 'required', this._required);
}
/**
* The number of visible text lines for the control.
*
* @type {string}
*/
@api
get rows() {
return this._rows;
}
set rows(value) {
this._rows = normalizeInput(value);
}
/**
* Specifies whether the textarea is subject to spell checking by the underlying browser/OS.
*
* @type {string}
*/
@api
get spellcheck() {
return this._spellcheck;
}
set spellcheck(value) {
this._spellcheck = normalizeInput(value);
}
/**
* Returns the form's textarea element
*
* @returns {object} textarea element
* @private
*/
get textarea() {
this._textAreaElement = this._textAreaElement || this.template.querySelector('textarea');
return this._textAreaElement;
}
/**
* Returns the validity error of the input element
*/
@api
get validity() {
return Promise.resolve().then(() => this.textarea.validity);
}
/**
* Returns the validity message of the input element
*/
@api
get validityMessage() {
return this._validityMessage;
}
/**
* The value of the textarea element
*
* @type {string}
*/
@api
get value() {
return this._value;
}
set value(value) {
this._value = normalizeInput(value);
}
/**
* Indicates how the control should wrap the value for form submission.
*
* @type {string}
*/
@api
get wrap() {
return this._wrap;
}
set wrap(value) {
this._wrap = normalizeInput(value);
}
/**
* On blur event handler
* Used to remove the "active" attribute from the custom element since the user is no longer interacting with it
* Checks validity of the textarea element and sets the validity state
*
* @param {*} e - blur event
* @returns {Object} - validity state
*/
handleBlur(e) {
this._value = e.target.value;
this.removeAttribute('active');
this.removeAttribute('focus');
this.handleValidity();
this.isInvalid();
}
/**
* On click event handler
* Used to focus the textarea element when the custom element is clicked
*
* @param {Object} e - click event
*/
handleClick() {
if (!this._disabled || !this._readonly) {
this.textarea.focus();
this.setAttribute('focus', '');
}
}
/**
* Slot change event on help text slot
* Used to dynamically add/remove the associated ID to the textarea element if help text is present
* Used to dynamically add "visible" part to the help text element if help text is found in the slot
*
* @param {*} e - slot change event
*/
handleHelpTextSlotChange(e) {
let childElements = e.target.assignedElements({ flatten: true });
if (childElements.length > 0) {
if (this.helpText) {
this.helpText.id = 'id-help-text';
this.input.setAttribute('aria-describedby', 'id-help-text');
this.helpText.setAttribute('part', 'help-text visible');
}
}
}
/**
* Slot change event on the label slot
* Used to check if the label has a slotted value, if not, we throw an error that one must be included
* @param {*} e - slot change event
*/
handleLabelSlotChange(e) {
!hasSlotText(e) && console.error('A label value must be included for all form elements.');
}
/**
* On input event handler
* Used to set the "active" attribute on the custom element when the user is interacting with it
* Checks validity of the textarea element and sets the validity state via aria-invalid
*
* @param {Object} e - input event
*/
handleInput(e) {
if (!this._disabled || !this._readonly) {
this.setAttribute('active', '');
dispatchCustomEvent({
eventName: 'input',
eventOrigin: this,
eventDetails: {
name: this.tagName.toLowerCase(),
value: e.target.value,
},
});
}
}
/**
* Validates the textarea element and sets the validity state
* Sets the "invalid" attribute on the custom element if the input is invalid
* Sets the "aria-invalid" attribute on the input element if the input is invalid
*
* @private
*/
handleValidity() {
if (this.textarea.validity.valueMissing) {
this._validityMessage = 'This field is required.';
} else if (this.textarea.validity.tooShort) {
this._validityMessage =
'Please lengthen this text to ' + this.textarea.getAttribute('minlength') + ' characters or more.';
} else if (this.textarea.validity.tooLong) {
this._validityMessage =
'Please shorten this text to ' + this.textarea.getAttribute('maxlength') + ' characters or less.';
} else {
this._validityMessage = null;
}
}
/**
* If invalid, sets the aria-invalid attribute on the textarea element
* and sets invalid attribute on custom element
*
* @private
*/
isInvalid() {
if (!this.textarea.validity.valid) {
this.invalid = true;
this._ariaInvalid = 'true';
} else {
this.invalid = false;
this._ariaInvalid = 'false';
}
}
renderedCallback() {
if (this.formElement) {
this.formElement.addEventListener('submit', () => {
this.handleValidity();
this.isInvalid();
});
}
}
}
|