@flowerforce/flower-core
TypeScript icon, indicating that this package has built-in type declarations

3.3.0 • Public • Published

Flower Core

Flower Core is the foundational business logic library that powers all Flower front-end workflow visualization tools. It provides the essential functionalities required to create, modify, and visualize workflows in a graphical format. This core library serves as the backbone for various versions of Flower, such as Flower-React, and will support future versions for other frameworks and platforms.

Features

  • Workflow Management: Comprehensive API for creating, updating, and managing workflows programmatically.
  • Node and Connection Handling: Functions to manage nodes and connections, including adding, removing, and editing.
  • State Management: Built-in state management to keep track of workflow changes and updates.
  • Event System: Customizable event handling to respond to user interactions and changes within the workflow.
  • Serialization: Convert workflows to and from different formats (e.g., JSON) for easy storage and retrieval.
  • Validation: Ensure workflows follow predefined rules and constraints to maintain integrity.
  • Form Validation: Built-in functionalities to validate form inputs within nodes, ensuring data integrity and correctness.
  • History Management: Internal management of flow history, tracking node traversal and changes for debugging and visualization purposes.

Installation

Flower Core can be installed via npm or yarn for use in any JavaScript project.

Using npm

  1. Ensure you have Node.js and npm installed on your system.
  2. Run the following command to install the library:
#NPM
npm install @flowerforce/flower-core

Using yarn

  1. Ensure you have yarn installed on your system.
  2. Run the following command to install the library:
#YARN
yarn add @flowerforce/flower-core

Integration with Frameworks

Flower Core is designed to be framework-agnostic, making it versatile for integration with various front-end frameworks and libraries. For example, Flower-React leverages Flower Core to provide a React-based interface for workflow visualization.

Future Plans

The future of Flower Core includes:

  • Enhanced Features: Adding more advanced workflow management features, including conditional logic and looping structures.
  • Framework Integrations: Expanding support to include Angular, Vue.js, Flutter, and other frameworks.
  • Performance Optimizations: Continuous improvements to ensure efficient and scalable performance for complex workflows.

Full Documentation

For more info flowerjs.it/.

Contributing

Contributing to Flower is easy and encouraged! If you find a bug or have a suggestion for improvement, feel free to open an issue or a pull request in the GitHub repository.

License

Flower Core is an open-source library.


Thank you for choosing Flower for your projects! We hope our library helps you create amazing user experiences.

Readme

Keywords

none

Package Sidebar

Install

npm i @flowerforce/flower-core

Weekly Downloads

22

Version

3.3.0

License

MIT

Unpacked Size

110 kB

Total Files

28

Last publish

Collaborators

  • stackhouseos