Module: RouterNavBar

The main nav used in various admin apps, using react router.

Parameters:

Name Type Description

props

object

Component props.

Properties

Name	Type	Description
`children`	JSX.Element	React element children.
`customAttributes`	object	Custom attributes for the component.
`customClasses`	string \| Array \| object	Custom classes for the component.
`items`	Array	The nav items.
`type`	string	The type of the nav bar, one of `icon-button` or `icon-text-tag`.

ref

object | null

Ref to the component.

Since: 3.3.2
Source: modules/RouterNavBar/index.js, line 10

Returns:

The RouterNavBar component.

Type:: JSX.Element

Example

import RouterNavBar from '@gravityforms/components/react/admin/modules/RouterNavBar';

const items = [
  {
    item: { active: true, key: 'send-a-test' },
    link: { to: '/send-a-test' },
    icon: { icon: 'beaker', iconPrefix: 'gravitysmtp-admin-icon' },
    text: { content: 'Send a test' },
  },
  {
    item: { active: true, key: 'scheduled-events' },
    link: { to: '/scheduled-events' },
    icon: { icon: 'clock', iconPrefix: 'gravitysmtp-admin-icon' },
    text: { content: 'Scheduled events' },
  },
];

return <RouterNavBar items={ items } />;