Getting Started

Getting Started

1. Include scripts

<!-- wysihtml5 parser rules -->
<script src="/path-to-wysihtml5/parser_rules/advanced.js"></script>
<!-- Library -->
<script src="/path-to-wysihtml5/dist/wysihtml5_0.3.0.min.js"></script>

• The first script contains the html5 parser rules that are needed for wysihtml5 in order to create valid and desired markup.
  Either use one of the existing parser rules set or create your own.
  Check the advanced.js parser rules for details.
• The second script is the minified wysihtml5 library. It’s located in the dist folder of this repository.

2. Create a textarea

<form><textarea id="wysihtml5-textarea"></textarea></form>

wysihtml5 takes a textarea and transforms it into a rich text editor. The textarea acts as a fallback for unsupported browsers (eg. IE < 8). Make sure the textarea element has an id, so we can later access it easily from javascript.

Please note: The textarea will always hold the editor’s generated markup. Therefore wysihtml5 integrates smoothly with forms.

3. Create a toolbar

<div id="wysihtml5-toolbar" style="display: none;">
  <a data-wysihtml5-command="bold">bold</a>
  <a data-wysihtml5-command="italic">italic</a>
  
  <!-- Some wysihtml5 commands require extra parameters -->
  <a data-wysihtml5-command="foreColor" data-wysihtml5-command-value="red">red</a>
  <a data-wysihtml5-command="foreColor" data-wysihtml5-command-value="green">green</a>
  <a data-wysihtml5-command="foreColor" data-wysihtml5-command-value="blue">blue</a>
  
  <!-- Some wysihtml5 commands like 'createLink' require extra paramaters specified by the user (eg. href) -->
  <a data-wysihtml5-command="createLink">insert link</a>
  <div data-wysihtml5-dialog="createLink" style="display: none;">
    <label>
      Link:
      <input data-wysihtml5-dialog-field="href" value="http://" class="text">
    </label>
    <a data-wysihtml5-dialog-action="save">OK</a> <a data-wysihtml5-dialog-action="cancel">Cancel</a>
  </div>
</div>

The toolbar contains the formatting options. Make sure the toolbar element has an id and has display: none.

Please note: wysihtml5 supports many more formatting commands. Check the advanced demo or find a full list of all supported commands here.

4. Initialize wysihtml5

<script>
var editor = new wysihtml5.Editor("wysihtml5-textarea", {
  toolbar:      "wysihtml5-toolbar", // id of toolbar element
  parserRules:  wysihtml5ParserRules // defined in parser rules set
});
</script>

wysihtml5.Editor supports many more configuration options.

5. There you go

Congrats you just integrated wysihtml5 into your website.
Now enjoy a cold beer or consider checking out the full JavaScript API reference.