@entur/menu 5.2.1-beta.8 → 5.2.1

package/dist/index.d.ts

@@ -1,11 +1,352 @@
-import './index.scss';
-export * from './BreadcrumbNavigation';
-export * from './BreadcrumbItem';
-export * from './CollapsibleSideNavigation';
-export * from './OverflowMenu';
-export * from './Pagination';
-export * from './SideNavigation';
-export * from './SideNavigationItem';
-export * from './SideNavigationGroup';
-export * from './Stepper';
-export * from './TopNavigationItem';
+import { default as default_2 } from 'react';
+
+declare type AsProp<C extends default_2.ElementType> = {
+    /**
+     * An override of the default HTML tag.
+     * Can also be another React component.
+     */
+    as?: C;
+};
+
+declare type BaseSideNavigationItemOwnProps = {
+    active?: boolean;
+    as?: 'a' | 'button' | default_2.ElementType;
+    className?: string;
+    icon?: default_2.ReactNode;
+    children: default_2.ReactNode;
+    subMenu?: default_2.ReactNode;
+    [key: string]: any;
+};
+
+export declare type BaseSideNavigationItemProps<T extends default_2.ElementType = typeof defaultElementBaseItem> = PolymorphicComponentProps<T, BaseSideNavigationItemOwnProps>;
+
+export declare const BreadcrumbItem: <E extends default_2.ElementType = "a">({ className, isCurrent, as, ...rest }: BreadcrumbItemProps<E>) => JSX.Element;
+
+export declare type BreadcrumbItemOwnProps = {
+    /** Komponenten som rendres
+     * @default "a"
+     */
+    as?: 'a' | default_2.ElementType;
+    /** Teksten som vises */
+    children: default_2.ReactNode;
+    /** Ekstra klassenavn */
+    className?: string;
+    /** True om sist i listen. Settes automatisk av BreadcrumbNavigation-komponenten */
+    isCurrent?: boolean;
+};
+
+export declare type BreadcrumbItemProps<T extends default_2.ElementType = typeof defaultElement> = PolymorphicComponentProps<T, BreadcrumbItemOwnProps>;
+
+export declare const BreadcrumbNavigation: default_2.FC<BreadcrumbNavigationProps>;
+
+export declare type BreadcrumbNavigationProps = {
+    /** Label for brødsmulestien.
+     * @default 'Brødsmulesti'
+     */
+    'aria-label'?: string;
+    /** En liste med BreadcrumbItem-er */
+    children: default_2.ReactElement[];
+};
+
+export declare const CollapsibleSideNavigation: default_2.FC<CollapsibleSideNavigationProps>;
+
+declare type CollapsibleSideNavigationProps = SideNavigationProps & {
+    /**Tilstand til menyen
+     * @default false
+     */
+    collapsed?: boolean;
+    /** Kalles når menyen åpnes eller lukkes  */
+    onCollapseToggle?: (e: any) => void;
+    /** Posisjonen til Collapsible-knappen, målt fra toppen (som CSS-enhet)
+     *  @default 50%
+     */
+    collapsibleButtonPosition?: string;
+    /** Aria-label for knappen som åpner menyen
+     * @default "Åpne sidemeny"
+     */
+    openSideMenuAriaLabel?: string;
+    /** Aria-label for knappen som lukker menyen
+     * @default "Lukk sidemeny"
+     */
+    closeSideMenuAriaLabel?: string;
+};
+
+declare const defaultElement = "a";
+
+declare const defaultElement_2 = "a";
+
+declare const defaultElementBaseItem = "a";
+
+declare const defaultElementItem = "a";
+
+/**
+ * Allows for extending a set of props (`ExtendedProps`) by an overriding set of props
+ * (`OverrideProps`), ensuring that any duplicates are overridden by the overriding
+ * set of props.
+ */
+declare type ExtendableProps<ExtendedProps = Record<string, unknown>, OverrideProps = Record<string, unknown>> = OverrideProps & Omit<ExtendedProps, keyof OverrideProps>;
+
+/**
+ * Allows for inheriting the props from the specified element type so that
+ * props like children, className & style work, as well as element-specific
+ * attributes like aria roles. The component (`C`) must be passed in.
+ */
+declare type InheritableElementProps<C extends default_2.ElementType, Props = Record<string, unknown>> = ExtendableProps<PropsOf<C>, Props>;
+
+declare type InternalMarker = {
+    __IS_ENTUR_MENU__: boolean;
+};
+
+export declare const OverflowMenu: ({ children, className, button, buttonIcon, placement, "aria-label": ariaLabel, ...rest }: OverflowMenuProps) => default_2.JSX.Element;
+
+export declare const OverflowMenuItem: <C extends default_2.ElementType = "button">({ children, className, onSelect, href, disabled, as, ...rest }: OverflowMenuItemProps<C>) => default_2.JSX.Element;
+
+declare type OverflowMenuItemBaseProps = {
+    /** Innholdet til OverflowMenuItem */
+    children: default_2.ReactNode;
+    /** Ekstra klassenavn */
+    className?: string;
+    /** Det som skjer når elementet er valgt, enten ved museklikk eller Enter-klikk */
+    onSelect?: () => void;
+    /** Lenke til siden brukeren skal sendes til.
+     *  Obs: kun én av onSelect og href skal brukes på ett element
+     */
+    href?: string;
+    /** Om dette valget skal være deaktivert */
+    disabled?: boolean;
+};
+
+export declare type OverflowMenuItemProps<C extends default_2.ElementType> = PolymorphicComponentProps<C, OverflowMenuItemBaseProps>;
+
+export declare const OverflowMenuLink: <C extends default_2.ElementType = "a">(props: OverflowMenuItemProps<C> & OverflowMenuLinkExtendedBaseProps) => default_2.JSX.Element;
+
+declare type OverflowMenuLinkExtendedBaseProps = {
+    /**
+     * @deprecated onSelect is no longer used
+     * in OverflowMenuLink, use 'href' instead */
+    onSelect?: () => void;
+};
+
+export declare type OverflowMenuProps = {
+    /** Menypunkter (OverflowMenuItem eller OverflowMenuLink) */
+    children: default_2.ReactNode;
+    buttonIcon?: default_2.ReactNode;
+    /** Knapp som skal åpne OverflowMenu
+     * @default IconButton med VerticalDotsIcon
+     */
+    button?: default_2.ReactElement;
+    /** Ekstra klassenavn */
+    className?: string;
+    /** Posisjoneringen av OverflowMenu-lista
+     * @default 'bottom-start'
+     */
+    placement?: Placement;
+    /**
+     * @deprecated Use placement insted.
+     * This is done to standardise the name of
+     * the relative position prop used in Entur
+     * designs sytstem components
+     */
+    position?: 'right' | 'left';
+    /** Tekst som beskriver knappen som åpner Overflow-menyen
+     * @default "åpne valgmeny"
+     */
+    'aria-label'?: string;
+};
+
+export declare const Pagination: default_2.FC<PaginationProps>;
+
+export declare type PaginationProps = {
+    /** Ekstra klassenavn */
+    className?: string;
+    /** Sidenummeret som er aktivt nå (1-indeksert) */
+    currentPage: number;
+    /** Callback for når man ønsker å gå til en ny side */
+    onPageChange: (requestedPage: number) => void;
+    /** Antall sider totalt */
+    pageCount: number;
+    /**
+     * Hva som blir lest opp når brukere av skjermlesere navigerer til "forrige side knappen"
+     * @default "Gå til forrige side"
+     */
+    previousPageLabel?: string;
+    /**
+     * Hva som blir lest opp når brukere av skjermlesere navigerer til "neste side knappen"
+     * @default "Gå til neste side"
+     */
+    nextPageLabel?: string;
+    /**
+     * Hva som blir lest opp når brukere av skjermlesere navigerer til "forrige side knappen"
+     * @default pageNumber => `Gå til side ${pageNumber}`,
+     */
+    pageLabel?: (pageNumber: number) => string;
+    /**
+     * @default "Nåværende side:"
+     */
+    currentPageLabelForScreenreader?: string;
+    /** Vis et felt til høyre for pagineringen hvor man kan angi siden man
+     * ønsker å vise i et tekstfelt.
+     *
+     * @default false
+     */
+    showInput?: boolean;
+    /** Label som vises til venstre for input-feltet som vises om `showInput` er true
+     * @default "Gå til side"
+     */
+    inputLabel?: string;
+    /** Hvor mange resultater man har totalt */
+    numberOfResults?: number;
+    /** Hvor mange resultater som vises per side */
+    resultsPerPage?: number;
+    /**
+     * @default [10,25,50]
+     */
+    resultsPerPageOptions?: number[];
+    /** Callback for når resultater per side oppdateres */
+    onResultsPerPageChange?: (e: number) => void;
+    /** Brukes for å skjule "neste side"-knappen
+     * @default false
+     */
+    hideNextButton?: boolean;
+    /** Brukes for å skjule "forrige side"-knappen
+     * @default false
+     */
+    hidePrevButton?: boolean;
+    /** Teksten som vises for hvilke resultater av sideantallet man viser.
+     * @default `Viser resultat ${minPage} - ${maxPage} av ${pageCount}`
+     */
+    showingResultsLabel?: (minPage: number, maxPage: number, pageCount: number) => string;
+    /** Teksten som vises før "resultsPerPage"-velgeren
+     * @default "Vis"
+     */
+    showNumberOfResultsLabel?: string;
+    [key: string]: any;
+};
+
+declare type Placement = 'top' | 'top-left' | 'top-start' | 'top-right' | 'top-end' | 'left' | 'right' | 'bottom-left' | 'bottom-start' | 'bottom' | 'bottom-right' | 'bottom-end';
+
+/**
+ * A more sophisticated version of `InheritableElementProps` where
+ * the passed in `as` prop will determine which props can be included
+ */
+declare type PolymorphicComponentProps<C extends default_2.ElementType, Props = Record<string, unknown>> = InheritableElementProps<C, Props & AsProp<C>>;
+
+declare type PropsOf<C extends keyof JSX.IntrinsicElements | default_2.JSXElementConstructor<any>> = JSX.LibraryManagedAttributes<C, default_2.ComponentPropsWithoutRef<C>>;
+
+export declare const SideNavigation: default_2.FC<SideNavigationProps> & InternalMarker;
+
+export declare const SideNavigationGroup: default_2.FC<SideNavigationGroupProps>;
+
+export declare type SideNavigationGroupProps = {
+    /** Skal menygruppen være ekspandert by default? Kun relevant om komponenten ikke er kontrollert
+     * @default false
+     */
+    defaultOpen?: boolean;
+    /** Er menyen åpen? */
+    open?: boolean;
+    /** Kalles når menygruppen åpnes eller lukkes */
+    onToggle?: (e?: boolean) => void;
+    /** Ekstra klassenavn */
+    className?: string;
+    /** Menyen som skal grupperes */
+    children: default_2.ReactNode;
+    /** Overskriften til menyen */
+    title: default_2.ReactNode;
+    icon?: default_2.ReactNode;
+    [key: string]: any;
+};
+
+export declare const SideNavigationItem: <E extends default_2.ElementType = typeof defaultElementItem>(props: SideNavigationItemProps<E>) => default_2.ReactElement | null;
+
+export declare type SideNavigationItemOwnProps = {
+    /** Om meny-elementet er det som er aktivt */
+    active?: boolean;
+    /** HTML-elementet eller React-komponenten som rendres */
+    as?: 'a' | 'button' | default_2.ElementType;
+    /** Ekstra klassenavn */
+    className?: string;
+    /** Om meny-elementet er deaktivert */
+    disabled?: boolean;
+    /** Callback for når man klikker på meny-elementet */
+    onClick?: (e: default_2.MouseEvent) => any;
+    /** Sett til true om du vil tvinge alle sub-menus til å rendre barna sine. Typisk for å vise søkeresultater */
+    forceExpandSubMenus?: boolean;
+    icon?: default_2.ReactNode;
+    [key: string]: any;
+};
+
+export declare type SideNavigationItemProps<T extends default_2.ElementType = typeof defaultElementItem> = PolymorphicComponentProps<T, SideNavigationItemOwnProps>;
+
+export declare type SideNavigationProps = {
+    /** Ekstra klassenavn */
+    className?: string;
+    /** Størrelse på menyen
+     * @default 'medium'
+     */
+    size?: 'small' | 'medium';
+    [key: string]: any;
+};
+
+export declare const Stepper: default_2.FC<StepperProps>;
+
+export declare type StepperProps = {
+    /** Liste med steg-navn i rekkefølge. */
+    steps: string[];
+    /** Det nåværende steget. 0-indeksert */
+    activeIndex: number;
+    /** Om stepperen skal være et interaktivt-navigasjonselement eller ikke
+     * @default false
+     */
+    interactive?: boolean;
+    /** Kalles med indeksen til det klikkede steget.
+     * Fungerer kun hvis Stepper-en er interaktiv */
+    onStepClick?: (index: number) => void;
+    /** Om stepper skal vise indeksering av hvilket trinn man er på
+     * @default true
+     */
+    showStepperIndex?: boolean;
+    /** Ekstra klassenavn. */
+    className?: string;
+    /** Skjermlesertekst for ordet 'steg' som i '_steg_ 1 av 3'
+     * @default 'Steg'
+     */
+    ariaLabelStep?: string;
+    /** Skjermlesertekst for ordet 'av' som i 'steg 1 _av_ 3'
+     * @defaul 'av'
+     */
+    ariaLabelOf?: string;
+    /** Skjermlesertekst for ordet fullført
+     * @default 'fullført'
+     */
+    ariaLabelCompleted?: string;
+    /** Skjermlesertekst for oppsummering av hele stepper-en
+     * @default `Stegindikator med ${steps.length} steg, du er på steg ${activeIndex + 1} ${steps[activeIndex]},`
+     */
+    ariaLabelSummary?: string;
+    [key: string]: any;
+};
+
+export declare const TopNavigationItem: <E extends default_2.ElementType = "a">({ active, className, as, ...rest }: TopNavigationItemProps<E>) => JSX.Element;
+
+export declare type TopNavigationItemOwnProps = {
+    /** Om komponenten vises som valgt eller ikke
+     * @default false
+     */
+    active?: boolean;
+    /** Tekste som vises */
+    children: default_2.ReactNode;
+    /** HTML-elementet eller React-komponenten som lager komponenten
+     * @default 'a'
+     */
+    as?: 'a' | default_2.ElementType;
+    /** Ekstra klassenavn */
+    className?: string;
+};
+
+export declare type TopNavigationItemProps<T extends default_2.ElementType = typeof defaultElement_2> = PolymorphicComponentProps<T, TopNavigationItemOwnProps>;
+
+export declare const useSideNavigationContext: () => {
+    isCollapsed: boolean;
+};
+
+export { }