@wikimedia/codex
Version:
Codex Design System for Wikimedia
97 lines (96 loc) • 2.75 kB
TypeScript
/**
* A linear indicator of progress.
*
* Currently only supports indeterminate type (i.e. the bar will scroll across the width of the
* display and then reappear at the start, rather than reflecting a specific amount of progress
* having been made).
*
* A smaller, inline version is available for use within other components, e.g. a menu or dialog.
*/
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
value: {
type: (NumberConstructor | null)[];
default: null;
};
max: {
type: NumberConstructor;
default: number;
};
/**
* Whether this is the smaller, inline variant.
*/
inline: {
type: BooleanConstructor;
default: boolean;
};
/**
* Whether the progress bar is disabled.
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
startLabel: {
type: StringConstructor;
default: string;
};
endLabel: {
type: StringConstructor;
default: string;
};
}>, {
rootClasses: import("vue").ComputedRef<{
'cdx-progress-bar--block': boolean;
'cdx-progress-bar--inline': boolean;
'cdx-progress-bar--enabled': boolean;
'cdx-progress-bar--disabled': boolean;
}>;
computedAriaHidden: import("vue").ComputedRef<"true" | undefined>;
hasValue: import("vue").ComputedRef<boolean>;
progressStyles: import("vue").ComputedRef<{
'--cdx-progress-value': number;
'--cdx-progress-max': number;
}>;
clampedValue: import("vue").ComputedRef<number>;
labelsId: string;
ariaLabelledBy: import("vue").ComputedRef<string | undefined>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
value: {
type: (NumberConstructor | null)[];
default: null;
};
max: {
type: NumberConstructor;
default: number;
};
/**
* Whether this is the smaller, inline variant.
*/
inline: {
type: BooleanConstructor;
default: boolean;
};
/**
* Whether the progress bar is disabled.
*/
disabled: {
type: BooleanConstructor;
default: boolean;
};
startLabel: {
type: StringConstructor;
default: string;
};
endLabel: {
type: StringConstructor;
default: string;
};
}>> & Readonly<{}>, {
disabled: boolean;
value: number | null;
inline: boolean;
max: number;
startLabel: string;
endLabel: string;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;