Interface RouteConfig

interface RouteConfig {
    action?: boolean | ActionFunction;
    autoReplaceTitle?: boolean;
    caseSensitive?: boolean;
    Component?: null | ComponentType<{}>;
    contentProps?: HTMLAttributes<HTMLDivElement>;
    disableBreadcrumbJump?: boolean;
    element?: RouteElement;
    ErrorBoundary?: null | ComponentType<{}>;
    errorElement?: ReactNode;
    handle?: any;
    hasErrorBoundary?: boolean;
    HydrateFallback?: null | ComponentType<{}>;
    hydrateFallbackElement?: ReactNode;
    id?: string;
    index?: boolean;
    isStatic?: boolean;
    keywords?: string[];
    lazy?:
        | LazyRouteFunction<NonIndexRouteObject>
        | LazyRouteFunction<IndexRouteObject>;
    loader?: boolean | LoaderFunction<any>;
    name: string;
    parent?: RouteConfig;
    parentNamePath?: string[];
    path?: string;
    permissionCode?: string;
    redirectTo?: string;
    routes?: RouteConfig[];
    shouldRevalidate?: ShouldRevalidateFunction;
    title?: string;
    type?: string;
    [key: string]: any;
}

Hierarchy (View Summary)

  • Omit<RouteProps, "children" | "element">
  • Record<string, any>

Indexable

  • [key: string]: any

Properties

action? autoReplaceTitle? caseSensitive? Component? contentProps? disableBreadcrumbJump? element? ErrorBoundary? errorElement? handle? hasErrorBoundary? HydrateFallback? hydrateFallbackElement? id? index? isStatic? keywords? lazy? loader? name parent? parentNamePath? path? permissionCode? redirectTo? routes? shouldRevalidate? title? type?

Properties

Optionalaction

action?: boolean | ActionFunction

OptionalautoReplaceTitle

autoReplaceTitle?: boolean

自动替换页面标题

OptionalcaseSensitive

caseSensitive?: boolean

OptionalComponent

Component?: null | ComponentType<{}>

OptionalcontentProps

contentProps?: HTMLAttributes<HTMLDivElement>

路由容器 props

OptionaldisableBreadcrumbJump

disableBreadcrumbJump?: boolean

禁用面包屑跳转 某些带参数的 url 需要激活此选项以禁止点击面包屑时跳转页面

Optionalelement

element?: RouteElement

OptionalErrorBoundary

ErrorBoundary?: null | ComponentType<{}>

OptionalerrorElement

errorElement?: ReactNode

Optionalhandle

handle?: any

OptionalhasErrorBoundary

hasErrorBoundary?: boolean

OptionalHydrateFallback

HydrateFallback?: null | ComponentType<{}>

OptionalhydrateFallbackElement

hydrateFallbackElement?: ReactNode

Optionalid

id?: string

Optionalindex

index?: boolean

OptionalisStatic

isStatic?: boolean

是否静态, 默认 false, 非静态下 url 变更将强制组件重写渲染

Optionalkeywords

keywords?: string[]

关键字 用于检索

Optionallazy

lazy?:
    | LazyRouteFunction<NonIndexRouteObject>
    | LazyRouteFunction<IndexRouteObject>

Optionalloader

loader?: boolean | LoaderFunction<any>

name

name: string

路由的 name,全局唯一

Optionalparent

parent?: RouteConfig

父级路由 auto-routes 会根据 RouteConfig 层级自动注入，无需手动声明

OptionalparentNamePath

parentNamePath?: string[]

嵌套层级路径，路由 name 的数组 用明确路由嵌套层级 auto-routes 会根据 RouteConfig 层级自动注入，无需手动声明

Optionalpath

path?: string

路径

OptionalpermissionCode

permissionCode?: string

权限代码, 控制路由能否被访问

OptionalredirectTo

redirectTo?: string

重定向

Optionalroutes

routes?: RouteConfig[]

子路由 子路由 path 与父级不存在嵌套关系

OptionalshouldRevalidate

shouldRevalidate?: ShouldRevalidateFunction

Optionaltitle

title?: string

页面标题

Optionaltype

type?: string

自定义参数, 视情况而定

Settings

Member Visibility

On This Page

Properties