About Page Exports

For providing an easy-to-use API to users, Vilay uses page exports to customize the behavior of the framework. Users can easily utilize these exports to use various features of Vilay.

Since Vilay is built on vite-plugin-ssr, users can also use every page exports provided by vite-plugin-ssr by default.

How to Use

Users can export any kind of page exports in every page file (.page.js/jsx/ts/tsx).

// _default.page.js
export const getPageHead = () => {
  title: 'My Vilay App', // This gets applied by default
}

// menu.page.js
export const getPageHead = () => ({
  title: 'Menu - My Vilay App', // This gets applied when visiting `/menu`
})

TypeScript Support

defineVilay() is provided for defining exports with types.

import { defineVilay } from 'vilay'

export default defineVilay({
  getPageHead: () => {
    title: 'My Vilay App', // Type inferred
  }
})