mirror of
https://github.com/carbon-design-system/carbon-components-svelte.git
synced 2025-09-15 02:11:05 +00:00
breaking(ui-shell): remove GlobalHeader, SideNav folders (#1223)
* breaking(ui-shell): remove GlobalHeader/SideNav folders * Run "yarn build:docs"
This commit is contained in:
parent
d34f571150
commit
62735d6275
34 changed files with 56 additions and 56 deletions
86
types/UIShell/Header.svelte.d.ts
vendored
Normal file
86
types/UIShell/Header.svelte.d.ts
vendored
Normal file
|
@ -0,0 +1,86 @@
|
|||
/// <reference types="svelte" />
|
||||
import { SvelteComponentTyped } from "svelte";
|
||||
|
||||
export interface HeaderProps
|
||||
extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap["a"]> {
|
||||
/**
|
||||
* Set to `false` to hide the side nav by default
|
||||
* @default true
|
||||
*/
|
||||
expandedByDefault?: boolean;
|
||||
|
||||
/**
|
||||
* Set to `true` to open the side nav
|
||||
* @default false
|
||||
*/
|
||||
isSideNavOpen?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the ARIA label for the header
|
||||
* @default undefined
|
||||
*/
|
||||
uiShellAriaLabel?: string;
|
||||
|
||||
/**
|
||||
* Specify the `href` attribute
|
||||
* @default undefined
|
||||
*/
|
||||
href?: string;
|
||||
|
||||
/**
|
||||
* Specify the company name
|
||||
* @default undefined
|
||||
*/
|
||||
company?: string;
|
||||
|
||||
/**
|
||||
* Specify the platform name
|
||||
* Alternatively, use the named slot "platform" (e.g., <span slot="platform">...</span>)
|
||||
* @default ""
|
||||
*/
|
||||
platformName?: string;
|
||||
|
||||
/**
|
||||
* Set to `true` to persist the hamburger menu
|
||||
* @default false
|
||||
*/
|
||||
persistentHamburgerMenu?: 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;
|
||||
|
||||
/**
|
||||
* Obtain a reference to the HTML anchor element
|
||||
* @default null
|
||||
*/
|
||||
ref?: null | HTMLAnchorElement;
|
||||
|
||||
/**
|
||||
* Specify the icon to render for the closed state
|
||||
* Defaults to `Menu20`
|
||||
* @default undefined
|
||||
*/
|
||||
iconMenu?: typeof import("svelte").SvelteComponent;
|
||||
|
||||
/**
|
||||
* Specify the icon to render for the opened state
|
||||
* Defaults to `Close20`
|
||||
* @default undefined
|
||||
*/
|
||||
iconClose?: typeof import("svelte").SvelteComponent;
|
||||
}
|
||||
|
||||
export default class Header extends SvelteComponentTyped<
|
||||
HeaderProps,
|
||||
{ click: WindowEventMap["click"] },
|
||||
{ default: {}; platform: {}; ["skip-to-content"]: {} }
|
||||
> {}
|
Loading…
Add table
Add a link
Reference in a new issue