@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
50 lines (49 loc) • 2.1 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes, ReactNode } from 'react';
import type { LogoBrand } from '../Logo';
export type HeaderProps = {
/** The name of the application. */
brandName?: string;
/** The name of the brand for which to display the logo. */
logoBrand?: LogoBrand;
/** The url for the link on the logo. */
logoLink?: string;
/** The accessible text for the link on the logo. */
logoLinkTitle?: string;
/** The text for the menu button. */
menuButtonText?: string;
/** A slot for the menu items. Use Header.MenuLink here. */
menuItems?: ReactNode;
/** The accessible label for the navigation section. */
navigationLabel?: string;
/** Whether the menu button is visible on wide screens. */
noMenuButtonOnWideWindow?: boolean;
} & HTMLAttributes<HTMLElement>;
export declare const Header: import("react").ForwardRefExoticComponent<{
/** The name of the application. */
brandName?: string;
/** The name of the brand for which to display the logo. */
logoBrand?: LogoBrand;
/** The url for the link on the logo. */
logoLink?: string;
/** The accessible text for the link on the logo. */
logoLinkTitle?: string;
/** The text for the menu button. */
menuButtonText?: string;
/** A slot for the menu items. Use Header.MenuLink here. */
menuItems?: ReactNode;
/** The accessible label for the navigation section. */
navigationLabel?: string;
/** Whether the menu button is visible on wide screens. */
noMenuButtonOnWideWindow?: boolean;
} & HTMLAttributes<HTMLElement> & import("react").RefAttributes<HTMLElement>> & {
GridCellNarrowWindowOnly: import("react").ForwardRefExoticComponent<import("..").GridCellProps & import("react").RefAttributes<HTMLElement>>;
MenuLink: import("react").ForwardRefExoticComponent<{
fixed?: boolean;
} & import("react").AnchorHTMLAttributes<HTMLAnchorElement> & {
children?: ReactNode | undefined;
} & import("react").RefAttributes<HTMLAnchorElement>>;
};