API reference
components/progress
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/progress";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | ProgressTone | Supported ProgressTone values. |
| type alias | ProgressProps | Props accepted by Progress. |
| type alias | GameMeterProps | A compact labelled resource meter for game windows. Values come from the game. |
| constant | Progress | A progress indicator for caller-provided progress values. |
| constant | GameMeter | Pair a game’s bounded resource value with its visible and accessible meter. |
ProgressTonetype alias
Section titled “ProgressTone”type ProgressTone = | "neutral" | "primary" | "secondary" | "accent" | "success" | "info" | "warning" | "error";Supported ProgressTone values.
ProgressPropstype alias
Section titled “ProgressProps”type ProgressProps = object & ProgressHTMLAttributes<HTMLProgressElement>;Props accepted by Progress.
Type Declaration
Section titled “Type Declaration”| Name | Type |
|---|---|
tone? |
ProgressTone |
GameMeterPropstype alias
Section titled “GameMeterProps”type GameMeterProps = Omit<HTMLAttributes<HTMLDivElement>, "children"> & object;A compact labelled resource meter for game windows. Values come from the game.
Type Declaration
Section titled “Type Declaration”| Name | Type |
|---|---|
label |
string |
value |
number |
max |
number |
tone? |
ProgressTone |
Progressconstant
Section titled “Progress”const Progress: ForwardRefExoticComponent< object & ProgressHTMLAttributes<HTMLProgressElement> & RefAttributes<HTMLProgressElement>>;A progress indicator for caller-provided progress values.
GameMeterconstant
Section titled “GameMeter”const GameMeter: ForwardRefExoticComponent< Omit<HTMLAttributes<HTMLDivElement>, "children"> & object & RefAttributes<HTMLDivElement>>;Pair a game’s bounded resource value with its visible and accessible meter.