@atlaskit/navigation-system/dist/types/components/badge-container.d.ts

The latest navigation system for Atlassian apps.

/**
 * @jsxRuntime classic
 * @jsx jsx
 */
import type { ComponentType, ReactNode } from 'react';
type BadgeContainerProps = {
    id: string;
    badge: ComponentType;
    /**
     * The children to render inside the container that the badge overlays.
     */
    children: ReactNode;
    /**
     * Can be used to disable the default `listitem` role.
     *
     * As `BadgeContainer` is used internally to wrap `EndItem`, this prop is used to respect
     * the `isListItem` prop value set in `EndItem`.
     *
     * See the prop description in `EndItem` for more information.
     *
     * @default true
     */
    isListItem?: boolean;
};
/**
 * __Badge container__
 *
 * Adds a badge to the top right corner of the child element.
 * Example of usage is showing the number of notifications in the top navigation bar.
 */
export declare const BadgeContainer: (props: BadgeContainerProps) => JSX.Element;
export {};