/**
 * Copyright 2021, SumUp Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { MouseEvent, KeyboardEvent, AnchorHTMLAttributes } from 'react';
import type { IconComponentType } from '@sumup-oss/icons';
import type { BadgeProps } from '../Badge/index.js';
import type { TierIndicatorProps } from '../TierIndicator/TierIndicator.js';
export interface PrimaryLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
    /**
     * Display an icon in addition to the text to help to identify the link.
     * On narrow viewports, only the icon is displayed.
     */
    icon: IconComponentType;
    /**
     * Display a different icon when the link is active.
     */
    activeIcon?: IconComponentType;
    /**
     * Short label to describe the target of the link.
     */
    label: string;
    /**
     * Function that's called when the link is clicked.
     */
    onClick?: (event: MouseEvent | KeyboardEvent) => void;
    /**
     * Whether the link is the currently active page.
     */
    isActive?: boolean;
    /**
     * Short label to describe that the link leads to an external page or opens in a new tab.
     */
    externalLabel?: string;
    /**
     * Whether to show a small circular badge to indicate that a nested secondary
     * link has a badge.
     */
    badge?: {
        /**
         * Choose the style variant.
         *
         * @default 'promo'
         */
        variant?: BadgeProps['variant'];
        /**
         * A clear and concise description of the badge's meaning.
         */
        children: string;
    };
    /**
     * A collection of secondary groups with nested secondary navigation links.
     */
    secondaryGroups?: SecondaryGroupProps[];
}
export interface SecondaryGroupProps {
    /**
     * A label that is displayed above the secondary navigation. Only optional
     * for the first group.
     */
    label?: string;
    /**
     * A collection of secondary navigation links.
     */
    secondaryLinks: SecondaryLinkProps[];
}
export interface SecondaryLinkProps {
    /**
     * Short label to describe the target of the link.
     */
    label: string;
    /**
     * A valid path or URL to the link target.
     */
    href: string;
    /**
     * Function that's called when the link is clicked.
     */
    onClick?: (event: MouseEvent | KeyboardEvent) => void;
    /**
     * Whether the link is the currently active page.
     */
    isActive?: boolean;
    /**
     * An optional badge to highlight the secondary link, e.g. to promote
     * a new link or to indicate new content.
     */
    badge?: BadgeProps;
    /**
     * An optional badge to highlight elements belonging to a specific tier.
     */
    tier?: Omit<TierIndicatorProps, 'size'>;
}