ocrcc-chatbox/README.md
Benjamin Boudreau 1064f017bc updating readme
2018-06-03 11:02:07 -04:00

2.9 KiB

Embeddable React Widget

CircleCI codecov Greenkeeper badge

Easy creation of an embeddable widget.

Goal

The create-react-app of embeddable widgets.

Features

  • Full ES6/ES2015 support (with Babel)
  • Package fonts, css, json, javascripts together into one single package (with Webpack)
  • No css styling conflicts between the host page and the widget (with https://github.com/premasagar/cleanslate)
  • User theming of widget
  • Obfuscating of the widget code

What is an embeddable widget?

  • Usable using a simple <script> tag
  • Configurable with code
  • Themable

Why not in an iframe?

  • Interaction between the frame and the hosting page is tricky and not recommended
  • You can only display content within the iframe
  • iframe and content resizing is impossible
  • iframe sandboxing can result in missing functionalities

Roadmap

  • Widget as react app - index.html works (webpack, babel, react)
  • React widget (widget builder)
  • Webpack changed to output a library
  • Add tests
  • Production Build
  • Minified
  • Add greenkeeper
  • Reset / Cleanslate / No-conflicts of styles
  • Obfuscation
  • Integrate eslint with webpack
  • Theming support
  • Storyboard and docs

Links

Best