@cypress-design/react-docmenu v1.0.2

DocMenu

Install

npm install @cypress-design/react-docmenu

or with yarn

yarn add @cypress-design/react-docmenu

Usage

import DocMenu from '@cypress-design/react-docmenu'

Default usage

export default () => (
  <DocMenu
    activePath="#group-item-3"
    items={[
      {
        label: 'Get Started',
        href: '#get-started',
      },
      {
        label: 'Overview',
        items: [
          {
            label: 'Overview Item 1',
            href: '#overview-item-1',
          },
          {
            label: 'Overview Item 2',
            href: '#overview-item-2',
          },
        ],
      },
      {
        label: 'Getting Started',
        items: [
          {
            label: 'Item 1',
            href: '#item-1',
          },
          {
            label: 'Group',
            items: [
              {
                label: 'Item 1',
                href: '#group-item-1',
              },
              {
                label: 'Item 2',
                href: '#group-item-2',
              },
              {
                label: 'Item 3',
                href: '#group-item-3',
              },
              {
                label: 'Item 4',
                href: '#group-item-4',
              },
            ],
          },
          {
            label: 'Item 5',
            href: '#',
          },
        ],
      },
    ]}
  />
)

With a custom link

const CustomLink = ({ href, children, className }) => {
  return (
    <a
      href={href}
      className={className}
      onClick={(evt) => {
        console.log('The link was clicked.', { target: evt.target })
      }}
    >
      {children} 🔗
    </a>
  )
}

export default () => (
  <DocMenu
    LinkComponent={CustomLink}
    items={[
      {
        label: 'Install',
        href: '#with-a-custom-link',
      },
    ]}
  />
)