progress

Documentation

Index

• type AriaProps
• type BarProps
• type ContainerProps
• type Props

Types

type AriaProps

type AriaProps struct {
	// AriaLabelledby - Optional.
	AriaLabelledby string
	// AriaLabel - Optional.
	AriaLabel string
	// AriaValuemin - Optional.
	AriaValuemin int
	// AriaValuenow - Optional.
	AriaValuenow int
	// AriaValuemax - Optional.
	AriaValuemax int
	// AriaValuetext - Optional.
	AriaValuetext string
}

type BarProps

type BarProps struct {
	// Children - What should be rendered inside progress bar. Optional.
	Children any //  // React.ReactNode
	// ClassName - Additional classes for Progres bar. Optional.
	ClassName string
	// Value - Actual progress value.
	Value int
	// ProgressBarAriaProps - Minimal value of progress. Optional.
	ProgressBarAriaProps any //  // AriaProps
}

type ContainerProps

type ContainerProps struct {
	// ProgressBarAriaProps - Properties needed for aria support. Optional.
	ProgressBarAriaProps any //  // AriaProps
	// ParentId - Progress component DOM ID.
	ParentId string
	// Title - Progress title. The isTitleTruncated property will only affect string titles. Node title truncation
	// must be handled manually. Optional.
	Title any //  // React.ReactNode
	// Label - Label to indicate what progress is showing. Optional.
	Label any //  // React.ReactNode
	// Variant - Type of progress status. Optional.
	Variant any //  /* "danger" | "success" | "warning" */
	// MeasureLocation - Location of progress value. Optional.
	MeasureLocation any //  /* "outside" | "inside" | "top" | "none" */
	// Value - Actual progress value.
	Value int
	// IsTitleTruncated - Whether string title should be truncated. Optional.
	IsTitleTruncated bool
	// TooltipPosition - Position of the tooltip which is displayed if title is truncated. Optional.
	TooltipPosition any //  /* any // TooltipPosition  | "auto" | "top" | "bottom" | "left" | "right" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end" | "right-start" | "right-end" */
}

type Props

type Props struct {
	// ClassName - Classname for progress component. Optional.
	ClassName string
	// Size - Size variant of progress. Optional.
	Size any //  /* "sm" | "md" | "lg" */
	// MeasureLocation - Where the measure percent will be located. Optional.
	MeasureLocation any //  /* "outside" | "inside" | "top" | "none" */
	// Variant - Status variant of progress. Optional.
	Variant any //  /* "danger" | "success" | "warning" */
	// Title - Title above progress. The isTitleTruncated property will only affect string titles. Node title
	// truncation must be handled manually. Optional.
	Title any //  // React.ReactNode
	// Label - Text description of current progress value to display instead of percentage. Optional.
	Label any //  // React.ReactNode
	// Value - Actual value of progress. Optional.
	Value int
	// Id - DOM id for progress component. Optional.
	Id string
	// Min - Minimal value of progress. Optional.
	Min int
	// Max - Maximum value of progress. Optional.
	Max int
	// ValueText - Accessible text description of current progress value, for when value is not a percentage.
	// Use with label. Optional.
	ValueText string
	// IsTitleTruncated - Indicate whether to truncate the string title. Optional.
	IsTitleTruncated bool
	// TooltipPosition - Position of the tooltip which is displayed if title is truncated. Optional.
	TooltipPosition any //  /* "auto" | "top" | "bottom" | "left" | "right" */
	// AriaLabel - Adds accessible text to the ProgressBar. Required when title not used and there is not any
	// label associated with the progress bar. Optional.
	AriaLabel string
	// AriaLabelledby - Associates the ProgressBar with it's label for accessibility purposes. Required when
	// title not used. Optional.
	AriaLabelledby string
}