Wrote documentation for 6 element endpoints #9281
Conversation
* /active * /elements * /element * /value * /submit * /text
| short_description: Gets the active element of the current session | ||
| description: | ||
| > | ||
| Get the element on the page that currently has focus. The element will be returned as a MobileElement JSON object. |
There was a problem hiding this comment.
i'm not sure MobileElement is a thing. i think it's just a term the java client uses? just the first sentence of this is probably fine.
| csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO | ||
|
|
||
| # Driver support by platform | ||
| driver_support: |
There was a problem hiding this comment.
this is actually supported on all these platforms? i'm kind of surprised
| > | ||
| Located element will be returned as a MobileElement JSON object. | ||
|
|
||
| The locator strategy returns the first element it finds. #TODO: Let's make a document with the locator strategies that this links to |
There was a problem hiding this comment.
we talk about locator strategies in the new getting started doc, could link to that?
There was a problem hiding this comment.
we could also put the list of standard locator strategies here, and mention that drivers may support additional strategies?
There was a problem hiding this comment.
or if this is the one-stop shop for all drivers, we should list them in a table here I guess
There was a problem hiding this comment.
Yeah I think we should have a full table listing all of the strategies and a description for them and the support levels.
| @@ -0,0 +1,84 @@ | |||
| --- | |||
| name: Find Element | |||
| short_description: Click on an element | |||
There was a problem hiding this comment.
this does not click on an element
| short_description: Search for multiple elements | ||
| description: | ||
| > | ||
| The located elements will be returned as a list of MobileElement JSON objects. #TODO: Let's make a document with the locator strategies that this links to |
There was a problem hiding this comment.
maybe we should reference the find element doc
| csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link | ||
|
|
||
| # Driver support by platform | ||
| driver_support: |
There was a problem hiding this comment.
i don't think this is supported unless you're in a webview context
| - name: session_id | ||
| description: ID of the session to route the command to | ||
| - name: element_id | ||
| description: ID of the element to route the command to |
There was a problem hiding this comment.
i wouldn't say this command is being routed to an element. i'd just say it's the id of the element whose text we want.
| @@ -0,0 +1,111 @@ | |||
| # Find Element | |||
There was a problem hiding this comment.
why do we have both element.md and find-element.md? likewise with the multiple variant
There was a problem hiding this comment.
That was a leftover artifact. The generation wasn't cleaning the folder. I'll add a rimraf to that.
docs/toc.js
Outdated
| ["Click", "click.md"] | ||
| ["Click", "click.md"], | ||
| ["Active Element", "active.md"], | ||
| ["Find Element", "find-element.md"], |
There was a problem hiding this comment.
I would put the finds at the very top
There was a problem hiding this comment.
Yeah I think I'll add subcategories to elements as well. There's too many for one menu.
| @@ -0,0 +1,70 @@ | |||
| --- | |||
| name: Active Element | |||
There was a problem hiding this comment.
"Active Element" doesn't sound like a command to me. maybe "Get Active Element"? or "Find Active Element"?
| driver.setValue("~SomeAccessibilityId"); | ||
| ruby: | ||
| | | ||
| @driver.find_element(:accessibility_id, "SomeAccessibilityID").send_keys("Hello World!"") |
There was a problem hiding this comment.
I think there's an extra " in "Hello World!""
* /active * /elements * /element * /value * /submit * /text
* /active * /elements * /element * /value * /submit * /text
Documented the following element endpoints