Skip to content

Commit 5458141

Browse files
38elementseddyerburgh
authored andcommitted
docs: add docs/ja/api/render.md (#490)
1 parent 312643b commit 5458141

File tree

5 files changed

+113
-4
lines changed

5 files changed

+113
-4
lines changed

docs/ja/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
* [API](api/README.md)
1717
* [mount](api/mount.md)
1818
* [shallow](api/shallow.md)
19+
* [render](api/render.md)
1920
* [renderToString](api/renderToString.md)
2021
* [マウンティングオプション](api/options.md)
2122
- [context](api/options.md#context)

docs/ja/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* [API](api/README.md)
1515
* [mount](api/mount.md)
1616
* [shallow](api/shallow.md)
17+
* [render](api/render.md)
1718
* [renderToString](api/renderToString.md)
1819
* [マウンティングオプション](api/options.md)
1920
- [context](api/options.md#context)

docs/ja/api/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
* [mount](./mount.md)
44
* [shallow](./shallow.md)
5+
* [render](./render.md)
56
* [renderToString](./renderToString.md)
67
* [マウンティングオプション](./options.md)
78
- [context](./options.md#context)

docs/ja/api/render.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# `render(component {, options}])`
2+
3+
- **引数:**
4+
5+
- `{Component} component`
6+
- `{Object} options`
7+
- `{Object} context`
8+
- `{Array<Component|Object>|Component} children`
9+
- `{Object} slots`
10+
- `{Array<Componet|Object>|Component|String} default`
11+
- `{Array<Componet|Object>|Component|String} named`
12+
- `{Object} mocks`
13+
- `{Object|Array<string>} stubs`
14+
- `{Vue} localVue`
15+
16+
- **戻り値:** `{CheerioWrapper}`
17+
18+
- **オプション:**
19+
20+
[オプション](./options.md)を参照してください。
21+
22+
- **使い方:**
23+
24+
オブジェクトを文字列にレンダリングして [cheerio wrapper](https://github.com/cheeriojs/cheerio) を返します。
25+
26+
Cheerio は Node.js で jQuery のように DOM をスキャンするためのライブラリです。
27+
これは Vue Test Utils の [`Wrapper`](wrapper/README.md) に似ているAPIを持っています。
28+
29+
コンポーネントを静的なHTMLにレンダリングするために、`render` は内部で [`vue-server-renderer`](https://ssr.vuejs.org/en/basic.html) を使用します。
30+
31+
`render``@vue/server-test-utils` パッケージに含まれています。
32+
33+
**オプションなし:**
34+
35+
```js
36+
import { render } from '@vue/server-test-utils'
37+
import Foo from './Foo.vue'
38+
39+
describe('Foo', () => {
40+
it('renders a div', () => {
41+
const wrapper = render(Foo)
42+
expect(wrapper.text()).toContain('<div></div>')
43+
})
44+
})
45+
```
46+
47+
**Vueオプションを使用:**
48+
49+
```js
50+
import { render } from '@vue/server-test-utils'
51+
import Foo from './Foo.vue'
52+
53+
describe('Foo', () => {
54+
it('renders a div', () => {
55+
const wrapper = render(Foo, {
56+
propsData: {
57+
color: 'red'
58+
}
59+
})
60+
expect(wrapper.text()).toContain('red')
61+
})
62+
})
63+
```
64+
65+
**デフォルトおよび名前付きスロット:**
66+
67+
```js
68+
import { render } from '@vue/server-test-utils'
69+
import Foo from './Foo.vue'
70+
import Bar from './Bar.vue'
71+
import FooBar from './FooBar.vue'
72+
73+
describe('Foo', () => {
74+
it('renders a div', () => {
75+
const wrapper = render(Foo, {
76+
slots: {
77+
default: [Bar, FooBar],
78+
fooBar: FooBar, // <slot name="FooBar" /> にマッチします。
79+
foo: '<div />'
80+
}
81+
})
82+
expect(wrapper.text()).toContain('<div></div>')
83+
})
84+
})
85+
```
86+
87+
**グローバルプロパティをスタブする:**
88+
89+
```js
90+
import { render } from '@vue/server-test-utils'
91+
import Foo from './Foo.vue'
92+
93+
describe('Foo', () => {
94+
it('renders a div', () => {
95+
const $route = { path: 'http://www.example-path.com' }
96+
const wrapper = render(Foo, {
97+
mocks: {
98+
$route
99+
}
100+
})
101+
expect(wrapper.text()).toContain($route.path)
102+
})
103+
})
104+
```

docs/ja/api/renderToString.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@
2525

2626
コンポーネントをHTMLにレンダリングするために、`renderToString` は内部で [`vue-server-renderer`](https://ssr.vuejs.org/en/basic.html) を使用します。
2727

28+
`renderToString``@vue/server-test-utils` パッケージに含まれています。
29+
2830
**オプションなし:**
2931

3032
```js
31-
import { renderToString } from '@vue/test-utils'
33+
import { renderToString } from '@vue/server-test-utils'
3234
import Foo from './Foo.vue'
3335

3436
describe('Foo', () => {
@@ -42,7 +44,7 @@ describe('Foo', () => {
4244
**Vueオプションを使用:**
4345

4446
```js
45-
import { renderToString } from '@vue/test-utils'
47+
import { renderToString } from '@vue/server-test-utils'
4648
import Foo from './Foo.vue'
4749

4850
describe('Foo', () => {
@@ -60,7 +62,7 @@ describe('Foo', () => {
6062
**デフォルトおよび名前付きスロット:**
6163

6264
```js
63-
import { renderToString } from '@vue/test-utils'
65+
import { renderToString } from '@vue/server-test-utils'
6466
import Foo from './Foo.vue'
6567
import Bar from './Bar.vue'
6668
import FooBar from './FooBar.vue'
@@ -82,7 +84,7 @@ describe('Foo', () => {
8284
**グローバルプロパティをスタブする:**
8385

8486
```js
85-
import { renderToString } from '@vue/test-utils'
87+
import { renderToString } from '@vue/server-test-utils'
8688
import Foo from './Foo.vue'
8789

8890
describe('Foo', () => {

0 commit comments

Comments
 (0)