% Auto-generated: do not edit by hand
\name{scrollspy}

\alias{scrollspy}

\title{Scrollspy component}

\description{
Component for building in-page navigation menus with scrollspy functionality
}

\usage{
scrollspy(activeClassName=NULL, menuClassName=NULL,
menuGroupLabelClassName=NULL, menuGroups=NULL,
menuItemClassName=NULL, menuItemContainerClassName=NULL,
offset=NULL)
}

\arguments{
\item{activeClassName}{Character. Class name applied to active links in the menu (default: 'is-active')}

\item{menuClassName}{Character. Class name applied to the <aside> that contains the whole menu (default: 'menu')}

\item{menuGroupLabelClassName}{Character. Class name applied to all menu group labels (default: 'menu-label')}

\item{menuGroups}{Unnamed list. An array of MenuGroup items that is used to build the menu and its links.
Each MenuGroup has an optional label and a required 'items' array of MenuItems.
Each MenuItem has a label that is rendered in the menu and a targetId that is the id of the element it should link to.
Do not include '#' in targetId.
example:
      [
        {label: '...', items: [
          {label: '...', targetId: '...'}, 
          {label: '...', targetId: '...', items: [
            {label: '...', targetId: '...'}
          }]
        ]}
      ]}

\item{menuItemClassName}{Character. Class name applied to the <li> of each menu item (default: '')}

\item{menuItemContainerClassName}{Character. Class name applied to each <ul> of menu items (default: 'menu-list')}

\item{offset}{Numeric. An integer to determine the scroll offset from an item that will trigger it active (default: -20)}
}

\value{named list of JSON elements corresponding to React.js properties and their values}