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 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 816x 816x 816x 816x 816x 816x 816x 816x 816x 816x 4x 816x 2x 6958x 6958x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 2692x 1610x 1450x 160x 2692x 4x 4x 4x 2688x 70x 70x 70x 2618x 2692x 2692x 12x 12x 12x 12x 10x 8x 6x 2x 10x 10x 3828x 3828x 1754x 50x 50x 50x 50x 50x 50x 20x 30x 2x 30x 30x 50x 30x 30x 26x 26x 20x 20x 20x 4x 10938x 12x 8x 576x 576x 576x 576x 556x 576x 556x 576x 296x 576x 1080x 576x 576x 14614x 980x 980x 980x 3426x 594x 594x 594x 594x 594x 186x 186x 408x 408x 48x 580x 12x 580x 580x 580x 580x 580x 580x 580x 580x 4x 40x 32x 32x 112x 40x 40x 40x 40x 40x 40x 40x 28x 62x 62x 62x 62x 62x 62x 62x 62x 28x 28x 28x 28x 28x 34x 34x 4x 4x 1726x 1136x 1136x 1136x 1136x 1136x 1136x 1136x 3560x 3560x 28x 28x 3560x 1790x 1790x | /**
* Copyright 2019 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
import {BaseComponent} from '../../../coral-base-component';
import {BaseFormField} from '../../../coral-base-formfield';
import {DateTime} from '../../../coral-datetime';
import '../../../coral-component-textfield';
import '../../../coral-component-select';
import base from '../templates/base';
import {transform, commons, validate, i18n} from '../../../coral-utils';
import {Decorator} from '../../../coral-decorator';
// Default for display and value format
const DEFAULT_HOUR_FORMAT = 'HH';
const DEFAULT_MINUTE_FORMAT = 'mm';
const DEFAULT_TIME_FORMAT = `${DEFAULT_HOUR_FORMAT}:${DEFAULT_MINUTE_FORMAT}`;
// Used to extract the time format from a date format
const AUTHORIZED_TOKENS = '(A|a|H{1,2}|h{1,2}|k{1,2}|m{1,2})';
const TIME_REG_EXP = new RegExp(`${AUTHORIZED_TOKENS}.*${AUTHORIZED_TOKENS}|${AUTHORIZED_TOKENS}`);
const HOUR_REG_EXP = new RegExp('h{1,2}|H{1,2}|k{1,2}');
const MIN_REG_EXP = new RegExp('m{1,2}');
/**
Enumeration for {@link Clock} variants.
@typedef {Object} ClockVariantEnum
@property {String} DEFAULT
A default, gray Clock.
@property {String} QUIET
A Clock with no border or background.
*/
const variant = {
DEFAULT: 'default',
QUIET: 'quiet'
};
const CLASSNAME = '_coral-Clock';
// builds an array containing all possible variant classnames. this will be used to remove classnames when the variant
// changes
const ALL_VARIANT_CLASSES = [];
for (const variantValue in variant) {
ALL_VARIANT_CLASSES.push(`${CLASSNAME}--${variant[variantValue]}`);
}
/**
@class Coral.Clock
@classdesc A Clock component that can be used as a time selection form field. Leverages {@link momentJS} if loaded
on the page.
@htmltag coral-clock
@extends {HTMLElement}
@extends {BaseComponent}
@extends {BaseFormField}
*/
const Clock = Decorator(class extends BaseFormField(BaseComponent(HTMLElement)) {
/** @ignore */
constructor() {
super();
// Default value
this._value = '';
// Events
this._delegateEvents(commons.extend(this._events, {
'change [handle="period"]': '_onPeriodChange'
}));
// Prepare templates
this._elements = {};
this._template = base.call(this._elements, {commons, i18n});
// Pre-define labellable element
this._labellableElement = this;
// Add aria-errormessage attribute to coral-clock element
this.errorID = (this.id || commons.getUID()) + "-coral-clock-error-label";
// Prevent typing in specific characters which can be added to number inputs
const forbiddenChars = ["-", "+", "e", ",", "."];
this.addEventListener("keydown", (e) => {
if (forbiddenChars.includes(e.key)) {
e.preventDefault();
}
});
}
/**
The format used to display the selected time to the user. If the user manually types a time, this format
will be used to parse the value. 'HH:mm' is supported by default. Include momentjs to support additional format
string options see http://momentjs.com/docs/#/displaying/.
@type {String}
@default "HH:mm"
@htImlattribute displayformat
@htmlattributereflected
*/
get displayFormat() {
return this._displayFormat || DEFAULT_TIME_FORMAT;
}
set displayFormat(value) {
this._displayFormat = this._extractTimeFormat(transform.string(value).trim(), TIME_REG_EXP, DEFAULT_TIME_FORMAT);
this._reflectAttribute('displayformat', this._displayFormat);
this._syncDisplay();
}
/**
The format to use on expressing the time as a string on the <code>value</code> attribute. The value
will be sent to the server using this format. If an empty string is provided, then the default value per type
will be used. 'HH:mm' is supported by default. Include momentjs to support additional format string options
see http://momentjs.com/docs/#/displaying/.
@type {String}
@default "HH:mm"
@htmlattribute valueformat
@htmlattributereflected
*/
get valueFormat() {
return this._valueFormat || DEFAULT_TIME_FORMAT;
}
set valueFormat(value) {
const setValueFormat = (newValue) => {
this._valueFormat = this._extractTimeFormat(transform.string(newValue).trim(), TIME_REG_EXP, DEFAULT_TIME_FORMAT);
this._reflectAttribute('valueformat', this._valueFormat);
};
// Once the valueFormat is set, we make sure the value is also correct
if (!this._valueFormat && this._originalValue) {
setValueFormat(value);
this.value = this._originalValue;
} else {
setValueFormat(value);
this._elements.input.value = this.value;
}
}
/**
The current value as a Date. If the value is "" or an invalid date, <code>null</code> will be returned.
@type {Date}
@default null
*/
get valueAsDate() {
return this._value ? new Date(this._value.toDate().getTime()) : null;
}
set valueAsDate(value) {
this.value = value instanceof Date ? new DateTime.Moment(value, null, true).format(this.valueFormat) : '';
}
/**
The clock's variant. See {@link ClockVariantEnum}.
@type {String}
@default ClockVariantEnum.DEFAULT
@htmlattribute variant
@htmlattributereflected
*/
get variant() {
return this._variant || variant.DEFAULT;
}
set variant(value) {
value = transform.string(value).toLowerCase();
this._variant = validate.enumeration(variant)(value) && value || variant.DEFAULT;
this._reflectAttribute('variant', this._variant);
// passes down the variant to the underlying components
this._elements.hours.variant = this._variant;
this._elements.minutes.variant = this._variant;
this._elements.period.variant = this._variant;
// removes every existing variant
this.classList.remove(...ALL_VARIANT_CLASSES);
if (this._variant !== variant.DEFAULT) {
this.classList.add(`${CLASSNAME}--${this._variant}`);
}
}
/**
Name used to submit the data in a form.
@type {String}
@default ""
@htmlattribute name
@htmlattributereflected
*/
get name() {
return this._elements.input.name;
}
set name(value) {
this._reflectAttribute('name', value);
this._elements.input.name = value;
}
/**
Whether this field is disabled or not.
@type {Boolean}
@default false
@htmlattribute disabled
@htmlattributereflected
*/
get disabled() {
return this._disabled || false;
}
set disabled(value) {
this._disabled = transform.booleanAttr(value);
this._reflectAttribute('disabled', this._disabled);
this[this._disabled ? 'setAttribute' : 'removeAttribute']('aria-disabled', this._disabled);
this.classList.toggle('is-disabled', this._disabled);
this._elements.hours.disabled = this._disabled;
this._elements.minutes.disabled = this._disabled;
// stops the form submission
this._elements.input.disabled = this._disabled;
}
/**
Inherited from {@link BaseFormField#invalid}.
*/
get invalid() {
return super.invalid;
}
set invalid(value) {
super.invalid = value;
this._elements.hours.invalid = this._invalid;
this._elements.minutes.invalid = this._invalid;
this._elements.hours.setAttribute("aria-errormessage", this.errorID);
this._elements.minutes.setAttribute("aria-errormessage", this.errorID);
const ERROR_LABEL_ELEMENT_CLASS = "._coral-Clock .coral-Form-errorlabel";
const errorLabel = this.querySelector(ERROR_LABEL_ELEMENT_CLASS);
if (this._elements.hours.invalid || this._elements.minutes.invalid) {
errorLabel.setAttribute("id", this.errorID);
errorLabel.setAttribute("aria-live", "assertive");
errorLabel.hidden = false;
errorLabel.style.display = "table-caption";
errorLabel.style["caption-side"] = "bottom";
} else {
errorLabel.setAttribute("aria-live", "off");
errorLabel.hidden = true;
}
}
/**
Whether this field is required or not.
@type {Boolean}
@default false
@htmlattribute required
@htmlattributereflected
*/
get required() {
return this._required || false;
}
set required(value) {
this._required = transform.booleanAttr(value);
this._reflectAttribute('required', this._required);
this._elements.hours.required = this._required;
this._elements.minutes.required = this._required;
this._elements.input.required = this._required;
}
/**
Whether this field is readOnly or not. Indicating that the user cannot modify the value of the control.
@type {Boolean}
@default false
@htmlattribute readonly
@htmlattributereflected
*/
get readOnly() {
return this._readOnly || false;
}
set readOnly(value) {
this._readOnly = transform.booleanAttr(value);
this._reflectAttribute('readonly', this._readOnly);
this._elements.hours.readOnly = this._readOnly;
this._elements.minutes.readOnly = this._readOnly;
this._elements.input.readOnly = this._readOnly;
}
/**
This field's current value.
@type {String}
@default ""
@htmlattribute value
*/
get value() {
return this._getValueAsString(this._value, this.valueFormat);
}
set value(value) {
value = typeof value === 'string' ? value : '';
// This is used to change the value if valueformat is also set but afterwards
this._originalValue = value;
// we do strict conversion of the values
const time = new DateTime.Moment(value, this.valueFormat, true);
this._value = time.isValid() ? time : '';
this._elements.input.value = this.value;
this._syncValueAsText();
this._syncDisplay();
}
/**
Inherited from {@link BaseFormField#labelledBy}.
*/
get labelledBy() {
// Get current aria-labelledby attribute on the labellable element.
let labelledBy = this.getAttribute('aria-labelledby');
// If a labelledBy attribute has been defined,
if (labelledBy) {
// and strip the valueAsText element id from the end of the aria-labelledby string.
labelledBy = labelledBy.replace(this._elements.valueAsText.id, '').trim();
// If the resulting labelledBy string is empty, return null.
if (!labelledBy.length) {
labelledBy = null;
}
}
return labelledBy;
}
set labelledBy(value) {
super.labelledBy = value;
// The specified labelledBy property.
const labelledBy = this.labelledBy;
// An array of element ids to label control, the last being the valueAsText element id.
const ids = [this._elements.valueAsText.id];
// If a labelledBy property exists,
if (labelledBy) {
// prepend the labelledBy value to the ids array
ids.unshift(labelledBy);
// Set aria-labelledby attribute on the labellable element joining ids array into space-delimited list of ids.
this.setAttribute('aria-labelledby', ids.join(' '));
} else {
// labelledBy property is null, remove the aria-labelledby attribute.
this.removeAttribute('aria-labelledby');
}
}
/**
Ignore the date part and use the time part only
@private
*/
_extractTimeFormat(format, regExp, defaultFormat) {
const match = regExp.exec(format);
return match && match.length && match[0] !== '' ? match[0] : defaultFormat;
}
/**
Sync time display based on the format
@private
*/
_syncDisplay() {
const hourFormat = this._extractTimeFormat(this.displayFormat, HOUR_REG_EXP, DEFAULT_HOUR_FORMAT);
const minuteFormat = this._extractTimeFormat(this.displayFormat, MIN_REG_EXP, DEFAULT_MINUTE_FORMAT);
this._elements.hours.placeholder = hourFormat;
this._elements.minutes.placeholder = minuteFormat;
this._elements.hours.value = this._getValueAsString(this._value, hourFormat);
this._elements.minutes.value = this._getValueAsString(this._value, minuteFormat);
this._syncPeriod();
this._syncValueAsText();
}
/**
Sync period selector based on the format
@private
*/
_syncPeriod() {
const period = this._elements.period;
const time = this._value;
const am = i18n.get('am');
const pm = i18n.get('pm');
const items = period.items.getAll();
if (time && time.isValid()) {
if (time.hours() < 12) {
period.value = 'am';
} else {
period.value = 'pm';
}
}
// Check for am/pm
if (this.displayFormat.indexOf('a') !== -1) {
items[0].textContent = am;
items[1].textContent = pm;
this._togglePeriod(true);
} else if (this.displayFormat.indexOf('A') !== -1) {
items[0].textContent = am.toUpperCase();
items[1].textContent = pm.toUpperCase();
this._togglePeriod(true);
} else {
this._togglePeriod(false);
}
}
/** @private */
_togglePeriod(show) {
this.classList.toggle(`${CLASSNAME}--extended`, show);
this._elements.period.hidden = !show;
}
/** @private */
_onPeriodChange(event) {
// stops the event from leaving the component
event.stopImmediatePropagation();
const time = this._value;
const period = this._elements.period;
// we check if a change event needs to be triggered since it was produced via user interaction
if (time && time.isValid()) {
if (this.displayFormat.indexOf('h') !== -1) {
if (period.value === 'am') {
time.subtract(12, 'h');
} else {
time.add(12, 'h');
}
}
this.value = time.format(this.valueFormat);
this.trigger('change');
}
}
_syncValueAsText() {
this._elements.valueAsText.textContent = this._getValueAsString(this._value, this.displayFormat);
if (!this.getAttribute('aria-labelledby')) {
this.labelledBy = this.labelledBy;
}
}
/**
Kills the internal _onInputChange from BaseFormField because it does not check the target.
@private
*/
_onInputChange(event) {
// stops the event from leaving the component
event.stopImmediatePropagation();
let newTime = new DateTime.Moment();
const oldTime = this._value;
let hours = parseInt(this._elements.hours.value, 10);
const minutes = parseInt(this._elements.minutes.value, 10);
if (window.isNaN(hours) || window.isNaN(minutes)) {
newTime = '';
} else {
if (!this._elements.period.hidden &&
this.displayFormat.indexOf('h') !== -1 &&
this._elements.period.value === 'pm') {
hours += 12;
}
newTime.hours(hours);
newTime.minutes(minutes);
}
// we check if a change event needs to be triggered since it was produced via user interaction
if (newTime && newTime.isValid()) {
// @polyfill ie
this.invalid = false;
if (!newTime.isSame(oldTime, 'hour') || !newTime.isSame(oldTime, 'minute')) {
this.value = newTime.format(this.valueFormat);
this.trigger('change');
}
} else {
// @polyfill ie
this.invalid = true;
// does not sync the inputs so allow the user to continue typing the date
this._value = '';
if (newTime !== oldTime) {
this.trigger('change');
}
}
}
/**
Helper class that converts the internal moment value into a String using the provided date format. If the value is
invalid, empty string will be returned.
@param {?Moment} value
The value representing the date. It has to be a moment object or <code>null</code>
@param {String} format
The Date format to be used.
@returns {String} a String representing the value in the given format.
@ignore
*/
_getValueAsString(value, format) {
return value && value.isValid() ? value.format(format) : '';
}
focus() {
// Sets focus to appropriate descendant
if (!this.contains(document.activeElement)) {
this._elements.hours.focus();
}
}
/**
Returns {@link Clock} variants.
@return {ClockVariantEnum}
*/
static get variant() {
return variant;
}
static get _attributePropertyMap() {
return commons.extend(super._attributePropertyMap, {
displayformat: 'displayFormat',
valueformat: 'valueFormat'
});
}
/** @ignore */
static get observedAttributes() {
return super.observedAttributes.concat([
'displayformat',
'valueformat',
'variant'
]);
}
/** @ignore */
render() {
super.render();
this.classList.add(CLASSNAME);
// a11y
this.setAttribute('role', 'group');
// Default reflected attributes
if (!this._variant) {
this.variant = variant.DEFAULT;
}
if (!this._valueFormat) {
this.valueFormat = DEFAULT_TIME_FORMAT;
}
if (!this._displayFormat) {
this.displayFormat = DEFAULT_TIME_FORMAT;
}
// clean up to be able to clone it
while (this.firstChild) {
thIis.removeChild(this.firstChild);
}
// Render template
this.appendChild(this._template);
this._syncDisplay();
}
});
export default Clock;
|