Skip to content

Commit

Permalink
perf: disable accessibility for layout views (NativeScript#10482)
Browse files Browse the repository at this point in the history
a11y is enabled by default on controls still, this just disables on layouts alone as unnecessary.
It can be enabled on a per layout view basis if needed anytime.
  • Loading branch information
farfromrefug authored Feb 10, 2024
1 parent d34a439 commit 3bd6d9b
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 13 deletions.
1 change: 1 addition & 0 deletions packages/core/accessibility/accessibility-properties.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ function makePropertyEnumConverter<T>(enumValues) {

export const accessibilityEnabledProperty = new CssProperty<Style, boolean>({
name: 'accessible',
defaultValue: true,
cssName: 'a11y-enabled',
valueConverter: booleanConverter,
});
Expand Down
2 changes: 0 additions & 2 deletions packages/core/ui/core/view-base/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { AlignSelf, FlexGrow, FlexShrink, FlexWrapBefore, Order } from '../../la
import { Page } from '../../page';
import { CoreTypes } from '../../../core-types';
import { Property, CssProperty, CssAnimationProperty, InheritedProperty, clearInheritedProperties, propagateInheritableProperties, propagateInheritableCssProperties, initNativeView } from '../properties';
import { setupAccessibleView } from '../../../accessibility';
import { CSSUtils } from '../../../css/system-classes';
import { Source } from '../../../utils/debug';
import { Binding, BindingOptions } from '../bindable';
Expand Down Expand Up @@ -599,7 +598,6 @@ export abstract class ViewBase extends Observable implements ViewBaseDefinition

return true;
});
setupAccessibleView(<any>this);

this._emit('loaded');
}
Expand Down
14 changes: 12 additions & 2 deletions packages/core/ui/core/view/index.android.ts
Original file line number Diff line number Diff line change
Expand Up @@ -820,8 +820,9 @@ export class View extends ViewCommon {

[accessibilityEnabledProperty.setNative](value: boolean): void {
this.nativeViewProtected.setFocusable(!!value);

updateAccessibilityProperties(this);
if (value) {
updateAccessibilityProperties(this);
}
}

[accessibilityIdentifierProperty.setNative](value: string): void {
Expand Down Expand Up @@ -1257,6 +1258,15 @@ export class View extends ViewCommon {

export class ContainerView extends View {
public iosOverflowSafeArea: boolean;

constructor() {
super();
/**
* mark accessible as false without triggering proerty change
* equivalent to changing the default
*/
this.style[accessibilityEnabledProperty.key] = false;
}
}

export class CustomLayoutView extends ContainerView implements CustomLayoutViewDefinition {
Expand Down
5 changes: 0 additions & 5 deletions packages/core/ui/core/view/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -228,11 +228,6 @@ export abstract class View extends ViewCommon {
*/
color: Color;

/**
* If `true` the element is an accessibility element and all the children will be treated as a single selectable component.
*/
accessible: boolean;

/**
* Hide the view and its children from the a11y service
*/
Expand Down
10 changes: 8 additions & 2 deletions packages/core/ui/core/view/index.ios.ts
Original file line number Diff line number Diff line change
Expand Up @@ -677,8 +677,9 @@ export class View extends ViewCommon implements ViewDefinition {

[accessibilityEnabledProperty.setNative](value: boolean): void {
this.nativeViewProtected.isAccessibilityElement = !!value;

updateAccessibilityProperties(this);
if (value) {
updateAccessibilityProperties(this);
}
}

[accessibilityIdentifierProperty.getDefault](): string {
Expand Down Expand Up @@ -1062,6 +1063,11 @@ export class ContainerView extends View {
constructor() {
super();
this.iosOverflowSafeArea = true;
/**
* mark accessible as false without triggering proerty change
* equivalent to changing the default
*/
this.style[accessibilityEnabledProperty.key] = false;
}
}

Expand Down
6 changes: 4 additions & 2 deletions packages/core/ui/core/view/view-common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { EventData } from '../../../data/observable';
import { Trace } from '../../../trace';
import { CoreTypes } from '../../../core-types';
import { ViewHelper } from './view-helper';
import { setupAccessibleView } from '../../../accessibility';

import { PercentLength } from '../../styling/style-properties';

Expand Down Expand Up @@ -177,6 +178,9 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {
}
}
super.onLoaded();
if (this.accessible) {
setupAccessibleView(this);
}
}

public _closeAllModalViewsInternal(): boolean {
Expand Down Expand Up @@ -810,11 +814,9 @@ export abstract class ViewCommon extends ViewBase implements ViewDefinition {

get accessible(): boolean {
return this.style.accessible;
// return this._accessible;
}
set accessible(value: boolean) {
this.style.accessible = value;
// this._accessible = value;
}

get accessibilityHidden(): boolean {
Expand Down

0 comments on commit 3bd6d9b

Please sign in to comment.