Public repo of the original developers internal version
Go to file
Benjamin Boudreau 7a640329b5
Merge pull request #7 from seriousben/greenkeeper/initial
Add Greenkeeper badge 🌴
2018-06-03 11:01:43 -04:00
.circleci adding test coverage 2018-05-29 22:11:05 -04:00
jest adding tests 2018-05-29 21:57:30 -04:00
public adding widget output 2018-05-28 22:49:38 -04:00
src adding tests 2018-05-29 21:57:30 -04:00
.eslintrc adding widget output 2018-05-28 22:49:38 -04:00
.gitignore adding test coverage 2018-05-29 22:11:05 -04:00
package-lock.json adding tests 2018-05-29 21:57:30 -04:00
package.json prod build 2018-05-30 20:45:33 -04:00
README.md docs(readme): add Greenkeeper badge 2018-06-01 13:22:49 +00:00
webpack.config.js prod build 2018-05-30 20:45:33 -04:00

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 simple repository (with Webpack)
  • No css tyling 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
  • Obfuscation
  • Add greenkeeper
  • Integrate eslint with webpack
  • Theming support
  • Obfuscation
  • Storyboard and docs

Links

Best