Awesome Open Source
Awesome Open Source

🏗️ Nuxt Composition API

Composition API hooks for Nuxt

@nuxtjs/composition-api provides a way to use the Vue 3 Composition API in with Nuxt-specific features.

Note: the main aim is to allow experimentation and feedback before the final release of Nuxt 3. The API of Nuxt-specific methods will likely change before Nuxt 3 is released.

Features

  • 🏃 Fetch: Support for the new Nuxt fetch() in v2.12+
  • ℹ️ Context: Easy access to router, app, store within setup()
  • 🗺️ Head: Interact directly with your vue-meta properties within setup()
  • Automatic hydration: Drop-in replacement for ref with automatic SSR stringification and hydration (ssrRef)
  • 📝 SSR support: Allows using the Composition API with SSR
  • 💪 TypeScript: Written in TypeScript

Read Documentation

Contributors

Contributions are very welcome.

  1. Clone this repo

    git clone [email protected]:nuxt-community/composition-api.git
    
  2. Install dependencies and build project

    yarn
    # Compile library and watch for changes
    yarn watch
    # Start a test Nuxt fixture with hot reloading
    yarn fixture
    # Test
    yarn test
    

Tip: You can also use yarn link to test the module locally with your Nuxt project.

License

MIT License - Copyright © Daniel Roe


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (68,104
typescript (10,420
hacktoberfest (4,217
vue (4,046
vuejs (1,070
nuxt (216
nuxtjs (120
nuxt-module (70
composition-api (17

Find Open Source By Browsing 7,000 Topics Across 59 Categories