# Progress

Source: /tuil/docs/reference/packages/ink/api/progress
Locale: en

function exported by @mwillbanks/tuil-ink.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-ink`.

```ts
export function Progress({
  value,
  max = 100,
  width = 20,
  showValue = true,
  slots,
  slotProps,
  ...props
}: ProgressProps): ReactNode;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member                                                                                                   | Type            | Required | Description                                                                                                                                     | Related types                                                      |
| -------------------------------------------------------------------------------------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `{   value,   max = 100,   width = 20,   showValue = true,   slots,   slotProps,   ...props }` | `ProgressProps` | Yes      | Supplies the `{   value,   max = 100,   width = 20,   showValue = true,   slots,   slotProps,   ...props }` value as `ProgressProps`. | [`ProgressProps`](/tuil/docs/reference/packages/ink/api/progress-props) |

## Returns [#returns]

`ReactNode` — Returns a value that satisfies `ReactNode`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`ProgressProps`](/tuil/docs/reference/packages/ink/api/progress-props)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/components.tsx)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)