Vue.js

外観

目次

レンダー関数と JSX ​

Vue は、ほとんどの場合、アプリケーションを構築するためにテンプレートを使用することを推奨しています。しかし、JavaScript の完全なプログラムの力が必要な状況もあります。そこで、レンダー関数 を使用します。

仮想 DOM やレンダー関数の概念に初めて触れる方は、まずレンダリングの仕組みの章を必ずお読みください。

基本的な使い方 ​

vnode の作成 ​

Vue は、vnode を作成するための h() 関数を提供しています:

js
import { h } from 'vue'

const vnode = h(
  'div', // type
  { id: 'foo', class: 'bar' }, // props
  [
    /* children */
  ]
)

h() 関数は hyperscript の略で、「HTML（hypertext markup language）を生成する JavaScript」という意味です。この名前は、多くの仮想 DOM 実装で共有されている慣習を継承しています。より分かりやすい名前としては createVNode() がありますが、レンダー関数の中でこの関数を何度も呼び出さなければならない場合には、短い名前の方が便利です。

h() 関数は非常に柔軟に設計されています。

js
// type 以外のすべての引数は省略可能
h('div')
h('div', { id: 'foo' })

// props は属性とプロパティの両方が使用可能
// Vue は自動的に正しい割り当て方法を選択します
h('div', { class: 'bar', innerHTML: 'hello' })

// `.prop` や `.attr` などの props 修飾子には、
// それぞれ `.` と `^` という接頭辞を付けることができます
h('div', { '.name': 'some-name', '^width': '100' })

// class と style は、
// テンプレートと同じオブジェクト / 配列 の値をサポートしています
h('div', { class: [foo, { bar }], style: { color: 'red' } })

// イベントリスナーは onXxx として渡す必要があります
h('div', { onClick: () => {} })

// children は文字列です
h('div', { id: 'foo' }, 'hello')

// props がない場合は省略可能です
h('div', 'hello')
h('div', [h('span', 'hello')])

// 子供の配列は、vnode と文字列を混在させることができます
h('div', ['hello', h('span', 'hello')])

出来上がった vnode は以下のようになります:

js
const vnode = h('div', { id: 'foo' }, [])

vnode.type // 'div'
vnode.props // { id: 'foo' }
vnode.children // []
vnode.key // null

備考

完全な VNode インターフェースは他にも多くの内部プロパティを含んでいますが、ここに挙げた以外のプロパティに依存しないことを強く推奨します。これにより、内部プロパティが変更された場合に意図しない破損を避けることができます。

レンダー関数の宣言 ​

Composition API でテンプレートを使用する場合、setup() フックの戻り値はテンプレートにデータを公開するために使用されます。しかし、レンダー関数を使う場合は、代わりにレンダー関数を直接返すことができます:

js
import { ref, h } from 'vue'

export default {
  props: {
    /* ... */
  },
  setup(props) {
    const count = ref(1)

    // レンダー関数を返します
    return () => h('div', props.msg + count.value)
  }
}

レンダー関数は setup() の内部で宣言されているので、当然同じスコープで宣言された props やリアクティブなステートにアクセスすることができます。

単一の vnode を返すだけでなく、文字列や配列を返すこともできます:

js
export default {
  setup() {
    return () => 'hello world!'
  }
}
js
import { h } from 'vue'

export default {
  setup() {
    // 複数のルートノードを返すために配列を使用します。
    return () => [
      h('div'),
      h('div'),
      h('div')
    ]
  }
}

TIP

値を直接返すのではなく、必ず関数を返すようにしましょう！ setup() 関数はコンポーネントごとに一度だけ呼び出されますが、返されるレンダー関数は複数回呼び出されることになります。

レンダー関数は render オプションで宣言することができます:

js
import { h } from 'vue'

export default {
  data() {
    return {
      msg: 'hello'
    }
  },
  render() {
    return h('div', this.msg)
  }
}

render() 関数は、this を介してコンポーネントのインスタンスにアクセスできます。

単一の vnode を返すだけでなく、文字列や配列を返すこともできます:

js
export default {
  render() {
    return 'hello world!'
  }
}
js
import { h } from 'vue'

export default {
  render() {
    // 複数のルートノードを返すために配列を使用します。
    return [
      h('div'),
      h('div'),
      h('div')
    ]
  }
}

レンダー関数のコンポーネントがインスタンスの状態を必要としない場合、簡潔にするために、直接関数として宣言することもできます:

js
function Hello() {
  return 'hello world!'
}

そうです、これは有効な Vue コンポーネントなのです！この構文の詳細については、関数型コンポーネントを参照してください。

Vnode は一意でなければならない ​

コンポーネントツリー内のすべての vnode は一意でなければなりません。つまり、以下のレンダー関数は無効です:

js
function render() {
  const p = h('p', 'hi')
  return h('div', [
    // おっと - VNode が重複しています!
    p,
    p
  ])
}

どうしても同じ要素／コンポーネントを何度も複製したい場合は、ファクトリー関数を使用します。例えば、以下のレンダー関数は、20 個の同じ段落をレンダリングする方法として完全に有効です:

js
function render() {
  return h(
    'div',
    Array.from({ length: 20 }).map(() => {
      return h('p', 'hi')
    })
  )
}

JSX / TSX ​

JSX は、JavaScript の XML 的な拡張機能で、こんなコードを書くことができるようになります:

jsx
const vnode = <div>hello</div>

JSX 式の内部では、中括弧を使用して動的な値を埋め込みます:

jsx
const vnode = <div id={dynamicId}>hello, {userName}</div>

create-vue と Vue CLI には、JSX のサポートが事前に設定されたプロジェクトをスキャフォールドするためのオプションがあります。JSX を手動で設定する場合は、@vue/babel-plugin-jsx のドキュメントを参照すると詳細が分かるでしょう。

React によって最初に導入されましたが、JSX は実際にはランタイムセマンティクスが定義されておらず、様々な異なる出力にコンパイルすることができます。JSX を扱ったことがある場合、Vue JSX 変換は React の JSX 変換とは異なる ので、Vue アプリケーションで React の JSX 変換を使用することはできないことに注意してください。React の JSX との顕著な違いとしては、以下のようなものがあります:

  • class や for などの HTML 属性を props として使用できます - className や htmlFor を使用する必要はありません。
  • コンポーネントへの子要素の渡し方（スロットなど）が異なります。

Vue の型定義は、TSX を使用するための型推論も提供します。TSX を使用する場合は、Vue の JSX 変換が処理できるように、TypeScript が JSX の構文をそのまま残すように、必ず tsconfig.json で "jsx": "preserve" を指定してください。

JSX 型推論 ​

Vue JSX 変換と同様に、Vue の JSX も異なる型定義が必要です。

Vue 3.4 から、Vue はもはやグローバルな JSX 名前空間を暗黙的に登録しません。TypeScript に Vue の JSX 型定義を使用するよう指示するためには、tsconfig.json に以下を含めることを確認してください:

json
{
  "compilerOptions": {
    "jsx": "preserve",
    "jsxImportSource": "vue"
    // ...
  }
}

ファイルの先頭に /* @jsxImportSource vue */ のコメントを追加することで、ファイルごとにこの設定を適用することもできます。

もし、グローバルな JSX 名前空間の存在に依存するコードがある場合、プロジェクト内で vue/jsx を明示的にインポートまたは参照することで、3.4 以前のグローバル動作をそのまま保持することができます。これにより、vue/jsx はグローバルな JSX 名前空間を登録します。

レンダー関数のレシピ ​

以下では、テンプレート機能を同等のレンダー関数/JSX として実装するための一般的なレシピをいくつか紹介します。

v-if ​

Template:

template
<div>
  <div v-if="ok">yes</div>
  <span v-else>no</span>
</div>

同等のレンダー関数／JSX:

js
h('div', [ok.value ? h('div', 'yes') : h('span', 'no')])
jsx
<div>{ok.value ? <div>yes</div> : <span>no</span>}</div>
js
h('div', [this.ok ? h('div', 'yes') : h('span', 'no')])
jsx
<div>{this.ok ? <div>yes</div> : <span>no</span>}</div>

v-for ​

Template:

template
<ul>
  <li v-for="{ id, text } in items" :key="id">
    {{ text }}
  </li>
</ul>

同等のレンダー関数／JSX:

js
h(
  'ul',
  // `items` が配列の値を持つ ref であると仮定する
  items.value.map(({ id, text }) => {
    return h('li', { key: id }, text)
  })
)
jsx
<ul>
  {items.value.map(({ id, text }) => {
    return <li key={id}>{text}</li>
  })}
</ul>
js
h(
  'ul',
  this.items.map(({ id, text }) => {
    return h('li', { key: id }, text)
  })
)
jsx
<ul>
  {this.items.map(({ id, text }) => {
    return <li key={id}>{text}</li>
  })}
</ul>

v-on ​

on で始まり、大文字が続く名前の props は、イベントリスナーとして扱われます。例えば、 onClick はテンプレートでは @click に相当します。

js
h(
  'button',
  {
    onClick(event) {
      /* ... */
    }
  },
  'Click Me'
)
jsx
<button
  onClick={(event) => {
    /* ... */
  }}
>
  Click Me
</button>

イベント修飾子 ​

イベント修飾子 .passive, .capture, .once については、イベント名の後にキャメルケースを用いて連結して記述することが可能です。

例えば:

js
h('input', {
  onClickCapture() {
    /* キャプチャモード時のリスナー */
  },
  onKeyupOnce() {
    /* 一度だけトリガーする */
  },
  onMouseoverOnceCapture() {
    /* 一度だけ + キャプチャ */
  }
})
jsx
<input
  onClickCapture={() => {}}
  onKeyupOnce={() => {}}
  onMouseoverOnceCapture={() => {}}
/>

その他のイベントやキー修飾子については、withModifiers ヘルパーを使用することが可能です:

js
import { withModifiers } from 'vue'

h('div', {
  onClick: withModifiers(() => {}, ['self'])
})
jsx
<div onClick={withModifiers(() => {}, ['self'])} />

コンポーネント ​

コンポーネント用の vnode を作成するには、h() に渡される最初の引数はコンポーネントの定義でなければなりません。つまり、レンダー関数を使う場合、コンポーネントを登録する必要はなく、インポートされたコンポーネントを直接使えばいいのです:

js
import Foo from './Foo.vue'
import Bar from './Bar.jsx'

function render() {
  return h('div', [h(Foo), h(Bar)])
}
jsx
function render() {
  return (
    <div>
      <Foo />
      <Bar />
    </div>
  )
}

このように、h は有効な Vue コンポーネントであれば、どんなファイルフォーマットからインポートしたコンポーネントでも動作させることができます。

動的コンポーネントは、レンダー関数を使えば簡単です:

js
import Foo from './Foo.vue'
import Bar from './Bar.jsx'

function render() {
  return ok.value ? h(Foo) : h(Bar)
}
jsx
function render() {
  return ok.value ? <Foo /> : <Bar />
}

コンポーネントが名前で登録されていて直接インポートできない場合（例えば、ライブラリーによってグローバルに登録されている場合）、 resolveComponent() ヘルパーを使ってプログラムで解決することが可能です。

スロットのレンダリング ​

レンダー関数では、スロットは setup() コンテキストからアクセスすることができます。slots オブジェクトの各スロットは、vnode の配列を返す関数 です:

js
export default {
  props: ['message'],
  setup(props, { slots }) {
    return () => [
      // デフォルトスロット:
      // <div><slot /></div>
      h('div', slots.default()),

      // 名前付きスロット:
      // <div><slot name="footer" :text="message" /></div>
      h(
        'div',
        slots.footer({
          text: props.message
        })
      )
    ]
  }
}

同等の JSX:

jsx
// デフォルト
<div>{slots.default()}</div>

// 名前付き
<div>{slots.footer({ text: props.message })}</div>

レンダー関数では、スロットは this.$slots からアクセスすることができます。

js
export default {
  props: ['message'],
  render() {
    return [
      // <div><slot /></div>
      h('div', this.$slots.default()),

      // <div><slot name="footer" :text="message" /></div>
      h(
        'div',
        this.$slots.footer({
          text: this.message
        })
      )
    ]
  }
}

同等の JSX:

jsx
// <div><slot /></div>
<div>{this.$slots.default()}</div>

// <div><slot name="footer" :text="message" /></div>
<div>{this.$slots.footer({ text: this.message })}</div>

スロットの渡し方 ​

コンポーネントへの子の渡し方は、要素への子の渡し方と少し異なります。配列の代わりに、スロット関数か、スロット関数のオブジェクトを渡す必要があります。スロット関数は、通常のレンダー関数が返せるものなら何でも返せますが、子コンポーネントでアクセスするときは、常に vnode の配列に正規化されます。

js
// 単一のデフォルトスロット
h(MyComponent, () => 'hello')

// 名前付きスロット
// スロットのオブジェクトが props として扱われるのを避けるために、
// `null` が必要であることに注意してください。
h(MyComponent, null, {
  default: () => 'default slot',
  foo: () => h('div', 'foo'),
  bar: () => [h('span', 'one'), h('span', 'two')]
})

同等の JSX:

jsx
// デフォルト
<MyComponent>{() => 'hello'}</MyComponent>

// 名前付き
<MyComponent>{{
  default: () => 'default slot',
  foo: () => <div>foo</div>,
  bar: () => [<span>one</span>, <span>two</span>]
}}</MyComponent>

スロットを関数として渡すことで、子コンポーネントがスロットを遅延的に呼び出すことができます。これにより、スロットの依存関係が親ではなく子によって追跡されるようになり、より正確で効率的な更新が行われるようになります。

スコープ付きスロット（scoped slot） ​

親コンポーネントでスコープ付きスロットをレンダリングするには、子コンポーネントにスロットを渡します。スロットが text というパラメーターを持っていることに注意してください。スロットは子コンポーネントで呼び出され、子コンポーネントのデータが親コンポーネントに渡されます。

js
// 親コンポーネント
export default {
  setup() {
    return () => h(MyComp, null, {
      default: ({ text }) => h('p', text)
    })
  }
}

スロットが props として扱われないように、null を渡すのを忘れないでください。

js
// 子コンポーネント
export default {
  setup(props, { slots }) {
    const text = ref('hi')
    return () => h('div', null, slots.default({ text: text.value }))
  }
}

同等の JSX:

jsx
<MyComponent>{{
  default: ({ text }) => <p>{ text }</p>  
}}</MyComponent>

組み込みコンポーネント ​

レンダー関数で使用するためには、<KeepAlive>, <Transition>, <TransitionGroup>, <Teleport>, <Suspense> などの 組み込みコンポーネント をインポートする必要があります。

js
import { h, KeepAlive, Teleport, Transition, TransitionGroup } from 'vue'

export default {
  setup () {
    return () => h(Transition, { mode: 'out-in' }, /* ... */)
  }
}
js
import { h, KeepAlive, Teleport, Transition, TransitionGroup } from 'vue'

export default {
  render () {
    return h(Transition, { mode: 'out-in' }, /* ... */)
  }
}

v-model ​

v-model ディレクティブは、テンプレートのコンパイル時に modelValue と onUpdate:modelValue props に展開されます:

js
export default {
  props: ['modelValue'],
  emits: ['update:modelValue'],
  setup(props, { emit }) {
    return () =>
      h(SomeComponent, {
        modelValue: props.modelValue,
        'onUpdate:modelValue': (value) => emit('update:modelValue', value)
      })
  }
}
js
export default {
  props: ['modelValue'],
  emits: ['update:modelValue'],
  render() {
    return h(SomeComponent, {
      modelValue: this.modelValue,
      'onUpdate:modelValue': (value) => this.$emit('update:modelValue', value)
    })
  }
}

カスタムディレクティブ ​

カスタムディレクティブは、withDirectivesを使って vnode に適用することが可能です:

js
import { h, withDirectives } from 'vue'

// カスタムディレクティブ
const pin = {
  mounted() { /* ... */ },
  updated() { /* ... */ }
}

// <div v-pin:top.animate="200"></div>
const vnode = withDirectives(h('div'), [
  [pin, 200, 'top', { animate: true }]
])

ディレクティブが名前で登録されていて、直接インポートできない場合は、resolveDirective ヘルパーを使って解決することが可能です。

テンプレート参照 ​

Composition API では、ref() 自身を vnode の props として渡すことで、テンプレート参照が作成されます:

js
import { h, ref } from 'vue'

export default {
  setup() {
    const divEl = ref()

    // <div ref="divEl">
    return () => h('div', { ref: divEl })
  }
}

Options API では、vnode の props に ref の名前を文字列で渡すことで、テンプレート参照が作成されます:

js
export default {
  render() {
    // <div ref="divEl">
    return h('div', { ref: 'divEl' })
  }
}

関数型コンポーネント ​

関数型コンポーネントは、それ自身の状態を持たないコンポーネントの代替形態です。それらは純粋な関数のように動作します。props を受け取り、vnode を返します。 コンポーネントのインスタンスを作成することなく（つまり、this はありません）、通常のコンポーネントのライフサイクルフックもなくレンダリングされます。

関数型コンポーネントを作成するには、オプションオブジェクトではなく、単純な関数を使用します。この関数は事実上、コンポーネントの render 関数です。

関数型コンポーネントのシグネチャは setup() フックと同じです:

js
function MyComponent(props, { slots, emit, attrs }) {
  // ...
}

関数型コンポーネントに this という参照はないので、Vue は最初の引数として props を渡します:

js
function MyComponent(props, context) {
  // ...
}

第二引数の context には、3 つのプロパティが含まれます。 attrs , emit , そして slots です。これらはそれぞれ、インスタンスのプロパティである $attrs, $emit, および $slots と同じです。

コンポーネントに対する通常の設定オプションのほとんどは、関数型コンポーネントでは使用できません。しかし、props と emits はプロパティとして追加することで定義することが可能です:

js
MyComponent.props = ['value']
MyComponent.emits = ['click']

props オプションが指定されていない場合、関数に渡される props オブジェクトには、attrs と同じようにすべての属性が含まれます。props オプションが指定されない限り、props の名前はキャメルケースに正規化されません。

明示的に props を指定した関数型コンポーネントの場合、属性のフォールスルーは通常のコンポーネントとほぼ同じように動作します。しかし、props を明示的に指定しない関数型コンポーネントの場合は、class、style、onXxx イベントリスナーのみがデフォルトで attrs から継承されます。どちらの場合でも、 inheritAttrs を false に設定することで、属性の継承を無効化できます。

js
MyComponent.inheritAttrs = false

関数型コンポーネントは、通常のコンポーネントと同様に登録や使用ができます。もし、h() の第一引数に関数を渡した場合、それは関数型コンポーネントとして扱われます。

関数型コンポーネントの型付け ​

関数型コンポーネントは、名前付きか匿名かに基づいて型付けできます。Vue - Official 拡張機能は SFC のテンプレートで関数型コンポーネントを使用する際に、適切に型付けされた関数型コンポーネントの型チェックもサポートします。

名前付き関数型コンポーネント

tsx
import type { SetupContext } from 'vue'
type FComponentProps = {
  message: string
}

type Events = {
  sendMessage(message: string): void
}

function FComponent(
  props: FComponentProps,
  context: SetupContext<Events>
) {
  return (
    <button onClick={() => context.emit('sendMessage', props.message)}>
        {props.message} {' '}
    </button>
  )
}

FComponent.props = {
  message: {
    type: String,
    required: true
  }
}

FComponent.emits = {
  sendMessage: (value: unknown) => typeof value === 'string'
}

匿名関数型コンポーネント

tsx
import type { FunctionalComponent } from 'vue'

type FComponentProps = {
  message: string
}

type Events = {
  sendMessage(message: string): void
}

const FComponent: FunctionalComponent<FComponentProps, Events> = (
  props,
  context
) => {
  return (
    <button onClick={() => context.emit('sendMessage', props.message)}>
        {props.message} {' '}
    </button>
  )
}

FComponent.props = {
  message: {
    type: String,
    required: true
  }
}

FComponent.emits = {
  sendMessage: (value) => typeof value === 'string'
}

このページを GitHub で編集