# wiggi-wiz

> A pure angular wysywyg editor with extensibility in mind

Latest version **0.1.94** (published 2016-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install wiggi-wiz
pnpm add wiggi-wiz
yarn add wiggi-wiz
bun add wiggi-wiz
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.94 |
| Published | 2016-05-24 |
| First published | 2016-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.2.2 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | CoreSpring |
| Maintainers | benburton |

## Links

- npm: https://www.npmjs.com/package/wiggi-wiz
- Repository: https://github.com/corespring/wiggi-wiz
- Homepage: http://corespring.github.io/wiggi-wiz
- Issues: https://github.com/corespring/wiggi-wiz/issues
- npm.io page: https://npm.io/package/wiggi-wiz

## Recent versions

- 0.1.94 (latest) — 2016-05-24
- 0.1.93 — 2016-05-12

## README

# Wiggi Wiz

[![Build Status](https://travis-ci.org/corespring/wiggi-wiz.svg?branch=master)](https://travis-ci.org/corespring/wiggi-wiz)

An angular based rich text editor, with support for extensions, custom markup and a rich api for dialogs, modals etc.

Inspired by some [great editors](#inspiration), but they didn't quite fit our needs.

## Install

    npm install -g grunt-cli
    npm install -g harp
    npm install # (also runs bower install)

## Run Example

    grunt run

Then go to [/wiggi-wiz](http://localhost:5000/wiggi-wiz)

## Run unit tests

We use [karma](https://github.com/karma-runner/karma), you can run it directly using `karma`, but we have some shortcuts for you in the Gruntfile.

### Run once and exit

    grunt test

### Run continuously (handy while developing)

    grunt karma:continuous

### Debugging Tests in Karma

You'll need `karma-cli` installed.

Make sure the following are set in your karma.conf.js:

* browsers: ['Chrome' || 'Firefox']
* singleRun: false

If you have karma installed:

    karma start

This will override the browser in karma.conf.js:

    karma start --browsers Chrome

## Running regression/ui tests

The regression tests use [grunt-webdriver](http://github.com/webdriverio/grunt-webdriver).

    grunt regression

 ### Options

 See [grunt-webdriver](https://github.com/webdriverio/grunt-webdriver) for info on the options

     --bail=true|false
     --grep="string"
     --sauceLabs=true|false
     --browserName="string"
     --browserVersion="string"
     --platform="string"

> Note: To run with saucelabs as the driver you'll need the following env vars: `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY`.

> Note: If sauceLabs=true we automatically set the base url to the github pages site.


### Example

    grunt regression --grep="add table" --browserName="firefox"

## Build

    grunt  

## Release

What it does:

* tag the current commit with the current version
* bump the version to the next index

To use release you'll need the following env vars: `GITHUB_USERNAME` and `GITHUB_PASSWORD`.

    grunt 
    grunt test
    git add/commit/push if the files in dist have changed 
    grunt release

## Building the gh-pages site

We use [harp](http://harpjs.com/) to build the static site.
The build script builds it to a tmp folder the adds it to the gh-pages branch.

    ./bin/build.site

## Docs

The docs are here: /site/docs - please update!

## Inspiration

* [summernote](http://hackerwins.github.io/summernote/)
* [textAngular](http://textangular.com/)

---
_Source: https://npm.io/package/wiggi-wiz · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._