@synergy-design-system/vue
Version:
Vue3 wrappers for the Synergy Design System
68 lines (67 loc) • 3.02 kB
TypeScript
import { SynBurgerMenuClosedEvent, SynBurgerMenuHiddenEvent, SynBurgerMenuOpenEvent } from '@synergy-design-system/components';
import { default as SynHeader } from '@synergy-design-system/components/components/header/header.component.js';
export type { SynBurgerMenuClosedEvent } from '@synergy-design-system/components';
export type { SynBurgerMenuHiddenEvent } from '@synergy-design-system/components';
export type { SynBurgerMenuOpenEvent } from '@synergy-design-system/components';
declare const _default: typeof __VLS_export;
export default _default;
declare const __VLS_export: __VLS_WithSlots<import('vue').DefineComponent<{
/**
* The headers label.
* If you need to display HTML, use the `label` slot instead.
*/
label?: SynHeader["label"];
/**
* Defines the current visibility and icon of the burger-menu icon.
The menu button is added automatically if the component finds a syn-side-nav in
variant="default".
The following values can be used:
- hidden: The burger menu is not visible
- open: The burger menu is visible and shows the close icon
- closed: The burger menu is visible and shows the open icon
*/
burgerMenu?: SynHeader["burgerMenu"];
/**
* Makes the header stick to the top of the viewport when scrolling.
Also applies a shadow to the header when scrolling.
*/
sticky?: SynHeader["sticky"];
}, {
nativeElement: import('vue').Ref<SynHeader | undefined, SynHeader | undefined>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
"syn-burger-menu-closed": (e: SynBurgerMenuClosedEvent) => any;
"syn-burger-menu-hidden": (e: SynBurgerMenuHiddenEvent) => any;
"syn-burger-menu-open": (e: SynBurgerMenuOpenEvent) => any;
}, string, import('vue').PublicProps, Readonly<{
/**
* The headers label.
* If you need to display HTML, use the `label` slot instead.
*/
label?: SynHeader["label"];
/**
* Defines the current visibility and icon of the burger-menu icon.
The menu button is added automatically if the component finds a syn-side-nav in
variant="default".
The following values can be used:
- hidden: The burger menu is not visible
- open: The burger menu is visible and shows the close icon
- closed: The burger menu is visible and shows the open icon
*/
burgerMenu?: SynHeader["burgerMenu"];
/**
* Makes the header stick to the top of the viewport when scrolling.
Also applies a shadow to the header when scrolling.
*/
sticky?: SynHeader["sticky"];
}> & Readonly<{
"onSyn-burger-menu-closed"?: ((e: SynBurgerMenuClosedEvent) => any) | undefined;
"onSyn-burger-menu-hidden"?: ((e: SynBurgerMenuHiddenEvent) => any) | undefined;
"onSyn-burger-menu-open"?: ((e: SynBurgerMenuOpenEvent) => any) | undefined;
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>, {
default?: (props: {}) => any;
}>;
type __VLS_WithSlots<T, S> = T & {
new (): {
$slots: S;
};
};