Skip to main content
Version: 3.0.0-beta

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​

packages/firecms_core/src/types/navigation.ts:169


group?​

optional group: string

Optional field used to group top level navigation entries under a navigation view. This prop is ignored for admin views.

Defined in​

packages/firecms_core/src/types/navigation.ts:197


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​

packages/firecms_core/src/types/navigation.ts:184


icon?​

optional icon: string

Icon key to use in this view. You can use any of the icons in the Material specs: https://fonts.google.com/icons e.g. 'account_tree' or 'person' Find all the icons in https://firecms.co/docs/icons

Defined in​

packages/firecms_core/src/types/navigation.ts:178


name​

name: string

Name of this view

Defined in​

packages/firecms_core/src/types/navigation.ts:164


path​

path: string

CMS Path you can reach this view from.

Defined in​

packages/firecms_core/src/types/navigation.ts:159


view​

view: ReactNode

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

Defined in​

packages/firecms_core/src/types/navigation.ts:190

Sign up to our newsletter to get the latest news and updates. No spam!