Files
documentation/node_modules/@docusaurus/theme-common/lib/contexts/docsSidebar.d.ts
2024-03-22 03:47:51 +05:30

26 lines
803 B
TypeScript

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import { type ReactNode } from 'react';
import type { PropSidebar } from '@docusaurus/plugin-content-docs';
type ContextValue = {
name: string;
items: PropSidebar;
};
/**
* Provide the current sidebar to your children.
*/
export declare function DocsSidebarProvider({ children, name, items, }: {
children: ReactNode;
name: string | undefined;
items: PropSidebar | undefined;
}): JSX.Element;
/**
* Gets the sidebar that's currently displayed, or `null` if there isn't one
*/
export declare function useDocsSidebar(): ContextValue | null;
export {};
//# sourceMappingURL=docsSidebar.d.ts.map