@atlaskit/side-navigation/dist/types/components/Section/section.d.ts

A highly composable side navigation component that supports nested views.

import React from 'react';
/**
 * @deprecated `@atlaskit/side-navigation` is deprecated. Use `@atlaskit/navigation-system` instead.
 */
export interface SectionProps {
    /**
     * The children of the section.
     * These should generally be item or heading components.
     */
    children: React.ReactNode;
    /**
     * The text passed to heading.
     * If you don't provide a title, then the heading won't be rendered.
     */
    title?: string;
    /**
     * This will render a border at the top of the section.
     */
    hasSeparator?: boolean;
    /**
     * A `testId` prop is provided for specified elements,
     * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
     * serving as a hook for automated tests.
     */
    testId?: string;
    /**
     * Adds `<ul>` and `<li>` tags around the items for better semantic markup in a list of items.
     *
     */
    isList?: boolean;
}
/**
 * __Section__
 *
 * Used to separate items into sections. Using the title prop makes a section
 * implicitly group the items for screen readers with no additional work required.
 *
 * - [Examples](https://atlassian.design/components/side-navigation/examples#section)
 * - [Code](https://atlassian.design/components/side-navigation/code)
 *
 * @deprecated `@atlaskit/side-navigation` is deprecated. Use `@atlaskit/navigation-system` instead.
 */
export declare const Section: React.ForwardRefExoticComponent<React.PropsWithoutRef<SectionProps> & React.RefAttributes<HTMLElement>>;