Visual Editing Router

By default, clicking on a document from the Collection list takes you to the full-page editor.

Setting the ui.router property on a collection creates a link to the visual editor instead.

ui.router Usage

The router property is a function that should return either the page path as a string, or undefined to go to the default editor.

The function is run when a document is clicked in the Collection list.

Examples

Homepage routing

Returning / (home route) or a specific slug from the router function will link to that page with Visual Editing active.

Filename-dependent routing

It's possible to associate the routing to be based on document filenames, or programmatically.

Last Edited: March 17, 2025