Skip to content

feature request: provide suggestions to auto-complete the capability name #2024

@itkhanz

Description

@itkhanz

Current Behavior

User needs to manually enter the exact name of capability in Capability Builder section which is often inconvenient if they do not remember the correct spellings or exact name of the capability so depending on the driver, they have to look for the capability in documentation e.g. for XCUITest and UIAutomator2 driver

https://appium.github.io/appium-xcuitest-driver/latest/reference/capabilities/
https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#capabilities

Suggested Solution

I would like to be shown any matching capabilities as suggestions as i enter the characters in capability field for example if I want to enter some capability for UiAutomator2 Web Context involving chrome so when I type chrome, then i should be displayed all the capabilities that have chrome in its name like

appium:chromedriverPort
appium:chromedriverPorts
appium:chromedriverArgs
appium:chromedriverExecutable
appium:chromedriverExecutableDir
appium:chromedriverChromeMappingFile
appium:chromedriverUseSystemExecutable
appium:chromedriverDisableBuildCheck
appium:recreateChromeDriverSessions
appium:extractChromeAndroidPackageFromContextName
appium:showChromedriverLog
appium:chromeOptions
appium:chromeLoggingPrefs

just like when we type some characters in a search bar and it displays the suggestions which can be selected by either clicking on the suggestion or entering TAB key.

This will definitely helpful to create an Appium Inspector session quickly without having to manually fill all the capability fields with their exact name

Additional Information

If core capabilities like platformName and automationName are already entered then solution should be smart enough to filter the capabilities only for that platform or atleast sort them to show the capabilities for that platform first

As an additional enhancement, it should auto adjust the type of capability to be text/boolean/number/JSON object, or if a user has entered incorrect type value then it should show some kind of warning about it.

A brief description of the capability when user hovers over the capability with a link to docs would be nice to have.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions