cypress-get-by-label

Example custom Cypress command finding form element by its label

Read How to Publish Custom Cypress Command on NPM

install

npm i -D cypress-get-by-label
# or
yarn add -D cypress-get-by-label

use

Simple

Include from your Cypress support file or individual spec

import 'cypress-get-by-label/commands'

Then use the custom command cy.getByLabel

cy.getByLabel('First name:')

Dual command

The cy.getByLabel command is dual: you can use it as a parent to start new command chain or as a child command from an existing subject element.

// find the label starting
// from the beginning of the page
cy.getByLabel('First name:').should('have.value', 'Joe')
// limited to the fields inside the form with id "person"
cy.get('form#person')
  .getByLabel('First name:')
  .should('have.value', 'Ann')

Advanced

Include from your Cypress support file or individual spec

const { registerCommand } = require('cypress-get-by-label')
registerCommand()
// or we could register under a different name
registerCommand('getFormField')

Then use the command cy.getByLabel (default) or the custom name

// if used registerCommand()
cy.getByLabel('First name:')
// if used registerCommand('getFormField')
cy.getFormField('First name:')

types

To get IntelliSense working with the default custom command cy.getByLabel include in your specs

/// <reference types="cypress-get-by-label" />

For example in VSCode you will see

examples

cypress-get-by-label-example

Small print

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.