Skip to navigation

Crop by element (detailed)

Crop the screenshot to a specific element.

Referenced In

Fields

FieldTypeDescriptionDefault
elementTextstringOptional. Display text of the element to screenshot.—
selectorstringOptional. Selector of the element to screenshot.—
elementIdstringOptional. ID attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.—
elementTestIdstringOptional. data-testid attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax.—
elementClassone of:
- string
- array of string
Optional. Class or array of classes that the element must have. Each class supports exact match or regex pattern using /pattern/ syntax. Element must have all specified classes.—
elementAttributeobjectOptional. Object of attribute key-value pairs that the element must have. Values can be strings (supporting /pattern/ regex), numbers, or booleans. Boolean true matches attribute presence, false matches absence.—
elementAriastringOptional. Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax.—
paddingone of:
- number
- object(Padding (detailed))
Optional. No description provided.—

Examples

{
"elementText": "example",
"selector": "example",
"elementId": "example",
"elementTestId": "example",
"elementClass": "example",
"elementAttribute": {},
"elementAria": "example",
"padding": 42
}