Skip to content
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.

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

Guide > Components In-Depth > Custom Evnets の翻訳を追従 #300

Merged
merged 9 commits into from
May 2, 2021
56 changes: 26 additions & 30 deletions src/guide/component-custom-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,21 @@

## イベント名

コンポーネントやプロパティとは違い、イベント名の大文字と小文字は自動的に変換されません。その代わり発火されるイベント名とイベントリスナ名は全く同じにする必要があります。例えばキャメルケース(camelCase)のイベント名でイベントを発火した場合:
コンポーネントやプロパティと同じように、イベント名は大文字と小文字を自動的に変換します。子コンポーネントからキャメルケースでイベントを発行すると、親コンポーネントではケバブケースのリスナを追加できるようになります:

```js
this.$emit('myEvent')
```

ケバブケース(kebab-case)でリスナ名を作っても何も起こりません:

```html
<!-- Won't work -->
<my-component @my-event="doSomething"></my-component>
```

イベント名は JavaScript 内で変数やプロパティ名として扱われることはないので、キャメルケース(camelCase)またはパスカルケース(PascalCase)を使用する理由はありません。 さらに DOM テンプレート内の `v-on` イベントリスナは自動的に小文字に変換されます ( HTML が大文字と小文字を判別しないため)。このため `@myEvent` は `@myevent` になり `myEvent` にリスナが反応することができなくなります。

こういった理由から **いつもケバブケース(kebab-case)を使うこと** をお薦めします。
[プロパティの形式](/guide/component-props.html#プロパティの形式-キャメルケース-vs-ケバブケース) と同じように、DOM 内テンプレートを使っている場合は、ケバブケースのイベントリスナを使うことをお勧めします。文字列テンプーとを使っている場合は、この制約は適用されません。

## カスタムイベントの定義

<VideoLesson href="https://vueschool.io/lessons/defining-custom-events-emits?friend=vuejs" title="Learn how to define which events a component can emit with Vue School">Watch a free video about Defining Custom Events on Vue School</VideoLesson>
<VideoLesson href="https://vueschool.io/lessons/defining-custom-events-emits?friend=vuejs" title="Vue School でコンポーネントが発行できるイベントを定義する方法を学ぶ">Vue School でカスタムイベントの定義についての無料ビデオを視聴する</VideoLesson>

発行されたイベントは、 `emits` オプションを介して、コンポーネントで定義することが出来ます。

Expand All @@ -33,8 +28,7 @@ app.component('custom-form', {
})
```


ネイティブイベント(例、 `click` など)が `emits` オプションで定義されている場合、ネイティブリスナーとして扱われるのではなく、コンポーネントのイベントによって上書きされます。
ネイティブイベント(例、 `click` など)が `emits` オプションで定義されている場合、ネイティブイベントリスナの **代わりに** コンポーネントのイベントが使われます。

::: tip
コンポーネントの動作を実証するために、全ての発行されたイベントを定義することをお勧めします。
Expand Down Expand Up @@ -63,7 +57,7 @@ app.component('custom-form', {
}
},
methods: {
submitForm() {
submitForm(email, password) {
this.$emit('submit', { email, password })
}
}
Expand All @@ -75,28 +69,28 @@ app.component('custom-form', {
デフォルトでは、コンポーネントの `v-model` はプロパティとして `modelValue` を使用し、イベントとして `update:modelValue` を使用します。`v-model` 引数を渡してこれらの名前の変更が出来ます。

```html
<my-component v-model:foo="bar"></my-component>
<my-component v-model:title="bookTitle"></my-component>
```
この場合、子コンポーネントは `foo` プロパティを期待し、同期するために `update:foo` イベントを発行します。

```js
const app = Vue.createApp({})
この場合、子コンポーネントは `title` プロパティを期待し、同期するために `update:title` イベントを発行します。

```js
app.component('my-component', {
props: {
foo: String
title: String
},
emits: ['update:title'],
template: `
<input
type="text"
:value="foo"
@input="$emit('update:foo', $event.target.value)">
:value="title"
@input="$emit('update:title', $event.target.value)">
`
})
```

```html
<my-component v-model:foo="bar"></my-component>
<my-component v-model:title="bookTitle"></my-component>
```

## 複数の `v-model` のバインディング
Expand All @@ -113,13 +107,12 @@ app.component('my-component', {
```

```js
const app = Vue.createApp({})

app.component('user-name', {
props: {
firstName: String,
lastName: String
},
emits: ['update:firstName', 'update:lastName'],
template: `
<input
type="text"
Expand All @@ -138,16 +131,16 @@ app.component('user-name', {

## `v-model` 修飾子の処理

フォーム入力バインディングについて学習していたときに、 `v-model`に [組み込み修飾子](/guide/forms.html#modifiers) -`.trim``.number` 、および `.lazy` があることがわかりました。ただし、場合によっては、独自のカスタム修飾子を追加することもできます。
フォーム入力バインディングについて学習していたときに、 `v-model` に [組み込み修飾子](/guide/forms.html#modifiers) - `.trim``.number`、および `.lazy` があることがわかりました。ただし、場合によっては、独自のカスタム修飾子を追加することもできます。

`v-model` バインディングによって提供される文字列の最初の文字を大文字にするカスタム修飾子の例、`capitalize`を作成してみましょう。
`v-model` バインディングによって提供される文字列の最初の文字を大文字にするカスタム修飾子の例、`capitalize` を作成してみましょう。

コンポーネント `v-model` に追加された修飾子は、`modelModifiers` プロパティを介してコンポーネントに提供されます。以下の例では、デフォルトで空のオブジェクトになる `modelModifiers` プロパティを含むコンポーネントを作成しました。

コンポーネントの `created` ライフサイクルフックがトリガーされると、`modelModifiers` プロパティには `capitalize` が含まれ、その値は`true` になります。これは、 `v-model` バインディングに `v-model.capitalize = "var"` が設定されているためです。
コンポーネントの `created` ライフサイクルフックがトリガーされると、`modelModifiers` プロパティには `capitalize` が含まれ、その値は `true` になります。これは、 `v-model` バインディングに `v-model.capitalize="myText"` が設定されているためです。

```html
<my-component v-model.capitalize="bar"></my-component>
<my-component v-model.capitalize="myText"></my-component>
```

```js
Expand All @@ -158,6 +151,7 @@ app.component('my-component', {
default: () => ({})
}
},
emits: ['update:modelValue'],
template: `
<input type="text"
:value="modelValue"
Expand Down Expand Up @@ -194,6 +188,7 @@ app.component('my-component', {
default: () => ({})
}
},
emits: ['update:modelValue'],
methods: {
emitValue(e) {
let value = e.target.value
Expand All @@ -215,19 +210,20 @@ app.mount('#app')
引数を持つ `v-model` バインディングの場合、生成されるプロパティ名は `arg + "Modifiers"` になります。

```html
<my-component v-model:foo.capitalize="bar"></my-component>
<my-component v-model:description.capitalize="myText"></my-component>
```

```js
app.component('my-component', {
props: ['foo', 'fooModifiers'],
props: ['description', 'descriptionModifiers'],
emits: ['update:description'],
template: `
<input type="text"
:value="foo"
@input="$emit('update:foo', $event.target.value)">
:value="description"
@input="$emit('update:description', $event.target.value)">
`,
created() {
console.log(this.fooModifiers) // { capitalize: true }
console.log(this.descriptionModifiers) // { capitalize: true }
}
})
```