initializeHybridly

This function must be invoked in an entry file to initialize Hybridly's context and router.

Example

The following snippet is a typical example of how Hybridly could be set up.

import { createApp } from 'vue'
import { initializeHybridly } from 'virtual:hybridly/setup'

initializeHybridly()

enhanceVue

• Type: (vue: App) => MaybePromise<void>

Defines a callback that receives the Vue instance as a parameter and gets executed before Vue is mounted.

This can be used to register additionnal Vue plugins, directives or components.

Example

import { createApp } from 'vue'
import { createHead } from '@unhead/vue'
import { autoAnimatePlugin as autoAnimate } from '@formkit/auto-animate/vue'
import { initializeHybridly } from 'virtual:hybridly/setup'

initializeHybridly({
	enhanceVue: (vue) => vue 
		.use(createHead())
		.use(autoAnimate),
})

cleanup

• Type: bool
• Default: true

Defines whether to remove the data-payload attribute from the generated element. Note that this is not a security measure, but an aesthetic (and quite useless) one.

devtools

• Type: bool
• Default: true

Defines whether to register the Vue DevTools plugin when initializing Hybridly.

viewTransitions

• Type: bool
• Default: true

Defines whether view transitions are enabled. Currently, they are only supported on Chromium-based browsers and Hybridly provides no fallback.

responseErrorModals

• Type: bool
• Default: true in development, false otherwise

Defines whether to display an error modal when a hybrid request receives an invalid response. By default, this is true only in development.

progress

• Type: false or ProgressOptions

When set to false, disables the built-in progress indicator. Otherwise, configures it. Refer to the progress indicator documentation for more information.

plugins

• Type: Plugin[]

Defines the plugins that should be registered. Refer to the plugin documentation to learn more about them.

axios

• Type: Axios

Defines a custom Axios instance that will replace the one Hybridly would internally use otherwise.

import { initializeHybridly } from 'virtual:hybridly/setup'
import axios from 'axios'

initializeHybridly({
	axios: axios.create({
		headers: {
			'X-Custom-Header': 'value',
		},
	}),
})

setup

• Type: (options: SetupArguments) => MaybePromise<void>

Defines a callback that overrides how the Vue application will be created. It accepts an object with the necessary properties to set up Hybridly:

• element: the DOM element to which Vue should be mounted on
• wrapper: the wrapper component responsible for Hybridly to work
• render: the render function that should be passed to createApp
• hybridly: the Vue plugin that sets up Vue DevTools
• payload: an object representing the initial payload

By default, setup is optional because the Vue application is created under the hood. It can be enhanced through enhanceVue.

Example

import { createApp } from 'vue'
import { initializeHybridly } from 'virtual:hybridly/setup'

initializeHybridly({
	setup: ({ render, element, hybridly }) => createApp({ render }) 
		.use(hybridly)
		.mount(element),
})

id

• Type: string

Defines the id of the element the Vue application should be mounted on. When changing this value to something else than root, it must be updated in the directive as well.

serializer

• Type: { serialize: (data: object) => object; unserialize: (data: object) => object}

Provides custom serialization functions that are used when saving and loading data from the history state.

By default, the state is serialized using JSON.parse(JSON.stringify(data)), and unserialized as-is.