ProgressProps
interface exported by @mwillbanks/tuil-ink.
interface
Public interface exported by @mwillbanks/tuil-ink.
export interface ProgressProps
extends CommonComponentProps,
SlottedComponentProps<
ProgressSlots,
{ readonly percent: number; readonly complete: boolean }
> {
readonly value: number;
readonly max?: number;
readonly width?: number;
readonly showValue?: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
value | number | Yes | The value member uses the number contract. | — |
max | number | undefined | No | The max member uses the number | undefined contract. | — |
width | number | undefined | No | The width member uses the number | undefined contract. | — |
showValue | boolean | undefined | No | The showValue member uses the boolean | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
layout | Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined | No | The layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract. | — |
id | string | undefined | No | The id member uses the string | undefined contract. | — |
testId | string | undefined | No | The testId member uses the string | undefined contract. | — |
role | SemanticRole | undefined | No | The role member uses the SemanticRole | undefined contract. | SemanticRole |
label | string | undefined | No | The label member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
disabled | boolean | undefined | No | The disabled member uses the boolean | undefined contract. | — |
readOnly | boolean | undefined | No | The readOnly member uses the boolean | undefined contract. | — |
selected | boolean | undefined | No | The selected member uses the boolean | undefined contract. | — |
checked | boolean | undefined | No | The checked member uses the boolean | undefined contract. | — |
expanded | boolean | undefined | No | The expanded member uses the boolean | undefined contract. | — |
valueText | string | undefined | No | The valueText member uses the string | undefined contract. | — |
slots | Partial<SlotComponents<{ root: import("@mwillbanks/tuil-ink").TextProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import("@mwillbanks/tuil-ink").TextProps; }>> | undefined contract. | SlotComponents, TextProps |
slotProps | Partial<SlotProps<{ root: import("@mwillbanks/tuil-ink").TextProps; }, { readonly percent: number; readonly complete: boolean; }>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import("@mwillbanks/tuil-ink").TextProps; }, { readonly percent: number; readonly complete: boolean; }>> | undefined contract. | SlotProps, TextProps |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference