Skip to content

feat: add documentation for customActions #2690

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.

Sign up for GitHub

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

Jump to bottom
Merged
mykola-mokhnach merged 3 commits into from
Dec 30, 2025
Merged

feat: add documentation for customActions #2690

mykola-mokhnach merged 3 commits into from
Dec 30, 2025
+3 −1

Conversation

@ihor-kravchenko-evinced
Copy link
Contributor

@ihor-kravchenko-evinced ihor-kravchenko-evinced commented Dec 29, 2025

This PR introduces documentation of support for a new includeCustomActionsInPageSource setting and customActions attribute added in appium/WebDriverAgent#1095.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 29, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@ihor-kravchenko-evinced ihor-kravchenko-evinced force-pushed the feat/add-custom-actions-to-page-source branch from f8a6114 to 8e53d23 Compare December 29, 2025 11:15
@ihor-kravchenko-evinced ihor-kravchenko-evinced marked this pull request as ready for review December 29, 2025 12:50
@ihor-kravchenko-evinced ihor-kravchenko-evinced mentioned this pull request Dec 29, 2025
Merged
KazuCocoa
KazuCocoa approved these changes Dec 30, 2025
View reviewed changes
Copy link
Member

@KazuCocoa KazuCocoa left a comment

Choose a reason for hiding this comment

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

Could you update https://github.com/appium/appium-xcuitest-driver/blob/master/package.json#L89 to require 11.1.0+ (explicitly) as well?

mykola-mokhnach
mykola-mokhnach reviewed Dec 30, 2025
View reviewed changes
docs/reference/element-attributes.md Outdated
|`traits` | Element's [traits](https://developer.apple.com/documentation/uikit/uiaccessibilitytraits?language=objc) value. This attribute returns a comma-separated string of accessibility traits. This attribute is not included into the XML page source, it may only be retrieved via [getAttribute](https://www.w3.org/TR/webdriver2/#get-element-attribute) API.| `Button, Adjustable`, `Button` |
| `minValue` | Element's minimum allowed value, typically for controls like sliders or progress indicators. | `0`, `0.0`, `1` |
| `maxValue` | Element's maximum allowed value, typically for controls like sliders or progress indicators. | `100`, `1.0` |
| `customActions` | Custom actions attached to a single accessibility element. | `Action 1,Action 2` |
Copy link
Contributor

@mykola-mokhnach mykola-mokhnach Dec 30, 2025

Choose a reason for hiding this comment

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

would it be possible to also link some official Apple documentation that describes how custom actions could be set on an UI element?

Copy link
Contributor Author

@ihor-kravchenko-evinced ihor-kravchenko-evinced Dec 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@mykola-mokhnach Added links to Apple documentation that describe how to assign custom actions in SwiftUI and UIKit 1d4a40d.

@mykola-mokhnach
Copy link
Contributor

mykola-mokhnach commented Dec 30, 2025

Please also bump the minimum appium-webdriveragent version in package.json

@ihor-kravchenko-evinced ihor-kravchenko-evinced force-pushed the feat/add-custom-actions-to-page-source branch from f6de0a9 to 6908309 Compare December 30, 2025 13:01
@ihor-kravchenko-evinced
Copy link
Contributor Author

ihor-kravchenko-evinced commented Dec 30, 2025

Could you update https://github.com/appium/appium-xcuitest-driver/blob/master/package.json#L89 to require 11.1.0+ (explicitly) as well?

@KazuCocoa Updated it 6908309.

@ihor-kravchenko-evinced
Copy link
Contributor Author

ihor-kravchenko-evinced commented Dec 30, 2025

Please also bump the minimum appium-webdriveragent version in package.json

@mykola-mokhnach Bumped appium-webdriveragent version to 11.1.0 6908309

@mykola-mokhnach mykola-mokhnach merged commit c8a0473 into appium:master Dec 30, 2025
16 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 30, 2025
@semantic-release-bot
chore(release): 10.14.0 [skip ci]
b52e8da 
## [10.14.0](v10.13.4...v10.14.0) (2025-12-30)

### Features

* add documentation for customActions ([#2690](#2690)) ([c8a0473](c8a0473))
@github-actions
Copy link
Contributor

github-actions bot commented Dec 30, 2025

🎉 This PR is included in version 10.14.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@KazuCocoa KazuCocoa added the size:XS contribution size: XS label Jan 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@KazuCocoa KazuCocoa KazuCocoa approved these changes

@mykola-mokhnach mykola-mokhnach mykola-mokhnach approved these changes

Assignees

No one assigned

Labels

released size:XS contribution size: XS

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ihor-kravchenko-evinced @mykola-mokhnach @KazuCocoa