Skip to content

docs: Updated README to Have Types #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 11, 2018
Merged

docs: Updated README to Have Types #36

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f76785b
fix: Updating Readme to Have Types
smacpherson64 Jul 11, 2018
0638389
Merge branch 'master' into pr/readme-types-update
gnapse Jul 11, 2018
8fe6e38
Added typescript syntax to type code blocks
smacpherson64 Jul 11, 2018
14ab9a0
Fixing minor typos
smacpherson64 Jul 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ expect.extend({toBeInTheDOM, toHaveClass})

### `toBeInTheDOM`

```typescript
toBeInTheDOM(container?: HTMLElement)
```

This allows you to assert whether an element present in the DOM container or not. If no DOM container is specified it will use the default DOM context.

#### Using the default DOM container
Expand Down Expand Up @@ -137,6 +141,10 @@ expect(queryByTestId(container, 'ancestor')).not.toBeInTheDOM(

### `toBeEmpty`

```typescript
toBeEmpty()
```

This allows you to assert whether an element has content or not.

```javascript
Expand All @@ -152,6 +160,10 @@ expect(queryByTestId(container, 'not-empty')).not.toBeEmpty()

### `toContainElement`

```typescript
toContainElement(element: HTMLElement)
```

This allows you to assert whether an element contains another element as a descendant or not.

```javascript
Expand All @@ -170,6 +182,10 @@ expect(descendant).not.toContainElement(ancestor)

### `toHaveTextContent`

```typescript
toHaveTextContent(text: string | RegExp)
```

This API allows you to check whether the given element has a text content or not.

```javascript
Expand All @@ -185,7 +201,11 @@ expect(getByTestId(container, 'count-value')).not.toHaveTextContent('21')

### `toHaveAttribute`

This allows you to check wether the given element has an attribute or not. You
```typescript
toHaveAttribute(attr: string, value?: string)
```

This allows you to check whether the given element has an attribute or not. You
can also optionally check that the attribute has a specific expected value.

```javascript
Expand All @@ -207,7 +227,11 @@ expect(getByTestId(container, 'ok-button')).not.toHaveAttribute(

### `toHaveClass`

This allows you to check wether the given element has certain classes within its
```typescript
toHaveClass(...classNames: string[])
```

This allows you to check whether the given element has certain classes within its
`class` attribute.

```javascript
Expand All @@ -227,6 +251,10 @@ expect(getByTestId(container, 'delete-button')).not.toHaveClass('btn-link')

### `toHaveStyle`

```typescript
toHaveStyle(css: string)
```

This allows you to check if a certain element has some specific css properties
with specific values applied. It matches only if the element has _all_ the
expected properties applied, not just some of them.
Expand Down Expand Up @@ -257,6 +285,10 @@ The usual rules of css precedence apply.

### `toHaveFocus`

```typescript
toHaveFocus()
```

This allows you to assert whether an element has focus or not.

```javascript
Expand All @@ -279,6 +311,10 @@ expect(queryByTestId(container, 'focused')).not.toHaveFocus()

### `toBeVisible`

```typescript
toBeVisible()
```

This allows you to check if an element is currently visible to the user.

An element is visible if **all** the following conditions are met:
Expand Down Expand Up @@ -308,6 +344,10 @@ expect(container.querySelector('strong')).not.toBeVisible()

### `toBeDisabled`

```typescript
toBeDisabled()
```

This allows you to check whether an element is disabled from the user's perspective.

It matches if the element is a form control and the `disabled` attribute is
Expand Down