retro-react
Version:
A React component library for building retro-style websites
41 lines (40 loc) • 1.27 kB
TypeScript
import React from 'react';
import { ThemeUICSSObject } from 'theme-ui';
/**
* Properties for `Menu` component
*/
export interface MenuProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* Children elements, ideally MenuItem components.
*/
children?: React.ReactNode;
/**
* Theme-ui styling properties
*
* @example { backgroundColor: 'primary', ':hover': { backgroundColor: 'secondary' } }
*/
sx?: ThemeUICSSObject;
}
/**
* Properties for `MenuItem` component
*/
export interface MenuItemProps extends React.LiHTMLAttributes<HTMLLIElement> {
/**
* Theme-ui styling properties
*
* @example { backgroundColor: 'primary', ':hover': { backgroundColor: 'secondary' } }
*/
sx?: ThemeUICSSObject;
}
/**
* Menu component for displaying a list of items. Can be used for navigation or dropdowns. Uses the `Menu` and `MenuItem` components for implementation.
*
* @example
* <Menu>
* <MenuItem>Item 1</MenuItem>
* <MenuItem>Item 2</MenuItem>
* <MenuItem>Item 3</MenuItem>
* </Menu>
*/
export declare const Menu: React.ForwardRefExoticComponent<MenuProps & React.RefAttributes<HTMLDivElement>>;
export declare const MenuItem: React.FC<MenuItemProps>;