Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: docs for the new fields from AccessibilityNodeInfo #862

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ankahanets
Copy link

@ankahanets ankahanets changed the title Update docs for the new fields from AccessibilityNodeInfo docs: docs for the new fields from AccessibilityNodeInfo Jan 30, 2025
README.md Outdated
@@ -222,6 +222,23 @@ bounds | The element's visible frame (`[left, top][right, bottom]`) | `[0,0][100
displayed | Whether the element is visible to the user | 'true'
contentSize | The dimensions of the element's content area | `{"left": 0, "top":0, "width": 100, "height": 100, "scrollableOffset": 10, "touchPadding": 0}`
extras | The result of [getExtras](https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo#getExtras()). The value includes all key-value pairs as `key=value` separated by a semicolon (`;`). If the value is empty, then only key part ending with the equal sign will be present. | Part of extras in chrome browser:<br> `AccessibilityNodeInfo.roleDescription=;`<br>`AccessibilityNodeInfo.chromeRole=rootWebArea;`<br> `ACTION_ARGUMENT_HTML_ELEMENT_STRING_VALUES=`<br> `ARTICLE,BLOCKQUOTE,BUTTON,CHECKBOX`
a11y-important | Whether the element originates from a view considered important for accessibility | 'true'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also mention the minimum API level needed for corresponding properties to exist as well as the meaning of null values

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, user can not receive null-value because in this case the field just will be absent.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They could if they use getAttribute API rather than checking the page source.
Nevertheless it would be still useful to know why the particular field is missing from the XML output

@mykola-mokhnach
Copy link
Contributor

Please also update package.json with the minimum server version supporting mentioned attributes

Update package.json with the minimum server version supporting new properties
@ankahanets
Copy link
Author

Please also update package.json with the minimum server version supporting mentioned attributes

I've set "appium-uiautomator2-server": "^7.2.0" in package.json, is it correct?

@mykola-mokhnach
Copy link
Contributor

Please also update package.json with the minimum server version supporting mentioned attributes

I've set "appium-uiautomator2-server": "^7.2.0" in package.json, is it correct?

yes, thanks

@mykola-mokhnach mykola-mokhnach changed the title docs: docs for the new fields from AccessibilityNodeInfo chore: docs for the new fields from AccessibilityNodeInfo Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants