nightwatch/lib/api/web-element/commands/getRect.js

Easy to use Node.js based end-to-end testing solution for web applications using the W3C WebDriver API.

/**
 * Determine an element's size in pixels.
 *
 * For W3C Webdriver compatible clients (such as GeckoDriver), this command is equivalent to `getLocation` and both return the dimensions and coordinates of the given element:
 * - x: X axis position of the top-left corner of the element, in CSS pixels
 * - y: Y axis position of the top-left corner of the element, in CSS pixels
 * - height: Height of the element’s bounding rectangle in CSS pixels;
 * - width: Width of the web element’s bounding rectangle in CSS pixels.
 *
 * For more info on working with DOM elements in Nightwatch, refer to the <a href="https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html">Finding & interacting with DOM Elements</a> guide page.
 *
 * @example
 * export default {
 *   demoTest(browser: NightwatchAPI): void {
 *     const result = browser.element('#login').getRect();
 *     console.log('result', result);
 *   },
 *
 *   async demoTestAsync(browser: NightwatchAPI): Promise<void> {
 *     const result = await browser.element('#login').getRect();
 *     console.log('result', result);
 *   }
 * }
 *
 * @since 3.0.0
 * @method getRect
 * @memberof ScopedWebElement
 * @instance
 * @syntax browser.element(selector).getRect()
 * @link /#dfn-get-element-rect
 * @returns {ScopedValue<{ width: number, height: number }>}
 * @alias getSize
 * @alias getLocation
 */
module.exports.command = function () {
  return this.runQueuedCommandScoped('getElementRect');
};