@coreui/vue
Version:
UI Components Library for Vue.js
119 lines (118 loc) • 3.65 kB
TypeScript
import { VNode } from 'vue';
declare const CCarousel: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/**
* Adding in the previous and next controls.
*/
controls: BooleanConstructor;
/**
* Add darker controls, indicators, and captions.
*/
dark: BooleanConstructor;
/**
* index of the active item.
*/
index: {
type: NumberConstructor;
default: number;
};
/**
* Adding indicators at the bottom of the carousel for each item.
*/
indicators: BooleanConstructor;
/**
* The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
*/
interval: {
type: (NumberConstructor | BooleanConstructor)[];
default: number;
};
/**
* If set to 'hover', pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to false, hovering over the carousel won't pause it.
*/
pause: {
type: (StringConstructor | BooleanConstructor)[];
default: string;
validator: (value: boolean | string) => value is boolean | "hover";
};
/**
* Set type of the transition.
*
* @values 'crossfade', 'slide'
*/
transition: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
/**
* Set whether the carousel should cycle continuously or have hard stops.
*/
wrap: {
type: BooleanConstructor;
default: boolean;
};
}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Adding in the previous and next controls.
*/
controls: BooleanConstructor;
/**
* Add darker controls, indicators, and captions.
*/
dark: BooleanConstructor;
/**
* index of the active item.
*/
index: {
type: NumberConstructor;
default: number;
};
/**
* Adding indicators at the bottom of the carousel for each item.
*/
indicators: BooleanConstructor;
/**
* The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
*/
interval: {
type: (NumberConstructor | BooleanConstructor)[];
default: number;
};
/**
* If set to 'hover', pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to false, hovering over the carousel won't pause it.
*/
pause: {
type: (StringConstructor | BooleanConstructor)[];
default: string;
validator: (value: boolean | string) => value is boolean | "hover";
};
/**
* Set type of the transition.
*
* @values 'crossfade', 'slide'
*/
transition: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
/**
* Set whether the carousel should cycle continuously or have hard stops.
*/
wrap: {
type: BooleanConstructor;
default: boolean;
};
}>> & Readonly<{}>, {
pause: string | boolean;
transition: string;
dark: boolean;
controls: boolean;
indicators: boolean;
index: number;
interval: number | boolean;
wrap: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export { CCarousel };