Skip to main content
Version: 2.0.0-alpha

Interface: CMSView

Custom additional views created by the developer, added to the main navigation.

Properties

description

Optional description: string

Optional description of this view. You can use Markdown

Defined in

lib/src/models/navigation.ts:138


group

Optional group: string

Optional field used to group top level navigation entries under a navigation view.

Defined in

lib/src/models/navigation.ts:164


hideFromNavigation

Optional hideFromNavigation: boolean

Should this view be hidden from the main navigation panel. It will still be accessible if you reach the specified path

Defined in

lib/src/models/navigation.ts:152


icon

Optional icon: string

Icon key to use in this view. You can use any of the icons in the MUI specs: https://mui.com/material-ui/material-icons/ e.g. 'AccountTree' or 'Person'

Defined in

lib/src/models/navigation.ts:146


name

name: string

Name of this view

Defined in

lib/src/models/navigation.ts:133


path

path: string

CMS Path you can reach this view from.

Defined in

lib/src/models/navigation.ts:128


view

view: ReactNode

Component to be rendered. This can be any React component, and can use any of the provided hooks

Defined in

lib/src/models/navigation.ts:158