import { FC, HTMLAttributes } from 'react';
type BannerProps = HTMLAttributes & {
/**
* Closable banner or not.
* @default true
*/
dismissible?: boolean;
/**
* Storage key to keep the banner state.
* @default 'nextra-banner'
*/
storageKey?: string;
};
/**
* A built-in component to show a banner on the top of the website. It can be used to show a warning
* or a notice.
*
* @example
* ### Banner key
*
* A banner can be dismissed. By default, it's used by
* [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
* to keep the banner state on the client.
*
* If you have updated your banner text, you should change the key to make sure the banner is shown
* again. The best practice is to always use a descriptive key for the current text, for example:
*
* 
*
* ```jsx filename="app/layout.jsx" {7-11}
* import { Layout } from 'my-nextra-theme'
* import { Banner } from 'nextra/components'
*
* export default function MyLayout({ children, ...props }) {
* return (
*
*
*
* 🎉 Nextra 2.0 is released. Read more →
*
*
* {children}
*
* )
* }
* ```
*/
declare const Banner: FC;
export { Banner };