Nebulous Puffy Marshmallows
    Have ideas to improve npm?Join in the discussion! »

    @nuxtjs/composition-api
    TypeScript icon, indicating that this package has built-in type declarations

    0.23.1 • Public • Published

    🏗️ 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 git@github.com: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

    Install

    npm i @nuxtjs/composition-api

    DownloadsWeekly Downloads

    16,104

    Version

    0.23.1

    License

    MIT

    Unpacked Size

    113 kB

    Total Files

    20

    Last publish

    Collaborators

    • avatar