Nuxt.js ライブラリ「@vue-a11y/dark-mode」を使用してダークモードを実装する

作成日 2020.06.25
更新日 2020.07.17
nuxt.js
@vue-a11y/dark-mode, nuxt.js, ライブラリ

ライブラリ「@vue-a11y/dark-mode」をインストールすると、ダークモードへの切り替えが簡単に可能です。ここでは、nuxt.jsで@vue-a11y/dark-modeを利用するための手順と簡単な使い方を記述してます。

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

環境

OS ubuntu20.04
node v12.16.1
npm 6.14.2
Nuxt.js v2.12.0

Nuxt.js環境構築

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

npx create-nuxt-app nuxtapp

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

create-nuxt-app v2.15.0
✨  Generating Nuxt.js project in testnuxt
? Project name nuxtapp
? Project description My doozie Nuxt.js project
? Author name 
? Choose programming language JavaScript
? 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.22.4

※yarnをインスールしているので、ここではnpmではなくyarnを選択してます。

## yarnのインスールは下記コマンド
npm install -g yarn

外部IP許可

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

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

@vue-a11y/dark-modeインストール

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

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

## インストール
yarn add @vue-a11y/dark-mode

@vue-a11y/dark-mode使い方

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

import Vue from 'vue'
import VueDarkMode from '@vue-a11y/dark-mode'
Vue.use(VueDarkMode)

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

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

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

<template>
  <div class="container">
    <logo />
    <VueDarkMode>
      <template v-slot="{ mode }">
        Color mode: {{ mode }}
      </template>
    </VueDarkMode>
  </div>
</template>

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

export default {
  name: 'Nuxttest',
  components: {
    Logo
  },
  data () {
    return {
      modes: {
        type: Array,
        default () {
          return ['light', 'dark', 'system']
        }
      }
    }
  }
}
</script>
<style>
.container {
  margin: 0 auto;
  min-height: 100vh;
  display: flex;
  justify-content: center;
  align-items: center;
}
:root {
  --bg: #fff;
  --color: #333333;
}

html.dark-mode {
  --bg: #232b32;
  --color: #ddd8ca;
}

body {
  background-color: var(--bg);
  color: var(--color);
}
</style>

起動します