Site / foldkit-site

RouteOptions

interface · packages/site/src/index.ts:97

interface RouteOptions<
  Route extends {
    readonly _tag: string
  },
> {
  readonly title?: ((route: Route) => string) | undefined
  readonly section?: string | undefined
  readonly landing?: Omit<Route, '_tag'> | undefined
  readonly shortcut?: KeySequence | undefined
  readonly history?:
    HistoryIntent | ((prev: Route, next: Route) => HistoryIntent) | undefined
  readonly layout?: NodeLayout | undefined
  readonly view?: NodeView | undefined
  readonly meta?: NodeMeta<Route> | undefined
  readonly indexed?: boolean | undefined
  readonly access?: NodeAccess<never> | undefined
}

What Site.route annotates a node with, beside its Surface.

Members

RouteOptions.title

property · packages/site/src/index.ts:98

readonly title?: ((route: Route) => string) | undefined

RouteOptions.section

property · packages/site/src/index.ts:99

readonly section?: string | undefined

RouteOptions.landing

property · packages/site/src/index.ts:100

readonly landing?: Omit<Route, '_tag'> | undefined

RouteOptions.shortcut

property · packages/site/src/index.ts:101

readonly shortcut?: KeySequence | undefined

RouteOptions.history

property · packages/site/src/index.ts:102

readonly history?:
  HistoryIntent | ((prev: Route, next: Route) => HistoryIntent) | undefined

RouteOptions.layout

property · packages/site/src/index.ts:103

readonly layout?: NodeLayout | undefined

RouteOptions.view

property · packages/site/src/index.ts:104

readonly view?: NodeView | undefined

RouteOptions.meta

property · packages/site/src/index.ts:105

readonly meta?: NodeMeta<Route> | undefined

RouteOptions.indexed

property · packages/site/src/index.ts:106

readonly indexed?: boolean | undefined

RouteOptions.access

property · packages/site/src/index.ts:107

readonly access?: NodeAccess<never> | undefined