Accessibility Inspector open-sourcing move and documentation

Summary: Replaces AXElementsInpector with normal inspector implementation, removes gating from external builds. Adds documentation to https://fbflipper.com/docs/layout-plugin.html.

Reviewed By: passy

Differential Revision: D9438713

fbshipit-source-id: 18616c6cbab339bf474d116cac128e1d4a5fc2be
This commit is contained in:
Sara Valderrama
2018-08-22 14:47:43 -07:00
committed by Facebook Github Bot
parent 9095b3a030
commit 7852a3886b
4 changed files with 20 additions and 42 deletions

View File

@@ -43,6 +43,8 @@ The Layout Inspector not only allows you to view the hierarchy and inspect each
Enable target mode by clicking on the crosshairs icon. Now, you can touch any view on the device and Layout Inspector will jump to the correct position within your layout hierarchy.
Tip: Target mode also works with Talkback running.
### Blocking fullscreen views (Android only)
The issue is that if you have some view that occupies big part of the screen but draws nothing and its Z-position is higher than your main content, then selecting view/component through Layout Inspector doesn't work as you intended, as it will always hit that transparent view and you need to manually navigate to the view you need which is time-consuming and should not be necessary.
@@ -52,3 +54,12 @@ Add the following tag to your view to skip it from Flipper's view picker. The vi
```java
view.setTag("sonar_skip_view_traversal", true);
```
## Accessibility mode (Android-only)
Enable accessibility mode by clicking on the accessibility icon. This shows the accessibility view hierarchy next to the normal hierarchy. In the hierarchy, the currently accessibility-focused view is highlighted in green and any accessibility-focusable elements have a green icon next to their name. The hierarchy's context menu also allows you to focus accessibility services on certain elements. When selecting an element in one hierarchy, the corresponding element in the other will also be highlighted. The hierarchies expand and collapse in sync, and searching through the main hierarchy works in accessibility mode as well.
When accessibility mode is enabled, the sidebar will show special properties that are used by accessibility services to determine their functionality. This includes things like content-description, clickable, focusable, and long-clickable among others.
### Talkback
The accessibility mode sidebar also includes a panel with properties derived specifically to show Talkback's interpretation of a view (with logic ported over from Google's Talkback source). While generally accurate, this is not guaranteed to be accurate for all situations. It is always better to turn Talkback on for verification.

View File

@@ -1,34 +0,0 @@
/**
* Copyright 2018-present Facebook.
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
* @format
*/
import {Component} from 'react';
import type {
Element,
ElementID,
ElementSearchResultSet,
ContextMenuExtension,
} from 'sonar';
export class AXElementsInspector extends Component<{
onElementExpanded: (key: ElementID, deep: boolean) => void,
onElementSelected: (key: ElementID) => void,
onElementHovered: ?(key: ?ElementID) => void,
onValueChanged: ?(path: Array<string>, val: any) => void,
selected: ?ElementID,
focused: ?ElementID,
searchResults?: ?ElementSearchResultSet,
root: ?ElementID,
elements: {[key: ElementID]: Element},
useAppSidebar?: boolean,
contextMenuExtensions: Array<ContextMenuExtension>,
}> {
render() {
return null;
}
}
export const AXToggleButtonEnabled: boolean = false;

View File

@@ -28,11 +28,6 @@ import {
import type {TrackType} from '../../fb-stubs/Logger.js';
import SidebarExtensions from '../../fb-stubs/LayoutInspectorSidebarExtensions.js';
import {
AXElementsInspector,
AXToggleButtonEnabled,
} from '../../fb-stubs/AXLayoutExtender.js';
// $FlowFixMe
import debounce from 'lodash.debounce';
@@ -468,7 +463,7 @@ export default class Layout extends SonarPlugin<InspectorState> {
axEnabled(): boolean {
// only visible internally for Android clients
return AXToggleButtonEnabled && this.realClient.query.os === 'Android';
return this.realClient.query.os === 'Android';
}
// expand tree and highlight click-to-inspect node that was found
@@ -1083,14 +1078,13 @@ export default class Layout extends SonarPlugin<InspectorState> {
)}
{AXinitialised && inAXMode ? <VerticalRule /> : null}
{AXinitialised && inAXMode ? (
<AXElementsInspector
<ElementsInspector
onElementSelected={this.onElementSelected}
onElementHovered={this.onElementHovered}
onElementExpanded={this.onElementExpanded}
onValueChanged={this.onDataValueChanged}
selected={AXselected}
focused={AXfocused}
searchResults={null}
root={AXroot}
elements={AXelements}
contextMenuExtensions={this.getAXContextMenuExtensions()}

View File

@@ -8,6 +8,7 @@
import {Component} from 'react';
import FlexRow from '../FlexRow.js';
import {Elements} from './elements.js';
import type {ContextMenuExtension} from 'sonar';
export type ElementID = string;
@@ -57,11 +58,13 @@ export default class ElementsInspector extends Component<{
onElementHovered: ?(key: ?ElementID) => void,
onValueChanged: ?(path: Array<string>, val: any) => void,
selected: ?ElementID,
focused?: ?ElementID,
searchResults?: ?ElementSearchResultSet,
root: ?ElementID,
elements: {[key: ElementID]: Element},
useAppSidebar?: boolean,
alternateRowColor?: boolean,
contextMenuExtensions?: Array<ContextMenuExtension>,
}> {
static defaultProps = {
alternateRowColor: true,
@@ -69,6 +72,7 @@ export default class ElementsInspector extends Component<{
render() {
const {
selected,
focused,
elements,
root,
onElementExpanded,
@@ -76,6 +80,7 @@ export default class ElementsInspector extends Component<{
onElementHovered,
searchResults,
alternateRowColor,
contextMenuExtensions,
} = this.props;
return (
@@ -85,10 +90,12 @@ export default class ElementsInspector extends Component<{
onElementSelected={onElementSelected}
onElementHovered={onElementHovered}
selected={selected}
focused={focused}
searchResults={searchResults}
root={root}
elements={elements}
alternateRowColor={alternateRowColor}
contextMenuExtensions={contextMenuExtensions}
/>
</FlexRow>
);