title.md

title
title

Get the document.title property of the page that is currently active.

Syntax

cy.title()
cy.title(options)

Usage

{% fa fa-check-circle green %} Correct Usage

cy.title()    // Yields the documents title as a string

Arguments

{% fa fa-angle-right %} options (Object)

Pass in an options object to change the default behavior of cy.title().

Option	Default	Description
log	true	{% usage_options log %}
timeout	{% url defaultCommandTimeout configuration#Timeouts %}	{% usage_options timeout cy.title %}

Yields {% helper_icon yields %}

{% yields sets_subject cy.title 'yields the document.title property of the current page' %}

Examples

No Args

Assert that the document's title is "My Awesome Application"

cy.title().should('eq', 'My Awesome Application')

Rules

Requirements {% helper_icon requirements %}

{% requirements parent cy.title %}

Assertions {% helper_icon assertions %}

{% assertions retry cy.title %}

Timeouts {% helper_icon timeout %}

{% timeouts assertions cy.title %}

Command Log

Assert that the document's title includes 'New User'

cy.title().should('include', 'New User')

The commands above will display in the Command Log as:

{% imgTag /img/api/title/test-title-of-website-or-webapp.png "Command Log title" %}

When clicking on title within the command log, the console outputs the following:

{% imgTag /img/api/title/see-the-string-yielded-in-the-console.png "Console Log title" %}

{% history %} {% url "< 0.3.3" changelog#0-3-3 %} | cy.title() command added {% endhistory %}

See also

• {% url cy.document() document %}