Skip to content

Commit 1a0def9

Browse files
authored
docs(in-context): add info about the screenshot_visible_area_only option (#659)
1 parent ada8be9 commit 1a0def9

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/content/docs/developer/capabilities/in-context.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,14 @@ _jipt.push(['tag_only_visible_phrases', true]);
196196

197197
When set to `true`, this parameter ensures the screenshot tagging feature only processes strings currently visible in the user's viewport. This is ideal for dynamic interfaces, like single-page applications that use modals or dialogs that cover other on-page content. Enabling this option prevents hidden strings from being tagged, resulting in cleaner screenshots and more accurate context for translators. Acceptable values: `true`, `false`.
198198

199+
### Capture Visible Area Only
200+
201+
```js
202+
_jipt.push(['screenshot_visible_area_only', true]);
203+
```
204+
205+
When set to `true`, In-Context captures only the part of the page currently visible in the user's viewport instead of taking a full-page screenshot. This is useful for long pages or dynamic interfaces where you want the screenshot to reflect exactly what translators see on screen. Acceptable values: `true`, `false`.
206+
199207
## Optional Functions
200208

201209
You can call various functions on the global `window.jipt` object to manage or customize In-Context in real time.

0 commit comments

Comments
 (0)