@kelvininc/ui-components/docs/components/step-progress-bar/readme.md

Kelvin UI Components

<!-- Auto Generated Below -->


## Usage

### React

```tsx
import React from 'react';

import { KvStepProgressBar } from '@kelvininc/react-ui-components/client';

export const StepProgressBarExample: React.FC = () => (
	<>
		{/*-- Default --*/}
		<KvStepProgressBar progressPercentage={50}>
			<KvStepIndicator active></KvStepIndicator>
			<KvStepIndicator active></KvStepIndicator>
			<KvStepIndicator></KvStepIndicator>
		</KvStepProgressBar>
		{/*-- Has errors --*/}
		<KvStepProgressBar progressPercentage={50} hasError>
			<KvStepIndicator active hasError></KvStepIndicator>
			<KvStepIndicator active hasError></KvStepIndicator>
			<KvStepIndicator></KvStepIndicator>
		</KvStepProgressBar>
	</>
);
```



## Properties

| Property                          | Attribute             | Description                                                                                                                              | Type      | Default     |
| --------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
| `hasError`                        | `has-error`           | (optional) Defines if the bar should be in an error state, setting to `true` will change the background color to the defined error color | `boolean` | `undefined` |
| `progressPercentage` _(required)_ | `progress-percentage` | (required) Defines how much space the progress bar should fill                                                                           | `number`  | `undefined` |


## CSS Custom Properties

| Name                                  | Description                                         |
| ------------------------------------- | --------------------------------------------------- |
| `--progress-bar-background-color`     | The color of the progress bar container.            |
| `--progress-bar-filler-error-color`   | The color of the progress bar filler when in error. |
| `--progress-bar-filler-success-color` | The color of the progress bar filler.               |
| `--progress-bar-height`               | The height of the progress bar.                     |
| `--progress-height`                   | The overall height of the progress bar container.   |


## Dependencies

### Used by

 - [kv-step-bar](../step-bar)

### Graph
```mermaid
graph TD;
  kv-step-bar --> kv-step-progress-bar
  style kv-step-progress-bar fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------