@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
76 lines (75 loc) • 2.42 kB
TypeScript
import { NeonOrientation } from '@/model/common/layout/NeonOrientation';
/**
* Automatically handle horizontally overflowing content by placing it in a NeonSwiper component allowing for smooth
* horizontal scrolling with all input devices.
*/
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/**
* Display fade in / fade out styling when there is an overflow.
*/
fade: {
type: BooleanConstructor;
default: boolean;
};
/**
* Swiper orientation, i.e. whether to manage overflow horizontally or vertically.
*/
orientation: {
type: () => NeonOrientation;
default: NeonOrientation;
};
/**
* Hide the starting fade (left or top depending on the orientation).
*/
hideFadeStart: {
type: BooleanConstructor;
default: boolean;
};
/**
* Hide the ending fade (right or bottom depending on the orientation).
*/
hideFadeEnd: {
type: BooleanConstructor;
default: boolean;
};
}>, {
isOverflowing: import("vue").Ref<boolean, boolean>;
isScrollStart: import("vue").Ref<boolean, boolean>;
isScrollEnd: import("vue").Ref<boolean, boolean>;
scrollable: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Display fade in / fade out styling when there is an overflow.
*/
fade: {
type: BooleanConstructor;
default: boolean;
};
/**
* Swiper orientation, i.e. whether to manage overflow horizontally or vertically.
*/
orientation: {
type: () => NeonOrientation;
default: NeonOrientation;
};
/**
* Hide the starting fade (left or top depending on the orientation).
*/
hideFadeStart: {
type: BooleanConstructor;
default: boolean;
};
/**
* Hide the ending fade (right or bottom depending on the orientation).
*/
hideFadeEnd: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
orientation: NeonOrientation;
fade: boolean;
hideFadeStart: boolean;
hideFadeEnd: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;