@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
98 lines (97 loc) • 3.32 kB
TypeScript
import { NeonOrientation } from '@/model/common/layout/NeonOrientation';
import { NeonResponsive } from '@/model/common/responsive/NeonResponsive';
import { NeonSize } from '@/model/common/size/NeonSize';
/**
* Card component used for the layout of content within a grid or page.
*/
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/**
* Change the orientation of a card to horizontal. This is useful for creating long narrow cards spanning the full
* page. NOTE: For responsiveness, horizontal cards are automatically transformed to vertical cards at lower screen
* sizes.
*/
orientation: {
type: () => NeonOrientation;
default: NeonOrientation;
};
/**
* The size of the card, this only adjusts the padding where more compact cards are required.
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* Whether to display the internal borders between card sections for horizontal cards
*/
horizontalBorders: {
type: BooleanConstructor;
default: boolean;
};
/**
* The breakpoint to switch horizontal cards to vertical cards. Accepts <em>Mobile | MobileLarge | Tablet</em> ONLY.
* @type NeonResponsive
*/
horizontalBreakpoint: {
type: () => NeonResponsive;
default: NeonResponsive;
};
/**
* If true, do not implement a responsive breakpoint for a horizontal card.
*/
noBreak: {
type: BooleanConstructor;
default: boolean;
};
}>, {
attrs: {
[x: string]: unknown;
};
NeonOrientation: typeof NeonOrientation;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Change the orientation of a card to horizontal. This is useful for creating long narrow cards spanning the full
* page. NOTE: For responsiveness, horizontal cards are automatically transformed to vertical cards at lower screen
* sizes.
*/
orientation: {
type: () => NeonOrientation;
default: NeonOrientation;
};
/**
* The size of the card, this only adjusts the padding where more compact cards are required.
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* Whether to display the internal borders between card sections for horizontal cards
*/
horizontalBorders: {
type: BooleanConstructor;
default: boolean;
};
/**
* The breakpoint to switch horizontal cards to vertical cards. Accepts <em>Mobile | MobileLarge | Tablet</em> ONLY.
* @type NeonResponsive
*/
horizontalBreakpoint: {
type: () => NeonResponsive;
default: NeonResponsive;
};
/**
* If true, do not implement a responsive breakpoint for a horizontal card.
*/
noBreak: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
size: NeonSize;
orientation: NeonOrientation;
horizontalBorders: boolean;
horizontalBreakpoint: NeonResponsive;
noBreak: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;