@astra-kit/ui 1.0.0 → 1.2.1

package/dist/components/usage-meter.d.ts

@@ -0,0 +1,39 @@
+import type { ComponentProps } from "react";
+import type { UsageMeterCopyValues, UsageMeterMessages, UsageMeterStatus } from "../constants/usage-meter.js";
+export type { UsageMeterCopyValues, UsageMeterMessages, UsageMeterStatus };
+export type UsageMeterSegment = {
+    /** Stable identity. Keep it while the value changes, so the segment re-flows instead of being replaced. */
+    id: string;
+    label: string;
+    /** Used amount, in the same unit as the limit. */
+    value: number;
+};
+export type UsageMeterProps = Omit<ComponentProps<"div">, "children"> & {
+    /** What is measured, such as "Códigos enviados hoy". */
+    label: string;
+    /** Used amounts in display order. Keep ids stable so segments re-flow. Up to four read clearly. */
+    segments: UsageMeterSegment[];
+    /** The plan limit, in the same unit as the segments. */
+    limit: number;
+    /** Unit shown after numbers, such as "GB". */
+    unit?: string;
+    /** Digits after the decimal separator. Defaults to 1. */
+    decimals?: number;
+    /** Legend label of the remaining space. Defaults to "Libre". */
+    freeLabel?: string;
+    /** Legend label of the overage. Defaults to "Excedente". */
+    overLabel?: string;
+    /** Share of the limit at which the badge warns that it is almost full. Defaults to 0.9. */
+    warnAt?: number;
+    /** Replaces any of the Spanish captions, badges and announcements. */
+    messages?: Partial<UsageMeterMessages>;
+    /** Locale of the numbers' separators. Defaults to `"es-AR"`. */
+    locale?: string;
+};
+/**
+ * A segmented bar showing what uses a fixed allowance, with a rolling total, a status badge and an interactive legend.
+ * @param props - Label, segments, limit, unit, legend labels, copy overrides and native div attributes.
+ * @returns The usage meter.
+ */
+declare function UsageMeter({ label, segments: rawSegments, limit, unit, decimals, freeLabel, overLabel, warnAt, messages, locale, className, ...props }: UsageMeterProps): import("react").JSX.Element;
+export { UsageMeter };