Code Monkey home page Code Monkey logo

storybook-nuxt's Introduction

Storybook for Nuxt framework

sb-nuxt (2)

Storybook package for Nuxt framework with zero configs. seamless integration supporting all Nuxt fancy features

https://www.veed.io/embed/1f9d58b6-3c76-43a1-a15e-ae95af8dff5f

Demos

Storybook module for setup:

Storybook Nuxt-Module

Storybook Nuxt-Module Demo

Supported Features

๐Ÿ‘‰ Nuxt Modules

๐Ÿ‘‰ Nuxt Plugins

๐Ÿ‘‰ All in-built Nuxt Components

๐Ÿ‘‰ Sass/Scss

๐Ÿ‘‰ Css/Sass/Scss Modules

๐Ÿ‘‰ JSX

๐Ÿ‘‰ Postcss

๐Ÿ‘‰ Auto Imports

๐Ÿ‘‰ Runtime Config

๐Ÿ‘‰ Composables

๐Ÿ‘‰ Typescript (already supported out of the box by Storybook)

๐Ÿ‘‰ Nuxt DevTools : finally as Bonus, Nuxt DevTools works amazingly with your Storybook, full features

storybook-nuxt-devtools.mov

Requirements

Getting Started

In a project without Storybook

Follow the prompts after running this command in your Nuxt project's root directory:

npx storybook-nuxt init

More on getting started with Storybook

Automatic migration

When running the upgrade command above, you should get a prompt asking you to migrate to @storybook-vue/nuxt, which should handle everything for you. In case auto-migration does not work for your project, refer to the manual migration below.

Update your main.js to change the framework property:

// .storybook/main.js
export default {
  // ...
  framework: {
    name: '@storybook-vue/nuxt', // Add this
    options: {},
  },
}

Documentation

check https://storybook.nuxtjs.org/

License

This repository is licensed under the MIT License. Feel free to use the code and modify it according to your needs.

Contacts :

๐Ÿ”– Mail: [email protected]

๐Ÿ’ฌ Discord: ChakAs3

๐Ÿฆโ€โฌ› Twitter: @ChakirQatab

storybook-nuxt's People

Contributors

chakas3 avatar jdassin avatar lucamargadant avatar tobiasdiez avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.