chore(types): fix formatting of prop comments in Header, SideNav

This commit is contained in:
Eric Liu 2023-07-13 10:52:52 -07:00
commit 7885e124b4
6 changed files with 51 additions and 51 deletions

View file

@ -35,8 +35,8 @@ export interface HeaderProps
company?: string;
/**
* Specify the platform name
* Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>)
* Specify the platform name.
* Alternatively, use the named slot "platform" (e.g., `<span slot="platform">...</span>`)
* @default ""
*/
platformName?: string;
@ -48,13 +48,13 @@ export interface HeaderProps
persistentHamburgerMenu?: boolean;
/**
* The window width (px) at which the SideNav is expanded and the hamburger menu is hidden
* 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
* - small: 320
* - medium: 672
* - large: 1056
* - x-large: 1312
* - max: 1584
* @default 1056
*/
expansionBreakpoint?: number;