question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Invalid documentation/types regarding Nuxt module options

See original GitHub issue

Versions

  • 1.4.0

Describe the bug

As far as the documentation and TS types go, both cssFile and plugin options have to be specified in the same, flat object like so:

    ['vue-toastification/nuxt', {
        cssFile: 'ssss.css',
        containerClassName: 'my-container-class',
        position: 'top-left',
    })],

But as far as the actual code goes, the user has to pass the plugin options through pluginOptions like so:

    ['vue-toastification/nuxt', {
        cssFile: 'ssss.css',
        pluginOptions: {
            containerClassName: 'my-container-class',
            position: 'top-left',
        },
    })],

Expected behavior

Code, documentation and types should match.

Steps to reproduce

  1. Register Nuxt module, per documentation, with:
    ['vue-toastification/nuxt', {
        position: 'top-left',
    })],
  1. Notice that setting doesn’t apply (notification uses default top-right placement).

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
rchlcommented, Apr 24, 2020

I agree, the code and documentation quality is excellent and the level of customization that is allowed is almost infinite 😃 Thank you.

2reactions
connecteevcommented, Apr 24, 2020

@Maronato thanks for this fix with nuxt, love your repo and how well-maintained it is!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Modules support status · Discussion #751 · nuxt/framework
Currently, we are trying hard to make the bridge module more stable and provide tooling and documentation for module authors in order to...
Read more >
Modules directory - Nuxt
This is the content of the user's nuxt.config.js with all default options assigned to it. It can be used for shared options between...
Read more >
Configuration - Nuxt
Nuxt lets you define the CSS files/modules/libraries you want to set globally ... Thanks to Vue Loader , you can use any kind...
Read more >
The modules Property - Nuxt
nuxt.options.plugins.push(... ) Reverse the order of the modules if it depends on another. Modules should export a function ...
Read more >
Options - nuxtjs/sentry
environment variables; sentry object in nuxt.config.js; when registering the module: modules: [['@nuxtjs/sentry', {/*options*/}]].
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found