Skip to content

remindgmbh/nuxt-typo3

Repository files navigation

REMIND - Nuxt TYPO3

This nuxt3 module is the frontend part of the TYPO3 headless extension and remind/headless.

Requirements

TYPO3 Instance with the following extensions:

Installation

  1. install using npm install @remindgmbh/nuxt-typo3

  2. add module in nuxt.config.js

    export default defineNuxtConfig({
        ...
        modules: [
            ...
            '@remindgmbh/nuxt-typo3',
            ...
        ]
        ...
    })

Configuration

Module options are described in ModuleOptions Interface in module.ts and can be set using the config key typo3. Public runtimeConfig can be used as well to set module options.

Available App Config inputs are described in AppConfigInput Interface.

Customization

To customize a components template, script and style just create a component with the same name to override the original. Import the original component explicitly from @remindgmbh/nuxt-typo3/components/... and use it in the template to simply add additional script and styles.

IMPORTANT: Never use styles in assets for customizing components because they will be loaded regardless if the component is used on the current page or not.

Development

Use npm install to install dependencies. Add .env file to playground directory and set NUXT_PUBLIC_TYPO3_BASE_URL and NUXT_PUBLIC_TYPO3_API_BASE_URL. Then use npm run dev to start a dev server.