ProgressIndicators

@shopify/shop-minis-platform-sdk / components/ProgressIndicators

ProgressIndicatorsProps

Properties

currentStep

currentStep: number

Current (or active) progess indicator.

Example

<ProgressIndicatorsProps {...} currentStep={5} />

numberOfIndicators

numberOfIndicators: number

Number of progress indicators to display.

Example

<ProgressIndicatorsProps {...} numberOfIndicators={10} />

progress

progress: SharedValue\<number>

Sets the progress of the currentStep being displayed.

Example

const progress = useSharedValue(0)
<ProgressIndicatorsProps {...} progress={progress} />

width?

optional width: DimensionValue

Sets the width of this component.

Deprecated

This parameter is optional (taking the width of the parent's container) and it will be removed in the next version of the SDK

Example

<ProgressIndicatorsProps {...} width={300} />
<ProgressIndicatorsProps {...} width="100%" />

---

ProgressIndicators()

ProgressIndicators(__namedParameters): Element

Parameters

Parameter	Type
__namedParameters	ProgressIndicatorsProps

Returns

Element