Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serkodev/nuxt-pages-plus
(WIP) A Nuxt module that enables complex routing for Nuxt Pages.
https://github.com/serkodev/nuxt-pages-plus
Last synced: 4 days ago
JSON representation
(WIP) A Nuxt module that enables complex routing for Nuxt Pages.
- Host: GitHub
- URL: https://github.com/serkodev/nuxt-pages-plus
- Owner: serkodev
- License: mit
- Created: 2024-04-06T10:49:12.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T23:09:23.000Z (7 months ago)
- Last Synced: 2024-04-14T08:37:12.913Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 515 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Pages Plus
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
A Nuxt module that enables complex routing for Nuxt Pages.
## Features
- 🛤️ Parallel Routes - Render multiple pages in a single route, synchronously or manually.
- 🖼️ Modal Routes - Navigate modals routes with real-time URL changes for seamless browsing.
- 📁 File-base Routing - Create named routes right inside pages directory of your Nuxt project.
- 🔋 SSR Friendly - Optimized for Nuxt server-side rendering and static site generation.
- ⚙️ Comprehensive Toolkit - Extensive components and composables for flexible usage and easy integration.
- 🛠 Flexible - Tailor settings globally or for specific pages; fully customizable.
## Quickstart
Install the module to your Nuxt application with `nuxi` command:
```sh
npx nuxi module add nuxt-pages-plus
```
Install manually
```sh
npm i -D nuxt-pages-plus
```
```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['nuxt-pages-plus']
})
```
## Documentation
Please refer to the [Nuxt Pages Plus documentation](https://nuxt-pages-plus.pages.dev/) for detailed usage and examples.
## Contribution
Local development
```bash
# Install dependencies
pnpm install
# Generate type stubs
pnpm dev:prepare
# Develop with the examples
pnpm dev examples/...
# Develop with the playground
pnpm play
# Build the playground
pnpm play:build
# Run ESLint
pnpm lint
# Run Vitest
pnpm test
pnpm test:watch
# Release new version
pnpm release
```
## Inspiration
This module is inspired by Next.js [App Router](https://app-router.vercel.app/). Many thanks to [Anthony Fu](https://github.com/antfu) for providing the opinion of implementing Parallel Routes feature using Nuxt.
[npm-version-src]: https://img.shields.io/npm/v/nuxt-pages-plus/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nuxt-pages-plus
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-pages-plus.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/nuxt-pages-plus
[license-src]: https://img.shields.io/npm/l/nuxt-pages-plus.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/nuxt-pages-plus
[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
[nuxt-href]: https://nuxt.com