@furystack/shades-common-components
Version:
Common UI components for FuryStack Shades
36 lines • 1.09 kB
TypeScript
/**
* Props for the DrawerToggleButton component.
*/
export type DrawerToggleButtonProps = {
/** Which drawer to toggle */
position: 'left' | 'right';
/** Button aria-label for accessibility. Default: 'Toggle drawer' */
ariaLabel?: string;
};
/**
* Default toggle button for collapsible drawers.
*
* Provides a hamburger menu icon that toggles the drawer open/closed
* via LayoutService. The icon animates between menu and close states.
*
* @example
* ```tsx
* // In AppBar
* <AppBar>
* <DrawerToggleButton position="left" />
* <Typography variant="h3">My App</Typography>
* </AppBar>
*
* // With custom aria-label
* <DrawerToggleButton
* position="left"
* ariaLabel="Toggle navigation menu"
* />
* ```
*/
export declare const DrawerToggleButton: (props: DrawerToggleButtonProps & Omit<Partial<HTMLElement>, "style"> & {
style?: Partial<CSSStyleDeclaration>;
} & {
ref?: import("@furystack/shades").RefObject<Element>;
}, children?: import("@furystack/shades").ChildrenList) => JSX.Element;
//# sourceMappingURL=drawer-toggle-button.d.ts.map