mirror of
https://github.com/hanzoai/gui.git
synced 2026-10-25 02:31:41 +00:00
zeekayandHanzo Dev
751ef5c778
Both old names are owned by a different npm account (artemis-prime), so publishing them returns 403 — which is how this surfaced: the 8.0.0 run shipped @hanzogui/logo and @hanzogui/demos depending on [email protected], a version that cannot be published and therefore does not exist. Those two were uninstallable. @hanzo/gui and @hanzogui/* are ours, so the framework now carries the name it is imported by everywhere downstream, and the loader moves under the scope we control. The rewrite is limited to package references. `DEBUG?.startsWith('hanzogui')` is a log-namespace filter and join(dir, 'hanzogui') is a path — rewriting either would change behaviour, so both are untouched. Co-authored-by: Hanzo Dev <[email protected]>
102 lines
2.0 KiB
Plaintext
102 lines
2.0 KiB
Plaintext
---
|
|
title: Progress
|
|
description: Show percent completion with a progress bar
|
|
name: progress
|
|
component: Progress
|
|
package: progress
|
|
demoName: Progress
|
|
---
|
|
|
|
<HeroContainer showAnimationDriverControl>
|
|
<ProgressDemo />
|
|
</HeroContainer>
|
|
|
|
```tsx hero template=Progress
|
|
|
|
```
|
|
|
|
<Highlights
|
|
features={[
|
|
'Sizable, themeable, animatable.',
|
|
'Compound component API for complete control.',
|
|
<span>
|
|
Adheres to the{' '}
|
|
<Link href="https://www.w3.org/TR/wai-aria-1.2/#progressbar">
|
|
progressbar role requirements
|
|
</Link>
|
|
</span>,
|
|
]}
|
|
/>
|
|
|
|
## Installation
|
|
|
|
Progress is already installed in `hanzogui`, or you can install it independently:
|
|
|
|
```bash
|
|
npm install @hanzogui/progress
|
|
```
|
|
|
|
## Usage
|
|
|
|
The `value` property controls the percent, but you can override it by adjusting the `x` property.
|
|
|
|
```tsx
|
|
import { Button, Progress } from '@hanzo/gui'
|
|
|
|
export default () => (
|
|
<Progress value={60}>
|
|
<Progress.Indicator transition="bouncy" />
|
|
</Progress>
|
|
)
|
|
```
|
|
|
|
## API Reference
|
|
|
|
### Progress
|
|
|
|
Progress extends [ThemeableStack](/docs/components/stacks#themeablestack), getting [Gui standard props](/docs/intro/props), plus:
|
|
|
|
<PropsTable
|
|
data={[
|
|
{
|
|
name: 'size',
|
|
required: false,
|
|
type: '"small" | "large"',
|
|
description: `Size preset for the progress bar.`,
|
|
},
|
|
{
|
|
name: 'value',
|
|
required: false,
|
|
type: 'number | null',
|
|
description: `Controls the percent progress.`,
|
|
},
|
|
{
|
|
name: 'max',
|
|
required: false,
|
|
type: 'number',
|
|
description: `Maximum value for calculating the percentage.`,
|
|
},
|
|
{
|
|
name: 'unstyled',
|
|
required: false,
|
|
type: 'boolean',
|
|
description: `When true, removes all default styles.`,
|
|
},
|
|
]}
|
|
/>
|
|
|
|
### Progress.Indicator
|
|
|
|
`Progress.Indicator` extends [ThemeableStack](/docs/components/stacks#themeablestack), getting [Gui standard props](/docs/intro/props).
|
|
|
|
<PropsTable
|
|
data={[
|
|
{
|
|
name: 'unstyled',
|
|
required: false,
|
|
type: 'boolean',
|
|
description: `When true, removes all default styles.`,
|
|
},
|
|
]}
|
|
/>
|