@coreui/vue
Version:
UI Components Library for Vue.js
133 lines (132 loc) • 4.96 kB
TypeScript
declare const CBadge: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
/**
* Component used for the root node. Either a string to use a HTML element or a component.
*/
as: {
type: StringConstructor;
default: string;
};
/**
* Sets the color context of the component to one of CoreUI’s themed colors.
*
* @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light'
*/
color: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Position badge in one of the corners of a link or button.
*
* @values 'top-start', 'top-end', 'bottom-end', 'bottom-start'
*/
position: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Select the shape of the component.
*
* @values 'rounded', 'rounded-top', 'rounded-end', 'rounded-bottom', 'rounded-start', 'rounded-circle', 'rounded-pill', 'rounded-0', 'rounded-1', 'rounded-2', 'rounded-3'
*/
shape: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Size the component small.
*
* @values 'sm'
*/
size: {
type: StringConstructor;
validator: (value: string) => value is "sm";
};
/**
* Sets the component's color scheme to one of CoreUI's themed colors, ensuring the text color contrast adheres to the WCAG 4.5:1 contrast ratio standard for accessibility.
*
* @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light'
* @since 5.0.0
*/
textBgColor: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Sets the text color of the component to one of CoreUI’s themed colors.
*
* @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light', 'primary-emphasis', 'secondary-emphasis', 'success-emphasis', 'danger-emphasis', 'warning-emphasis', 'info-emphasis', 'light-emphasis', 'body', 'body-emphasis', 'body-secondary', 'body-tertiary', 'black', 'black-50', 'white', 'white-50'
*/
textColor: {
type: StringConstructor;
validator: (value: string) => boolean;
};
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
[key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
/**
* Component used for the root node. Either a string to use a HTML element or a component.
*/
as: {
type: StringConstructor;
default: string;
};
/**
* Sets the color context of the component to one of CoreUI’s themed colors.
*
* @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light'
*/
color: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Position badge in one of the corners of a link or button.
*
* @values 'top-start', 'top-end', 'bottom-end', 'bottom-start'
*/
position: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Select the shape of the component.
*
* @values 'rounded', 'rounded-top', 'rounded-end', 'rounded-bottom', 'rounded-start', 'rounded-circle', 'rounded-pill', 'rounded-0', 'rounded-1', 'rounded-2', 'rounded-3'
*/
shape: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Size the component small.
*
* @values 'sm'
*/
size: {
type: StringConstructor;
validator: (value: string) => value is "sm";
};
/**
* Sets the component's color scheme to one of CoreUI's themed colors, ensuring the text color contrast adheres to the WCAG 4.5:1 contrast ratio standard for accessibility.
*
* @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light'
* @since 5.0.0
*/
textBgColor: {
type: StringConstructor;
validator: (value: string) => boolean;
};
/**
* Sets the text color of the component to one of CoreUI’s themed colors.
*
* @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light', 'primary-emphasis', 'secondary-emphasis', 'success-emphasis', 'danger-emphasis', 'warning-emphasis', 'info-emphasis', 'light-emphasis', 'body', 'body-emphasis', 'body-secondary', 'body-tertiary', 'black', 'black-50', 'white', 'white-50'
*/
textColor: {
type: StringConstructor;
validator: (value: string) => boolean;
};
}>> & Readonly<{}>, {
as: string;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export { CBadge };