Skip to content

Commit

Permalink
Update API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
YusukeIwaki committed Dec 10, 2023
1 parent eef196e commit cd1fd99
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 103 deletions.
6 changes: 3 additions & 3 deletions development/generate_api/example_codes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ def example_de61e349d06a98a38ba9bfccc5708125cd263b7d3a31b9a837eda3db0baac288(bro
end

# BrowserContext#expose_binding
def example_a450852d36dda88564582371af8d87bb58b1a517aac4fa60b7a58a0e41c5ceff(browser_context:)
def example_ba61d7312419a50eab8b67fd47e467e3b53590e7fd2ee55055fb6d12c94a61e4(browser_context:)
browser_context.expose_binding("pageURL", ->(source) { source[:page].url })
page = browser_context.new_page

Expand Down Expand Up @@ -1447,7 +1447,7 @@ def example_fd8ed14043be0b21635ea7b0c55b59c55991a6a686904fcb82f2eee7671f9d55(pag
end

# Page#expose_binding
def example_4f7d99a72aaea957cc5678ed8728965338d78598d7772f47fbf23c28f0eba52d(page:)
def example_f32bc2194cbfc7c632c148ab34523bc5a4e3fdbdc66d7dfcf85304977a1adcbf(page:)
page.expose_binding("pageURL", ->(source) { source[:page].url })
page.content = <<~HTML
<script>
Expand All @@ -1458,7 +1458,7 @@ def example_4f7d99a72aaea957cc5678ed8728965338d78598d7772f47fbf23c28f0eba52d(pag
<button onclick="onClick()">Click me</button>
<div></div>
HTML
page.locator("button").click
page.click("button")
end

# Page#expose_binding
Expand Down
54 changes: 0 additions & 54 deletions development/unimplemented_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,57 +4,3 @@ Excample codes in API documentation is replaces with the methods defined in deve

The examples listed below is not yet implemented, and documentation shows Python code.


### example_f32bc2194cbfc7c632c148ab34523bc5a4e3fdbdc66d7dfcf85304977a1adcbf (Page#expose_binding)

```
from playwright.sync_api import sync_playwright, Playwright
def run(playwright: Playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
context = browser.new_context()
page = context.new_page()
page.expose_binding("pageURL", lambda source: source["page"].url)
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.click("button")
with sync_playwright() as playwright:
run(playwright)
```

### example_ba61d7312419a50eab8b67fd47e467e3b53590e7fd2ee55055fb6d12c94a61e4 (BrowserContext#expose_binding)

```
from playwright.sync_api import sync_playwright, Playwright
def run(playwright: Playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
context = browser.new_context()
context.expose_binding("pageURL", lambda source: source["page"].url)
page = context.new_page()
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.get_by_role("button").click()
with sync_playwright() as playwright:
run(playwright)
```
36 changes: 14 additions & 22 deletions documentation/docs/api/browser_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,29 +158,21 @@ See [Page#expose_binding](./page#expose_binding) for page-only version.

An example of exposing page URL to all frames in all pages in the context:

```python sync title=example_ba61d7312419a50eab8b67fd47e467e3b53590e7fd2ee55055fb6d12c94a61e4.py
from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
context = browser.new_context()
context.expose_binding("pageURL", lambda source: source["page"].url)
page = context.new_page()
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.get_by_role("button").click()

with sync_playwright() as playwright:
run(playwright)
```ruby
browser_context.expose_binding("pageURL", ->(source) { source[:page].url })
page = browser_context.new_page

page.content = <<~HTML
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
HTML

page.get_by_role("button").click
```

An example of passing an element handle:
Expand Down
35 changes: 12 additions & 23 deletions documentation/docs/api/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,29 +465,18 @@ See [BrowserContext#expose_binding](./browser_context#expose_binding) for the co

An example of exposing page URL to all frames in a page:

```python sync title=example_f32bc2194cbfc7c632c148ab34523bc5a4e3fdbdc66d7dfcf85304977a1adcbf.py
from playwright.sync_api import sync_playwright, Playwright

def run(playwright: Playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
context = browser.new_context()
page = context.new_page()
page.expose_binding("pageURL", lambda source: source["page"].url)
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.click("button")

with sync_playwright() as playwright:
run(playwright)

```ruby
page.expose_binding("pageURL", ->(source) { source[:page].url })
page.content = <<~HTML
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
HTML
page.click("button")
```

An example of passing an element handle:
Expand Down
2 changes: 1 addition & 1 deletion spec/integration/example_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@

it 'should work with BrowserContext#expose_binding' do
with_context do |context|
example_a450852d36dda88564582371af8d87bb58b1a517aac4fa60b7a58a0e41c5ceff(browser_context: context)
example_ba61d7312419a50eab8b67fd47e467e3b53590e7fd2ee55055fb6d12c94a61e4(browser_context: context)
example_93e847f70b01456eec429a1ebfaa6b8f5334f4c227fd73e62dd6a7facb48dbbd(browser_context: context)
example_714719de9c92e66678257180301c2512f8cd69185f53a5121b6c52194f61a871(browser_context: context)
end
Expand Down

0 comments on commit cd1fd99

Please sign in to comment.