Nuxt.js vue-highlight-wordsを使用して指定した文字列をハイライト表示する

作成日 2020.02.14
nuxt.js
nuxt.js

ライブラリ「vue-highlight-words」をインストールすると、指定した文字列をハイライト表示することできます。ここでは、nuxt.jsでvue-highlight-wordsを利用するための手順と簡単な使い方を記述してます。

1. 環境
2. Nuxt.js環境構築
3. 外部IP許可
4. vue-highlight-wordsインストール
5. vue-highlight-words使い方

環境

OS ubuntu19.10
node v12.13.0
npm 6.13.7
Nuxt.js v2.11.0

Nuxt.js環境構築

下記のコマンドで構築。ここでは、nuxtappという名前でプロジェクトを作成してます。

npx create-nuxt-app nuxtapp

下記の設定で構築してます。

✨  Generating Nuxt.js project in nuxtapp
? Project name nuxtapp
? Project description My laudable Nuxt.js project
? Author name taro
? Choose the package manager Yarn
? Choose UI framework None
? Choose custom server framework None (Recommended)
? Choose Nuxt.js modules (Press <space> to select, <a> to toggle all, <i> to invert selection)
? Choose linting tools ESLint
? Choose test framework None
? Choose rendering mode Universal (SSR)
? Choose development tools (Press <space> to select, <a> to toggle all, <i> to invert selection)
yarn run v1.19.1

外部IP許可

localhostではなくプライベートIPを利用して接続して確認したいので、作成したプロジェクト配下にあるpackage.jsonに下記を追加します。

"config": {
  "nuxt": {
    "host": "0.0.0.0",
    "port": "3000"
  }
},

vue-highlight-wordsインストール

下記のコマンドでインストールします。

## 作成したプロジェクトに移動
cd nuxtapp

## インストール
yarn add vue-highlight-words

vue-highlight-words使い方

plugins配下にplugin.jsを作成し、下記の通りに編集します。

import Vue from 'vue'
import Highlighter from 'vue-highlight-words'
Vue.component('vue-highlight-words', Highlighter)

プロジェクト配下にあるnuxt.config.jsに下記のコードを追加します。

plugins: [
    {
      src: '@/plugins/plugin',
      mode: 'client'
    }
  ],

pages配下にあるindex.vueを下記の通りに編集します。

<template>
  <div class="container">
    <div>
      <logo />
      <div>
        <vue-highlight-words
          class="my-highlight"
          :style="{ color: 'black' }"
          highlight-class-name="highlight"
          :search-words="keywords"
          :auto-escape="true"
          :text-to-highlight="text"
        />
      </div>
    </div>
  </div>
</template>

<script>
import Logo from '~/components/Logo.vue'

export default {
  name: 'Nuxttest',
  components: {
    Logo
  },
  data () {
    return {
      text: '本日は晴天なり。明日は雨',
      words: '本日 明日'
    }
  },
  computed: {
    keywords () {
      return this.words.split(' ')
    }
  }
}
</script>
<style>
.container {
  margin: 0 auto;
  min-height: 100vh;
  display: flex;
  justify-content: center;
  align-items: center;
  text-align: center;
  font-size: 40px;
}
</style>

起動します