wix-style-react/src/TextLink/README.TESTKIT.md

wix-style-react

# TextLink Testkits

> TextLink

## TextLink TestKit API

| method | arguments | returned value | description |
|--------|-----------|----------------|-------------|
| getContent | - | string | returns the TextLink content |
| getSize | - | string | can be 'small' or 'medium' |
| isDarkBackground | - | boolean | returns true if the theme is dark |
| isGreyScale | - | boolean | returns true if the theme is greyscale |
| isLightBackground | - | boolean | returns true if the theme is light |
| getTheme | - | string | returns theme type, could be one of 'normal', 'darkBackground', 'greyScale |
| isUnderline | - | boolean | returns true if the TextLink have underline |
| hover | - | - | hover the TextLink |
| getLink | - | - | get the TextLink a tag href attribute |
| getTarget | - | - | get the TextLink a tag target attribute |
| getRel | - | - | get the TextLink a tag rel attribute |
| exists | - | bool | fulfilled if element in the DOM |
| click | - | - | clicks on the text link |

## Protractor TestKit API

| method | arguments | returned value | description |
|--------|-----------|----------------|-------------|
| element | - | element | Returns the element |
| getText | - | string | Returns the element's text content |
| hover | - | - | Hover the element with the mouse |
| isPrefixIconExists | - | boolean | Returns `true` if a prefix icon exists |
| isSuffixIconExists | - | boolean | Returns `true` if a suffix icon exists |

## Usage Example

> Unit testing example

```javascript
  import React from 'react';
  import {textLinkTestkitFactory} from 'wix-style-react/dist/testkit';
  import {textLinkTestkitFactory as enzymeTextLinkTestkitFactory} from 'wix-style-react/dist/testkit/enzyme';

  /***************
   enzyme example
  ***************/

  const dataHook = 'myDataHook';
  const wrapper = mount(<div/><TextLink dataHook={dataHook}/></div>);
  const testkit = enzymeTextLinkTestkitFactory({wrapper, dataHook});

  //Do tests
  expect(testkit.exists()).toBeTruthy();

  /**********************
   ReactTestUtils example
  **********************/

  const div = document.createElement('div');
  const dataHook = 'myDataHook';
  const wrapper = div.appendChild(
    ReactTestUtils.renderIntoDocument(<div/><TextLink dataHook={dataHook}/></div>, {dataHook})
  );
  const testkit = textLinkTestkitFactory({wrapper, dataHook});

  //Do tests
  expect(testkit.exists()).toBeTruthy();
```