{
  "doc": {
    "id": "api/commands/closest",
    "title": "closest | Cypress Documentation",
    "description": "Get the first DOM element that matches the selector in Cypress (whether it be itself or one of its ancestors).",
    "section": "api",
    "source_path": "/llm/markdown/api/commands/closest.md",
    "version": "e6988a974973e9090ce70406c38cb2b9e0eac9fa",
    "updated_at": "2026-05-15T15:50:22.536Z",
    "headings": [
      {
        "id": "api/commands/closest#closest",
        "text": "closest",
        "level": 1
      },
      {
        "id": "api/commands/closest#syntax",
        "text": "Syntax",
        "level": 2
      },
      {
        "id": "api/commands/closest#usage",
        "text": "Usage",
        "level": 3
      },
      {
        "id": "api/commands/closest#arguments",
        "text": "Arguments",
        "level": 3
      },
      {
        "id": "api/commands/closest#yields-learn-about-subject-management",
        "text": "Yields Learn about subject management",
        "level": 3
      },
      {
        "id": "api/commands/closest#examples",
        "text": "Examples",
        "level": 2
      },
      {
        "id": "api/commands/closest#selector",
        "text": "Selector",
        "level": 3
      },
      {
        "id": "api/commands/closest#find-the-closest-element-of-the-error-with-the-class-banner",
        "text": "Find the closest element of the .error with the class 'banner'",
        "level": 4
      },
      {
        "id": "api/commands/closest#rules",
        "text": "Rules",
        "level": 2
      },
      {
        "id": "api/commands/closest#requirements-learn-about-chaining-commands",
        "text": "Requirements Learn about chaining commands",
        "level": 3
      },
      {
        "id": "api/commands/closest#assertions-learn-about-assertions",
        "text": "Assertions Learn about assertions",
        "level": 3
      },
      {
        "id": "api/commands/closest#timeouts-learn-about-timeouts",
        "text": "Timeouts Learn about timeouts",
        "level": 3
      },
      {
        "id": "api/commands/closest#command-log",
        "text": "Command Log",
        "level": 2
      },
      {
        "id": "api/commands/closest#see-also",
        "text": "See also",
        "level": 2
      }
    ]
  },
  "chunks": [
    {
      "id": "api/commands/closest#syntax",
      "doc_id": "api/commands/closest",
      "heading": "Syntax",
      "heading_level": 2,
      "content_markdown": "## Syntax\n\n```\n.closest(selector).closest(selector, options)\n```\n\n### Usage\n\n**Correct Usage**\n\n```\ncy.get('td').closest('.filled') // Yield closest el with class '.filled'\n```\n\n**Incorrect Usage**\n\n```\ncy.closest('.active') // Errors, cannot be chained off 'cy'cy.clock().closest() // Errors, 'clock' does not yield DOM elements\n```\n\n### Arguments\n\n**selector _(String selector)_**\n\nA selector used to filter matching DOM elements.\n\n**options _(Object)_**\n\nPass in an options object to change the default behavior of `.closest()`.\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `log` | `true` | Displays the command in the [Command log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) |\n| `timeout` | [`defaultCommandTimeout`](/llm/markdown/app/references/configuration.md#Timeouts) | Time to wait for `.closest()` to resolve before [timing out](#Timeouts) |\n\n### Yields [Learn about subject management](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Subject-Management)\n\n*   `.closest()` yields the new DOM element(s) it found.\n*   `.closest()` is a query, and it is _safe_ to chain further commands.\n",
      "section": "api",
      "anchors": [
        "syntax"
      ],
      "path": "/llm/json/chunked/api/commands/closest.json",
      "token_estimate": 184
    },
    {
      "id": "api/commands/closest#usage",
      "doc_id": "api/commands/closest",
      "heading": "Usage",
      "heading_level": 3,
      "content_markdown": "### Usage\n\n**Correct Usage**\n\n```\ncy.get('td').closest('.filled') // Yield closest el with class '.filled'\n```\n\n**Incorrect Usage**\n\n```\ncy.closest('.active') // Errors, cannot be chained off 'cy'cy.clock().closest() // Errors, 'clock' does not yield DOM elements\n```\n",
      "section": "api",
      "anchors": [
        "usage"
      ],
      "path": "/llm/json/chunked/api/commands/closest.json",
      "token_estimate": 45
    },
    {
      "id": "api/commands/closest#arguments",
      "doc_id": "api/commands/closest",
      "heading": "Arguments",
      "heading_level": 3,
      "content_markdown": "### Arguments\n\n**selector _(String selector)_**\n\nA selector used to filter matching DOM elements.\n\n**options _(Object)_**\n\nPass in an options object to change the default behavior of `.closest()`.\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `log` | `true` | Displays the command in the [Command log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) |\n| `timeout` | [`defaultCommandTimeout`](/llm/markdown/app/references/configuration.md#Timeouts) | Time to wait for `.closest()` to resolve before [timing out](#Timeouts) |\n",
      "section": "api",
      "anchors": [
        "arguments"
      ],
      "path": "/llm/json/chunked/api/commands/closest.json",
      "token_estimate": 93
    },
    {
      "id": "api/commands/closest#rules",
      "doc_id": "api/commands/closest",
      "heading": "Rules",
      "heading_level": 2,
      "content_markdown": "## Rules\n\n### Requirements [Learn about chaining commands](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Chains-of-Commands)\n\n*   `.closest()` requires being chained off a command that yields DOM element(s).\n\n### Assertions [Learn about assertions](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Assertions)\n\n*   `.closest()` will automatically [retry](/llm/markdown/app/core-concepts/retry-ability.md) until the element(s) [exist in the DOM](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Implicit-Assertions).\n*   `.closest()` will automatically [retry](/llm/markdown/app/core-concepts/retry-ability.md) until all chained assertions have passed.\n\n### Timeouts [Learn about timeouts](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Timeouts)\n\n*   `.closest()` can time out waiting for the element(s) to [exist in the DOM](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Implicit-Assertions).\n*   `.closest()` can time out waiting for assertions you've added to pass.\n",
      "section": "api",
      "anchors": [
        "rules"
      ],
      "path": "/llm/json/chunked/api/commands/closest.json",
      "token_estimate": 105
    },
    {
      "id": "api/commands/closest#timeouts-learn-about-timeouts",
      "doc_id": "api/commands/closest",
      "heading": "Timeouts Learn about timeouts",
      "heading_level": 3,
      "content_markdown": "### Timeouts [Learn about timeouts](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Timeouts)\n\n*   `.closest()` can time out waiting for the element(s) to [exist in the DOM](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Implicit-Assertions).\n*   `.closest()` can time out waiting for assertions you've added to pass.\n",
      "section": "api",
      "anchors": [
        "timeouts-learn-about-timeouts"
      ],
      "path": "/llm/json/chunked/api/commands/closest.json",
      "token_estimate": 41
    },
    {
      "id": "api/commands/closest#command-log",
      "doc_id": "api/commands/closest",
      "heading": "Command Log",
      "heading_level": 2,
      "content_markdown": "## Command Log\n\n**_Find the closest element of `li.active` with the class 'nav'_**\n\n```\ncy.get('li.active').closest('.nav')\n```\n\nThe commands above will display in the Command Log as:\n\nWhen clicking on the `closest` command within the command log, the console outputs the following:\n",
      "section": "api",
      "anchors": [
        "command-log"
      ],
      "path": "/llm/json/chunked/api/commands/closest.json",
      "token_estimate": 55
    }
  ]
}