@aotearoan/neon
Version:
Neon is a lightweight design library of Vue 3 components with minimal dependencies.
184 lines (183 loc) • 5.02 kB
TypeScript
import { NeonFunctionalColor } from '@/common/enums/NeonFunctionalColor';
import { NeonSize } from '@/common/enums/NeonSize';
/**
* A component for displaying linear progress. The progress can be displayed as a percentage (default) or
* as a counter (x / y).
*/
declare const _default: import("vue").DefineComponent<{
/**
* If no total is provided (default) the current % completion is expressed as a %, e.g. 0.15 = 15%,
* In the case of a total being provided this is the count of items from the total, i.e. the 'x' in 'x / y '.
*/
modelValue: {
type: NumberConstructor;
required: true;
};
/**
* When the total is provided the display is 'x / y' where total is the 'y' in 'x / y'.
*/
total: {
type: NumberConstructor;
default: null;
};
/**
* A label to display above the progress bar
*/
label: {
type: StringConstructor;
default: null;
};
/**
* The progress bar color
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* The alternate color for displaying the progress as a gradient
*/
alternateColor: {
type: () => NeonFunctionalColor;
default: null;
};
/**
* The component size, NeonSize.Small or NeonSize.Medium
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* The locale used for display purposes. This defaults to the browser's locale if none is provided.
*/
locale: {
type: StringConstructor;
default: null;
};
/**
* Display the text output indicating the current state of progress
*/
output: {
type: BooleanConstructor;
default: boolean;
};
/**
* Display an icon on completion
*/
completedIcon: {
type: StringConstructor;
default: null;
};
/**
* Specify the icon color (default = alternate-color || color)
*/
completedIconColor: {
type: () => NeonFunctionalColor;
default: null;
};
/**
* The decimals to use for rounding
*/
decimals: {
type: NumberConstructor;
default: number;
};
}, {
calculatedValue: import("vue").Ref<number>;
computedTotal: import("vue").ComputedRef<number>;
completed: import("vue").ComputedRef<boolean>;
computedOutput: import("vue").ComputedRef<string>;
computedPercentage: import("vue").ComputedRef<number>;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
/**
* If no total is provided (default) the current % completion is expressed as a %, e.g. 0.15 = 15%,
* In the case of a total being provided this is the count of items from the total, i.e. the 'x' in 'x / y '.
*/
modelValue: {
type: NumberConstructor;
required: true;
};
/**
* When the total is provided the display is 'x / y' where total is the 'y' in 'x / y'.
*/
total: {
type: NumberConstructor;
default: null;
};
/**
* A label to display above the progress bar
*/
label: {
type: StringConstructor;
default: null;
};
/**
* The progress bar color
*/
color: {
type: () => NeonFunctionalColor;
default: NeonFunctionalColor;
};
/**
* The alternate color for displaying the progress as a gradient
*/
alternateColor: {
type: () => NeonFunctionalColor;
default: null;
};
/**
* The component size, NeonSize.Small or NeonSize.Medium
*/
size: {
type: () => NeonSize;
default: NeonSize;
};
/**
* The locale used for display purposes. This defaults to the browser's locale if none is provided.
*/
locale: {
type: StringConstructor;
default: null;
};
/**
* Display the text output indicating the current state of progress
*/
output: {
type: BooleanConstructor;
default: boolean;
};
/**
* Display an icon on completion
*/
completedIcon: {
type: StringConstructor;
default: null;
};
/**
* Specify the icon color (default = alternate-color || color)
*/
completedIconColor: {
type: () => NeonFunctionalColor;
default: null;
};
/**
* The decimals to use for rounding
*/
decimals: {
type: NumberConstructor;
default: number;
};
}>>, {
label: string;
decimals: number;
locale: string;
total: number;
size: NeonSize;
color: NeonFunctionalColor;
output: boolean;
alternateColor: NeonFunctionalColor;
completedIcon: string;
completedIconColor: NeonFunctionalColor;
}, {}>;
export default _default;