We are gonna see why within command is used and also where we can use this and what it actually does.
- within command in cypress is a way to isolate the child elements from the parent or it provides a way of getting the child element from the parent element within a certain scope. In technical terms, it is used to fetch the scope of all subsequent elements within a certain element.
- Normally when a test is run with the respective elements it scans the whole web page DOM for the element from the beginning to the end to find that scope of the element. This will ultimately cause some time toll while running but If you have a certain field which needs to be covered together within is the best choice to do that.
- Within can be only chained off with the previous command. That means it can not be chained off with cy.
- It can never timeout and also will not retry when the assertions which should be asserted first fail.
- Within is useful when working with particular group of elements such as <form> or <table>
Syntax
.within(CallBackFunction) A callback function can be used or not it is up to you it is basically used as a pass function that yields the output of the first command to which it is chained.
.within(Options, CallBackFunction)Can pass in an object of cypress to change the behavior of the within command like a log. Which will display the log.
Example
For demo we will consider programsbuzz login page, url is given in cy.visit in below code.
it.only('Type Username And Password',()=>{
cy.visit("https://www.programsbuzz.com/user/login")
cy.get('form#user-login-form').within(()=>{
cy.get("input#edit-name").type('bblabla')
cy.get("input#edit-pass").type('mananana')
cy.get("input#edit-submit").click()
})
}) - So here we are looking at a basic input test where we are isolating a part of the webpage element called form here.
- This form part contains the login elements of the page which is where I need to do specific operations.
- So I isolated the form tag using within command and told cypress within that element alone to try and find these elements of username field, password field and submit button element.
- So in this way, we can easily try to isolate a part of the page and input the fields faster using within.