Skip to content

Commit dbce8b6

Browse files
committed
docs(visible): Add docs for visible() method
1 parent c007c27 commit dbce8b6

File tree

4 files changed

+49
-0
lines changed

4 files changed

+49
-0
lines changed

docs/en/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
* [text](api/wrapper/text.md)
5353
* [trigger](api/wrapper/trigger.md)
5454
* [update](api/wrapper/update.md)
55+
* [visible](api/wrapper/visible.md)
5556
* [WrapperArray](api/wrapper-array/README.md)
5657
* [at](api/wrapper-array/at.md)
5758
* [contains](api/wrapper-array/contains.md)
@@ -67,6 +68,7 @@
6768
* [setProps](api/wrapper-array/setProps.md)
6869
* [trigger](api/wrapper-array/trigger.md)
6970
* [update](api/wrapper-array/update.md)
71+
* [visible](api/wrapper-array/visible.md)
7072
* [components](api/components/README.md)
7173
* [TransitionStub](api/components/TransitionStub.md)
7274
* [TransitionGroupStub](api/components/TransitionGroupStub.md)

docs/en/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
* [text](api/wrapper/text.md)
4949
* [trigger](api/wrapper/trigger.md)
5050
* [update](api/wrapper/update.md)
51+
* [visible](api/wrapper/visible.md)
5152
* [WrapperArray](api/wrapper-array/README.md)
5253
* [at](api/wrapper-array/at.md)
5354
* [contains](api/wrapper-array/contains.md)
@@ -63,6 +64,7 @@
6364
* [setProps](api/wrapper-array/setProps.md)
6465
* [trigger](api/wrapper-array/trigger.md)
6566
* [update](api/wrapper-array/update.md)
67+
* [visible](api/wrapper-array/visible.md)
6668
* [components](api/components/README.md)
6769
* [TransitionStub](api/components/TransitionStub.md)
6870
* [TransitionGroupStub](api/components/TransitionGroupStub.md)

docs/en/api/wrapper-array/visible.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# visible()
2+
3+
Assert every `Wrapper` in `WrapperArray` is visible.
4+
5+
Returns false if at least one ancestor element has `display: none` or `visibility: hidden` style.
6+
7+
This can be used to assert that a component is hidden by `v-show`.
8+
9+
- **Returns:** `{boolean}`
10+
11+
- **Example:**
12+
13+
```js
14+
import { mount } from 'vue-test-utils'
15+
import { expect } from 'chai'
16+
import Foo from './Foo.vue'
17+
18+
const wrapper = mount(Foo)
19+
expect(wrapper.visible()).toBe(true)
20+
expect(wrapper.findAll('.is-not-visible').visible()).toBe(false)
21+
expect(wrapper.findAll('.is-visible').visible()).toBe(true)
22+
```

docs/en/api/wrapper/visible.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# visible()
2+
3+
Assert `Wrapper` or `WrapperArray` is visible.
4+
5+
Returns false if an ancestor element has `display: none` or `visibility: hidden` style.
6+
7+
This can be used to assert that a component is hidden by `v-show`.
8+
9+
- **Returns:** `{boolean}`
10+
11+
- **Example:**
12+
13+
```js
14+
import { mount } from 'vue-test-utils'
15+
import { expect } from 'chai'
16+
import Foo from './Foo.vue'
17+
18+
const wrapper = mount(Foo)
19+
expect(wrapper.visible()).toBe(true)
20+
expect(wrapper.find('.is-not-visible').visible()).toBe(false)
21+
expect(wrapper.findAll('div').visible()).toBe(true)
22+
expect(wrapper.findAll('.is-not-visible').visible()).toBe(false)
23+
```

0 commit comments

Comments
 (0)