nuxt-typo3-theme

nuxt-typo3-theme

Customizable UI theme for nuxt-typo3.

Features

✅ Mobile First

✅ UI for all content elements

✅ Storybook documentation

✅ TypeScript

✅ Unit test for content elements

Requirements

This module use Nuxt+TypeScript - please setup it before: https://typescript.nuxtjs.org/guide/setup

yarn add --dev @nuxt/typescript-build @nuxt/types

edit nuxt.config.js

export default {
  buildModules: ['@nuxt/typescript-build']
}

Please remember to setup tsconfig.json. More info here

Installation

yarn add nuxt-typo3-theme

edit nuxt.config.js:

  buildModules: [
    '@nuxt/typescript-build',
    'nuxt-typo3-theme',
    'nuxt-typo3'
  ],

This module install default layouts for you, so you can see warning in the console:

WARN  Duplicate layout registration, "default" has been registered as "./layouts.default.bc51ceba.vue"

You can delete your layouts/default.vue file or disable layouts provided by theme:

  typo3theme: {
    layouts: false
  }

Customization

CSS

You can override css by SCSS or CSS variables:

layouts/default.vue:

<style>
:root {
    --color-primary: red;
    --color-bg-secondary: blue;
    --color-bg-primary: var(--color-primary);
    --font-family-primary: Helvetica;
}
</style>

If you need to override SCSS variables, please use https://www.npmjs.com/package/@nuxtjs/style-resources to import them as a global.

Override components

Some components are registered as a local components, for instance UiLogo in CwHeader. You can replace UiLogo by register own component as a global.

components/UiLogo.vue

<template>
  <div>My logo</div>
</template>
<script>
export default {
  name: 'UiLogo'
}
</script>

plugins/components.js:

import Vue from 'vue'
import UiLogo from '../components/Logo.vue'

Vue.component('UiLogo', UiLogo)

Use components file as plugin in nuxt.config.js

nuxt.config.js:

plugins: [
  '~plugins/components'
],

Resources

• Nuxt-TYPO3 Documentation
• Nuxt documentation