@ownclouders/design-system
Version:
ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components
195 lines (194 loc) • 5.42 kB
TypeScript
/**
* Position any element in relation to another element.
*/
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
/**
* Id of the drop.
*/
dropId: {
type: StringConstructor;
required: false;
default: () => string;
};
/**
* Specifies custom Popper options
*/
popperOptions: {
type: ObjectConstructor;
required: false;
default: () => {};
};
/**
* CSS selector for the element to be used as toggle. By default, the preceding element is used.
**/
toggle: {
type: StringConstructor;
default: string;
};
/**
* The position of the drop: `(top|right|bottom|left|auto)|(top|right|bottom|left|auto)-(start|end)`.
**/
position: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
/**
* Events that cause the drop to show. Multiple event names are separated by spaces
*
* @values click, hover, manual
**/
mode: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
/**
* Defines if the drop should be closed after clicking on it. Needs to have defined dropId to work.
*/
closeOnClick: {
type: BooleanConstructor;
required: false;
};
/**
* Defines if the drop should be nested drop in another drop.
*/
isNested: {
type: BooleanConstructor;
required: false;
};
/**
* Element selector used as a target of the drop
*/
target: {
type: StringConstructor;
required: false;
default: any;
};
/**
* Defines the padding size around the drop content. Defaults to `medium`.
*
* @values xsmall, small, medium, large, xlarge, xxlarge, xxxlarge, remove
*/
paddingSize: {
type: StringConstructor;
required: false;
default: string;
validator: (value: unknown) => boolean;
};
/**
* Determines the offset of the drop element. The value can work on both axes by using a string in the form "x, y", such as "50, 20".
*/
offset: {
type: StringConstructor;
required: false;
default: any;
};
}>, {
drop: Readonly<import('vue').ShallowRef<HTMLElement>>;
tippy: import('vue').Ref<any, any>;
show: (duration?: number) => void;
hide: (duration?: number) => void;
onClick: () => void;
}, {}, {
triggerMapping(): string;
paddingClass(): string;
}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("hideDrop" | "showDrop")[], "hideDrop" | "showDrop", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
/**
* Id of the drop.
*/
dropId: {
type: StringConstructor;
required: false;
default: () => string;
};
/**
* Specifies custom Popper options
*/
popperOptions: {
type: ObjectConstructor;
required: false;
default: () => {};
};
/**
* CSS selector for the element to be used as toggle. By default, the preceding element is used.
**/
toggle: {
type: StringConstructor;
default: string;
};
/**
* The position of the drop: `(top|right|bottom|left|auto)|(top|right|bottom|left|auto)-(start|end)`.
**/
position: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
/**
* Events that cause the drop to show. Multiple event names are separated by spaces
*
* @values click, hover, manual
**/
mode: {
type: StringConstructor;
default: string;
validator: (value: string) => boolean;
};
/**
* Defines if the drop should be closed after clicking on it. Needs to have defined dropId to work.
*/
closeOnClick: {
type: BooleanConstructor;
required: false;
};
/**
* Defines if the drop should be nested drop in another drop.
*/
isNested: {
type: BooleanConstructor;
required: false;
};
/**
* Element selector used as a target of the drop
*/
target: {
type: StringConstructor;
required: false;
default: any;
};
/**
* Defines the padding size around the drop content. Defaults to `medium`.
*
* @values xsmall, small, medium, large, xlarge, xxlarge, xxxlarge, remove
*/
paddingSize: {
type: StringConstructor;
required: false;
default: string;
validator: (value: unknown) => boolean;
};
/**
* Determines the offset of the drop element. The value can work on both axes by using a string in the form "x, y", such as "50, 20".
*/
offset: {
type: StringConstructor;
required: false;
default: any;
};
}>> & Readonly<{
onHideDrop?: (...args: any[]) => any;
onShowDrop?: (...args: any[]) => any;
}>, {
target: string;
offset: string;
popperOptions: Record<string, any>;
toggle: string;
dropId: string;
position: string;
mode: string;
closeOnClick: boolean;
isNested: boolean;
paddingSize: string;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;