Skip to content
Simple plan creation in JavaScript for sync/async workflows such as modals & ajax
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
README.md
index.html
index.js
plan.js

README.md

plan.js

Simple plan (workflow) creation utility library. Aim is to simplify simple workflows such as modals with forms and ajax error handling.

A live example can be found on this repo's GitHub Pages site.

Features / Goals

  • Should handle sync and async steps
  • Should have minimal plan setup ceremony
  • Should handle steps w/ 1 or 2 possible outcomes
  • Should allow for information to be passed between steps
  • Should allow for plan execution to pass in config/context data
  • Should allow for creation of plans and seperate execution; possibly multiple times w/ different context
  • Should minimally polute global namespace

Wish List / Thoughts

  • Cleanup all of the args prepending
  • Find a better way to handline context and streamline data passing without using all of the arguments or jump through 'this' hoops
  • make take_step and take_future_step not prototype methods and maybe more general
  • cleaner way for actions to denote success/failure than explicit knowledge of jquery deferred
  • remove dependency on jquery and manage own callback list and resolution with custom deferred that meets the specific needs of this lib and not the general ones of jquery (although common naming is nice for documentation and prior knowledge)
  • maybe configure properties on action functions themselves which denote if the function needs the deferred, args, or context objects? only make available if specifically requested?

License

Creative Commons License
Plan.JS by Benjamin P Lee is licensed under a Creative Commons Attribution 3.0 Unported License.

Something went wrong with that request. Please try again.