Skip to navigation
Schemas

annotate

Referenced In

Fields

FieldTypeDescriptionDefault
annotateobject(annotate)Required. Adds, updates, or clears annotations that stay on screen until something clears them. Unlike a screenshot’s own annotations — which live only for that capture — these are drawn into the page, so they appear in recordings and in any screenshot taken while they’re up. Annotations added here persist across steps and across navigation until an annotate step clears them, their duration elapses, or the context ends.—

Examples

{
  "annotate": {
    "add": [
      {
        "outline": "#submit-button"
      }
    ]
  }
}
{
  "annotate": {
    "add": [
      {
        "id": "step-counter",
        "badge": "#username",
        "label": "1"
      },
      {
        "id": "guide",
        "callout": "#username",
        "label": "Pick your identity provider first",
        "position": "right",
        "track": true
      }
    ]
  }
}
{
  "annotate": {
    "add": [
      {
        "id": "redact-api-keys",
        "blur": {
          "selector": ".api-key"
        },
        "all": true,
        "track": true,
        "transition": {
          "enter": "none"
        }
      }
    ]
  }
}
{
  "annotate": {
    "update": [
      {
        "id": "step-counter",
        "badge": "#metadata-url",
        "label": "2"
      }
    ]
  }
}
{
  "annotate": {
    "add": [
      {
        "outline": "#usage-meter",
        "duration": 3500,
        "transition": {
          "enter": "draw",
          "exit": "fade",
          "durationMs": 400
        }
      }
    ]
  }
}
{
  "annotate": {
    "clear": [
      "guide"
    ]
  }
}
{
  "annotate": {
    "clear": true
  }
}