import type { FC, PropsWithChildren } from "react"; import type { SidebarLocale, SidebarLocation, SidebarVariant } from "./types"; export type SidebarProps = PropsWithChildren<{ /** * The ID of the `Sidebar`. */ id?: string; /** @ignore */ className?: string; /** * Used for accessibility reasons, this label should be unique. */ label?: string; /** * The locale object to override the default locale. */ locale?: SidebarLocale; /** * Define whether the sidebar should be collapsed. */ collapsed?: boolean; /** * As the name of the variants imply, * - `primary` should be used for your first level of navigation * - `secondary` should be used for your second level of navigation */ variant?: SidebarVariant; /** * Used to determine whether a link should be highlighted as "active" * Ideally only one link should be shown as active at any given time. * * @example with a location of /foo/bar * isLinkActive('/foo', location) // returns true * * @example with a location of /bar * isLinkActive('/foo', location) // returns false * */ isLinkActive?: (href: string, location: SidebarLocation) => boolean; /** * `location` is used in conjunction with `isLinkActive` to display active links properly. * It is injected from outside so that it can work with different router libraries and * re-render when necessary. */ location: SidebarLocation; }>; /** * The `Sidebar` component is used to display a sidebar of links. * * See the [Sidebar documentation page](https://satellite.algolia.com/8261d6576/p/52150e-sidebar) for more information. */ export declare const Sidebar: FC;