@primer/react/dist/SideNav.d.ts

An implementation of GitHub's Primer Design System using React

import { ComponentProps as ComponentProps$1 } from "./utils/types/ComponentProps.js";
import { LinkProps } from "./Link/Link.js";
import React, { PropsWithChildren } from "react";
import { To } from "history";

//#region src/SideNav.d.ts
type SideNavBaseProps = {
  as?: React.ElementType;
  variant?: 'lightweight' | 'normal';
  bordered?: boolean;
  className?: string;
  children?: React.ReactNode;
  'aria-label'?: string;
};
declare function SideNav({
  as: Component,
  variant,
  className,
  bordered,
  children,
  'aria-label': ariaLabel
}: SideNavBaseProps): React.JSX.Element;
type StyledSideNavLinkProps = PropsWithChildren<{
  to?: To;
  selected?: boolean;
  variant?: 'full' | 'normal';
}> & LinkProps;
declare const SideNavLink: {
  ({
    selected,
    to,
    variant,
    className,
    children,
    ...rest
  }: StyledSideNavLinkProps): React.JSX.Element;
  displayName: string;
};
type SideNavProps = ComponentProps$1<typeof SideNav>;
type SideNavLinkProps = ComponentProps$1<typeof SideNavLink>;
/** @deprecated Use [NavList](https://primer.style/react/NavList) instead */
declare const _default: typeof SideNav & {
  Link: {
    ({
      selected,
      to,
      variant,
      className,
      children,
      ...rest
    }: StyledSideNavLinkProps): React.JSX.Element;
    displayName: string;
  };
};
//#endregion
export { SideNavLinkProps, SideNavProps, _default as default };