mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
53 lines
1.1 KiB
TypeScript
53 lines
1.1 KiB
TypeScript
/// <reference types="svelte" />
|
|
import type { SvelteComponentTyped } from "svelte";
|
|
|
|
export interface SideNavProps
|
|
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["nav"]> {
|
|
/**
|
|
* Set to `true` to use the fixed variant
|
|
* @default false
|
|
*/
|
|
fixed?: boolean;
|
|
|
|
/**
|
|
* Set to `true` to use the rail variant
|
|
* @default false
|
|
*/
|
|
rail?: boolean;
|
|
|
|
/**
|
|
* Specify the ARIA label for the nav
|
|
* @default undefined
|
|
*/
|
|
ariaLabel?: string;
|
|
|
|
/**
|
|
* Set to `true` to toggle the expanded state
|
|
* @default false
|
|
*/
|
|
isOpen?: boolean;
|
|
|
|
/**
|
|
* The window width (px) at which the SideNav is expanded and the hamburger menu is hidden.
|
|
* 1056 represents the "large" breakpoint in pixels from the Carbon Design System:
|
|
* - small: 320
|
|
* - medium: 672
|
|
* - large: 1056
|
|
* - x-large: 1312
|
|
* - max: 1584
|
|
* @default 1056
|
|
*/
|
|
expansionBreakpoint?: number;
|
|
|
|
[key: `data-${string}`]: any;
|
|
}
|
|
|
|
export default class SideNav extends SvelteComponentTyped<
|
|
SideNavProps,
|
|
{
|
|
open: CustomEvent<null>;
|
|
close: CustomEvent<null>;
|
|
["click:overlay"]: CustomEvent<null>;
|
|
},
|
|
{ default: {} }
|
|
> {}
|