@ux-aspects/ux-aspects
Version:
Open source user interface framework for building modern, responsive, mobile big data applications
90 lines • 12.3 kB
JavaScript
import { BehaviorSubject, Subject } from 'rxjs';
import { takeUntil } from 'rxjs/operators';
export class FocusIndicator {
/** Apply a class when the item is focused */
set isFocused(isFocused) {
// update the class on the element
isFocused
? this._renderer.addClass(this._element, 'ux-focus-indicator-active')
: this._renderer.removeClass(this._element, 'ux-focus-indicator-active');
// emit the focus state
this.isFocused$.next(isFocused);
}
/** Provide a convenience getter to allow access to focus state without a subscription */
get isFocused() {
return this.isFocused$.value;
}
constructor(_element, _focusMonitor, _renderer, _options, _focusIndicatorOrigin) {
this._element = _element;
this._focusMonitor = _focusMonitor;
this._renderer = _renderer;
this._options = _options;
this._focusIndicatorOrigin = _focusIndicatorOrigin;
/** An observable to monitor the focus state */
this.isFocused$ = new BehaviorSubject(false);
/** An observable to monitor the focus origin */
this.origin$ = new Subject();
/** Remove all subscriptions on destroy */
this._onDestroy = new Subject();
// check if the element is already being monitored
if (!_element.classList.contains('ux-focus-indicator')) {
this.initialise();
}
}
/** Setup the focus monitoring */
initialise() {
// add a class to the element to specify we are controlling the focus
this._renderer.addClass(this._element, 'ux-focus-indicator');
// watch for any changes to the focus state
this._focusMonitor
.monitor(this._element, this._options.checkChildren)
.pipe(takeUntil(this._onDestroy))
.subscribe(this.onFocusChange.bind(this));
}
/** Focus the element with a specific origin */
focus(origin, options) {
this._focusIndicatorOrigin.setOrigin(origin);
this._element.focus(options);
}
/** Tear down the subscriptions */
destroy() {
this._onDestroy.next();
this._onDestroy.complete();
this.isFocused$.complete();
this._focusMonitor.stopMonitoring(this._element);
}
/** Allow the options to be updates */
setOptions(options) {
this._options = { ...this._options, ...options };
}
/** Monitor changes to an elements focus state */
onFocusChange(origin) {
// if the origin is null then we blurred
if (origin === null) {
this.isFocused = false;
this.origin$.next(null);
return;
}
// get the origin if there is one
const syntheticOrigin = this._focusIndicatorOrigin.getOrigin();
// emit the origin
this.origin$.next(syntheticOrigin || origin);
switch (syntheticOrigin || origin) {
case 'mouse':
this.isFocused = this._options.mouseFocusIndicator;
break;
case 'touch':
this.isFocused = this._options.touchFocusIndicator;
break;
case 'keyboard':
this.isFocused = this._options.keyboardFocusIndicator;
break;
case 'program':
this.isFocused = this._options.programmaticFocusIndicator;
break;
default:
this.isFocused = false;
}
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"focus-indicator.js","sourceRoot":"","sources":["../../../../../../src/directives/accessibility/focus-indicator/focus-indicator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAI3C,MAAM,OAAO,cAAc;IACzB,6CAA6C;IAC7C,IAAI,SAAS,CAAC,SAAkB;QAC9B,kCAAkC;QAClC,SAAS;YACP,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,2BAA2B,CAAC;YACrE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QAE3E,uBAAuB;QACvB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED,yFAAyF;IACzF,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;IAC/B,CAAC;IAWD,YACmB,QAAqB,EACrB,aAA2B,EAC3B,SAAoB,EAC7B,QAA+B,EACtB,qBAAkD;QAJlD,aAAQ,GAAR,QAAQ,CAAa;QACrB,kBAAa,GAAb,aAAa,CAAc;QAC3B,cAAS,GAAT,SAAS,CAAW;QAC7B,aAAQ,GAAR,QAAQ,CAAuB;QACtB,0BAAqB,GAArB,qBAAqB,CAA6B;QAdrE,+CAA+C;QACtC,eAAU,GAAG,IAAI,eAAe,CAAU,KAAK,CAAC,CAAC;QAE1D,gDAAgD;QACvC,YAAO,GAAG,IAAI,OAAO,EAAe,CAAC;QAE9C,0CAA0C;QACzB,eAAU,GAAG,IAAI,OAAO,EAAQ,CAAC;QAShD,kDAAkD;QAClD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;IAED,iCAAiC;IACzB,UAAU;QAChB,qEAAqE;QACrE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QAE7D,2CAA2C;QAC3C,IAAI,CAAC,aAAa;aACf,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;aACnD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAChC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,MAAoB,EAAE,OAAqC;QAC/D,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,kCAAkC;IAClC,OAAO;QACL,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC3B,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC3B,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,sCAAsC;IACtC,UAAU,CAAC,OAA8B;QACvC,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IACnD,CAAC;IAED,iDAAiD;IACzC,aAAa,CAAC,MAAmB;QACvC,wCAAwC;QACxC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,OAAO;QACT,CAAC;QAED,iCAAiC;QACjC,MAAM,eAAe,GAAG,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE,CAAC;QAE/D,kBAAkB;QAClB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,IAAI,MAAM,CAAC,CAAC;QAE7C,QAAQ,eAAe,IAAI,MAAM,EAAE,CAAC;YAClC,KAAK,OAAO;gBACV,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;gBACnD,MAAM;YAER,KAAK,OAAO;gBACV,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;gBACnD,MAAM;YAER,KAAK,UAAU;gBACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC;gBACtD,MAAM;YAER,KAAK,SAAS;gBACZ,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,0BAA0B,CAAC;gBAC1D,MAAM;YAER;gBACE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QAC3B,CAAC;IACH,CAAC;CACF","sourcesContent":["import { FocusMonitor, FocusOrigin } from '@angular/cdk/a11y';\nimport { Renderer2 } from '@angular/core';\nimport { BehaviorSubject, Subject } from 'rxjs';\nimport { takeUntil } from 'rxjs/operators';\nimport { FocusIndicatorOptions } from './focus-indicator-options.interface';\nimport { FocusIndicatorOriginService } from './focus-indicator-origin/focus-indicator-origin.service';\n\nexport class FocusIndicator {\n  /** Apply a class when the item is focused */\n  set isFocused(isFocused: boolean) {\n    // update the class on the element\n    isFocused\n      ? this._renderer.addClass(this._element, 'ux-focus-indicator-active')\n      : this._renderer.removeClass(this._element, 'ux-focus-indicator-active');\n\n    // emit the focus state\n    this.isFocused$.next(isFocused);\n  }\n\n  /** Provide a convenience getter to allow access to focus state without a subscription */\n  get isFocused(): boolean {\n    return this.isFocused$.value;\n  }\n\n  /** An observable to monitor the focus state */\n  readonly isFocused$ = new BehaviorSubject<boolean>(false);\n\n  /** An observable to monitor the focus origin */\n  readonly origin$ = new Subject<FocusOrigin>();\n\n  /** Remove all subscriptions on destroy */\n  private readonly _onDestroy = new Subject<void>();\n\n  constructor(\n    private readonly _element: HTMLElement,\n    private readonly _focusMonitor: FocusMonitor,\n    private readonly _renderer: Renderer2,\n    private _options: FocusIndicatorOptions,\n    private readonly _focusIndicatorOrigin: FocusIndicatorOriginService\n  ) {\n    // check if the element is already being monitored\n    if (!_element.classList.contains('ux-focus-indicator')) {\n      this.initialise();\n    }\n  }\n\n  /** Setup the focus monitoring */\n  private initialise(): void {\n    // add a class to the element to specify we are controlling the focus\n    this._renderer.addClass(this._element, 'ux-focus-indicator');\n\n    // watch for any changes to the focus state\n    this._focusMonitor\n      .monitor(this._element, this._options.checkChildren)\n      .pipe(takeUntil(this._onDestroy))\n      .subscribe(this.onFocusChange.bind(this));\n  }\n\n  /** Focus the element with a specific origin */\n  focus(origin?: FocusOrigin, options?: { preventScroll?: boolean }): void {\n    this._focusIndicatorOrigin.setOrigin(origin);\n    this._element.focus(options);\n  }\n\n  /** Tear down the subscriptions */\n  destroy(): void {\n    this._onDestroy.next();\n    this._onDestroy.complete();\n    this.isFocused$.complete();\n    this._focusMonitor.stopMonitoring(this._element);\n  }\n\n  /** Allow the options to be updates */\n  setOptions(options: FocusIndicatorOptions): void {\n    this._options = { ...this._options, ...options };\n  }\n\n  /** Monitor changes to an elements focus state */\n  private onFocusChange(origin: FocusOrigin): void {\n    // if the origin is null then we blurred\n    if (origin === null) {\n      this.isFocused = false;\n      this.origin$.next(null);\n      return;\n    }\n\n    // get the origin if there is one\n    const syntheticOrigin = this._focusIndicatorOrigin.getOrigin();\n\n    // emit the origin\n    this.origin$.next(syntheticOrigin || origin);\n\n    switch (syntheticOrigin || origin) {\n      case 'mouse':\n        this.isFocused = this._options.mouseFocusIndicator;\n        break;\n\n      case 'touch':\n        this.isFocused = this._options.touchFocusIndicator;\n        break;\n\n      case 'keyboard':\n        this.isFocused = this._options.keyboardFocusIndicator;\n        break;\n\n      case 'program':\n        this.isFocused = this._options.programmaticFocusIndicator;\n        break;\n\n      default:\n        this.isFocused = false;\n    }\n  }\n}\n"]}