0.0.7 • Published 4 months ago
quick-acyclic v0.0.7
🔀 Quick Acyclic React Pipes - NOT RECOMMENDED FOR PRODUCTION
A component library for displaying pipelines in React.
This component library is currently under construction and is not recommended for production at this stage.
📚 Hosted documentation
Check out the hosted documentation.
🚀 Features
A wide variety of intents and icons
Sub pipelines
💡 Getting started
Installation
npm i quick-acyclic
Quick code example
<ReactPipes
label="Pipeline"
schema={[
{
active: false,
attempts: 1,
icon: 'Icon2fa',
intent: 'rp-intent-success',
size: 'rp-size-m'
},
{
active: false,
intent: 'rp-intent-success',
size: 'rp-size-s'
},
{
active: false,
attempts: 1,
icon: 'IconAward',
intent: 'rp-intent-success',
size: 'rp-size-m'
},
{
active: false,
intent: 'rp-intent-success',
size: 'rp-size-s'
},
{
active: true,
icon: 'IconClock',
intent: 'rp-intent-in-progress',
size: 'rp-size-m'
},
{
active: true,
intent: 'rp-intent-in-progress',
progressPercent: 30,
size: 'rp-size-s'
},
{
active: false,
icon: 'Icon3dRotate',
intent: 'rp-intent-none',
size: 'rp-size-m'
}
]}
/>
⚙ Components
Pipe
Prop | Description | Optional |
---|---|---|
intent | "rp-intent-none" "rp-intent-warning" "rp-intent-success" "rp-intent-failure" "rp-intent-in-progress" "rp-intent-skipped" | no |
active | boolean | no |
size | "rp-size-xs" "rp-size-s" "rp-size-m" "rp-size-l" "rp-size-xl" | no |
progressPercent | number | yes |
PipelineNode
Prop | Description | Optional |
---|---|---|
intent | "rp-intent-none" "rp-intent-warning" "rp-intent-success" "rp-intent-failure" "rp-intent-in-progress" "rp-intent-skipped" | no |
active | boolean | no |
size | "rp-size-xs" "rp-size-s" "rp-size-m" "rp-size-l" "rp-size-xl" | no |
progressPercent | number | yes |
onNodeClick | ()=>void | no |
active | boolean | no |
size | "rp-size-xs" "rp-size-s" "rp-size-m" "rp-size-l" "rp-size-xl" | no |
icon | docs | yes |
attempts | number | yes |
progressPercent | number | yes |
className | string | yes |
Pipeline
Prop | Description | Optional |
---|---|---|
schema | (ReactPipesProps | ReactPipesNodeProps | ReactPipesPipeProps)[] | no |