@roxi/routify-test

Routify 3

Using Routify

Creating a Routify instance

const instance = new Routify({/* options */})

Creating a router

Basic

<script>
    import { Router } from '@roxi/routify'
    import { routes } from '../.routify/routes.default.js'
</script>

<Router {routes} />

Create instance manually

<script>
    import { Routify, Router } from '@roxi/routify'
    import { routes } from '../.routify/routes.default.js'
    const instance = new Routify({ routes, /* options */ })
</script>

<Router {instance} />

Creating nodes

// create a root node
const rootNode = instance.superNode.createChild('my-root-node')

// create a page node
rootNode.createChild('im-page-1', module)
rootNode.createChild('im-page-2', module)

// Note: module can be a module or its path

Appending nodes

// create a root node
const rootNode = instance.createNode('my-root-node')
instance.superNode.appendChild(rootNode)

// create a page node
const childNode = instance.createNode('my-child-node')
rootNode.appendChild(childNode)

Structure (draft)

• Global (class)
  • Instance (class)
    • nodeIndex (array)
    • superNode (class)
    • Router* (module)
      • Router (class)
        • params
        • activeUrl** (ActiveUrl)
        • activeRoute** (Route)
          • fragments (RouteFragment[])
      • module* (module)
        • module* (module)
          • module* (module) ...

*: module

**: Store

API

Table of Contents

• RoutifyRuntimePayload
• RoutifyCallback
  • Parameters
• RoutifyPlugin
  • Properties
• PathNode
  • Properties

RoutifyRuntimePayload

Type: {instance: RoutifyRuntime}

RoutifyCallback

Type: Function

Parameters

• first {instance: Routify}

Returns (T | Promise<T>)

RoutifyPlugin

Type: Object

Properties

• before (string | Array<string>)? name of plugin(s) to run before
• after (string | Array<string>)? name of plugin(s) to run after
• condition RoutifyCallback<Boolean>? run plugin if true
• run RoutifyCallback<any> plugin script
• mode ("compile" | "runtime")

PathNode

Type: Object

Properties

• urlFragment string
• node RNodeRuntime