# codoozer-flow

> Codoozer flow reader library

Latest version **0.1.24** (published 2021-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install codoozer-flow
pnpm add codoozer-flow
yarn add codoozer-flow
bun add codoozer-flow
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.24 |
| Published | 2021-06-01 |
| First published | 2021-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 3.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | Carlos Hermoso Sierra |
| Maintainers | chermoso |
| Keywords | codoozer, diy, flow, low-code, no-code, steps, web, website, widget |

## Links

- npm: https://www.npmjs.com/package/codoozer-flow
- Repository: https://github.com/doyotech/codoozer-flow
- Issues: https://github.com/doyotech/codoozer-flow/issues
- npm.io page: https://npm.io/package/codoozer-flow

## Dependencies (3)

- [analytics](https://npm.io/package/analytics.md) ^0.7.5
- [local-storage](https://npm.io/package/local-storage.md) ^2.0.0
- [@analytics/google-analytics](https://npm.io/package/@analytics/google-analytics.md) ^0.5.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.24 (latest) — 2021-06-01
- 0.1.23 — 2021-05-24
- 0.1.22 — 2021-05-19
- 0.1.21 — 2021-05-13
- 0.1.20 — 2021-05-05
- 0.1.19 — 2021-05-04
- 0.1.18 — 2021-04-30
- 0.1.17 — 2021-04-29
- 0.1.16 — 2021-04-29
- 0.1.15 — 2021-04-29
- 0.1.14 — 2021-04-29
- 0.1.13 — 2021-04-23
- 0.1.12 — 2021-04-23
- 0.1.11 — 2021-04-21
- 0.1.10 — 2021-04-21
- … 10 more at https://npm.io/package/codoozer-flow/versions

## README

<p align="center"><img src="https://codoozer.com/favicon/android-chrome-512x512.png" height="70px"></p>

# Codoozer Flow

## Getting started

1. Go to <a href="https://codoozer.com">codoozer.com</a> 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.

<br/>

# 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>
...
```

<br />

# Usage

### npm

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

### cdn

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

<br />

# 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`.

---
_Source: https://npm.io/package/codoozer-flow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
