0.0.7 • Published 4 months ago

quick-acyclic v0.0.7

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 months ago

ezgif-4-fef5b85f32

🔀 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

ezgif-4-b0c494d8b3

Sub pipelines

ezgif-4-3e54426d46

💡 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

image

PropDescriptionOptional
intent"rp-intent-none" "rp-intent-warning" "rp-intent-success" "rp-intent-failure" "rp-intent-in-progress" "rp-intent-skipped"no
activebooleanno
size"rp-size-xs" "rp-size-s" "rp-size-m" "rp-size-l" "rp-size-xl"no
progressPercentnumberyes

PipelineNode

image

PropDescriptionOptional
intent"rp-intent-none" "rp-intent-warning" "rp-intent-success" "rp-intent-failure" "rp-intent-in-progress" "rp-intent-skipped"no
activebooleanno
size"rp-size-xs" "rp-size-s" "rp-size-m" "rp-size-l" "rp-size-xl"no
progressPercentnumberyes
onNodeClick()=>voidno
activebooleanno
size"rp-size-xs" "rp-size-s" "rp-size-m" "rp-size-l" "rp-size-xl"no
icondocsyes
attemptsnumberyes
progressPercentnumberyes
classNamestringyes

Pipeline

ezgif-4-b0c494d8b3

PropDescriptionOptional
schema(ReactPipesProps | ReactPipesNodeProps | ReactPipesPipeProps)[]no