Appcues WYSIWYG Editor
Clone or download
Latest commit 1b3ed95 Sep 17, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo externalize ReactDOMServer so we don't accidentally bundle-in devDepe… Feb 14, 2018
docs set MaxZones property May 15, 2018
src Add font color styles to override theme Sep 12, 2018
test fix hover states and remove unecessary code May 11, 2018
.babelrc fix tests with new babel Feb 14, 2018
.eslintignore Fixed the positioning of the main elements May 4, 2017
.eslintrc.json
.gitignore ignore intellij files Feb 12, 2018
.nvmrc Initial Commit Apr 3, 2017
LICENSE Create LICENSE Jun 29, 2017
README.md Nuke dev build from README Feb 6, 2018
bower.json Added build step for importing with bower May 2, 2017
package-lock.json 1.21.4 Aug 31, 2018
package.json bump to 1.21.5 Sep 17, 2018
webpack.build.js compile striptags with babel, as they have decided not to Feb 15, 2018
webpack.demo.js revamp demo site for potential use Feb 13, 2018
wercker.yml
yarn.lock Use brandcast draft-js for iframe compatibility. Nov 8, 2017

README.md

Appcues Editor

Demo

There is a demo included which uses Webpack Dev Server to compile the component code on the fly and render an HTML page with various examples of editors. This demo page is also a good environment for doing development.

Starting the Demo Server

  1. Make sure you're on a recent version of node.js. There is an .nvmrc file in the project root, allowing you to type nvm use if you have nvm installed. That will reference the version of node that this library was authored with.
  2. npm install
  3. npm start
  4. Open http://localhost:8080/

How the Demo Works

To see what the demo is doing in order to get example usage of the component, open /demo/index.html.

  • React and React-DOM are loaded as scripts from a CDN, so the webpack build does not need to compile them constantly.
  • Babel Standalone is used so that we can use JSX within the demo HTML page and not have to include a separate build process just for the demo page.

Development

Installation

Follow the instructions in the Demo section at the top.

Building for Deployment

  • npm run build

Before committing new code, you need to run npm run build which will update the ES5 code in /lib as well as the packaged script file in /dist/index.js.

Unit Tests

This library uses the following frameworks for unit testing:

To run the unit tests:

  • npm test

To run test coverage with HTML output:

  • npm run coverage-report && open coverage/index.html

Linting

Linting is done with ESLint. It uses the same lint configuration as the SDK.

To run the lint:

  • npm run lint

This will also be done at the completion of running the unit tests.

Usage

Usage Guide

Data Migration

Data Migration Guide

Technical Overview

Technical Overview