codoozer-flow v0.1.24

Codoozer Flow

Getting started

1. Go to codoozer.com and create a flow project.
2. Create all your flows and the steps of each flow.
3. Publish your flow project to get the url you need to init your codoozer-flow lib.
4. Import codoozer-flow in your code with npm or cdn.
5. Start a flow whenever you want with the id of the flow project.

Install

npm

import CodoozerFlow from 'codoozer-flow';
import 'codoozer-flow/build/index.css' // If you import a css file in your library
...

cdn

<link href="https://unpkg.com/codoozer-flow/build/index.css" rel="stylesheet">
<script src="https://unpkg.com/codoozer-flow/build/index.js"></script>
...

Usage

npm

let flow = new CodoozerFlow({ hash: 'HASH' });
...

cdn

let CodoozerFlow = window.CodoozerFlow.default;
let flow = new CodoozerFlow({ hash: 'HASH' });
...

API

start(flowId, { newLayer })

• flowId: must be a String that represents the id of the flow you want to start.
• newLayer: must be a Boolean. Default: true.

goTo(stepId, { newLayer })

• stepId: must be a String that represents the id of the step you want to go.
• newLayer: must be a Boolean. Default: false.