Merge pull request #237 from NextStepWebs/development

Placeholder, Character counter, New icons, Customizable keyboard shortcuts, Custom status items, Bug fixes

README.md

@@ -90,14 +90,16 @@ simplemde.value("This text will appear in the editor");
   - **allowAtxHeaderWithoutSpace**: If set to `true`, will render headers without a space after the `#`. Defaults to `false`.
   - **strikethrough**: If set to `false`, will not process GFM strikethrough syntax. Defaults to `true`.
   - **underscoresBreakWords**: If set to `true`, let underscores be a delimiter for separating words. Defaults to `false`.
+- **placeholder**: Custom placeholder that should be displayed
 - **previewRender**: Custom function for parsing the plaintext Markdown and returning HTML. Used when user previews.
 - **renderingConfig**: Adjust settings for parsing the Markdown during previewing (not editing).
   - **singleLineBreaks**: If set to `false`, disable parsing GFM single line breaks. Defaults to `true`.
   - **codeSyntaxHighlighting**: If set to `true`, will highlight using [highlight.js](https://github.com/isagalaev/highlight.js). Defaults to `false`. To use this feature you must include highlight.js on your page. For example, include the script and the CSS files like:<br>`<script src="https://cdn.jsdelivr.net/highlight.js/latest/highlight.min.js"></script>`<br>`<link rel="stylesheet" href="https://cdn.jsdelivr.net/highlight.js/latest/styles/github.min.css">`
+- **shortcuts**: Keyboard shortcuts associated with this instance. Defaults to the [array of shortcuts](#keyboard-shortcuts).
 - **showIcons**: An array of icon names to show. Can be used to show specific icons hidden by default without completely customizing the toolbar.
 - **spellChecker**: If set to `false`, disable the spell checker. Defaults to `true`.
-- **status**: If set to `false`, hide the status bar. Defaults to `true`.
-  - Optionally, you can set an array of status bar elements to include, and in what order.
+- **status**: If set to `false`, hide the status bar. Defaults to the array of built-in status bar items.
+  - Optionally, you can set an array of status bar items to include, and in what order. You can even define your own custom status bar items.
 - **tabSize**: If set, customize the tab size. Defaults to `2`.
 - **toolbar**: If set to `false`, hide the toolbar. Defaults to the [array of icons](#toolbar-icons).
 - **toolbarTips**: If set to `false`, disable toolbar button tips. Defaults to `true`.
@@ -131,24 +133,38 @@ var simplemde = new SimpleMDE({
 		strikethrough: false,
 		underscoresBreakWords: true,
 	},
+	placeholder: "Type here...",
 	previewRender: function(plainText) {
 		return customMarkdownParser(plainText); // Returns HTML from a custom parser
 	},
 	previewRender: function(plainText, preview) { // Async method
 		setTimeout(function(){
 			preview.innerHTML = customMarkdownParser(plainText);
 		}, 250);
-		
+
 		return "Loading...";
 	},
 	renderingConfig: {
 		singleLineBreaks: false,
 		codeSyntaxHighlighting: true,
 	},
+	shortcuts: {
+		drawTable: "Cmd-Alt-T"
+	},
 	showIcons: ["code", "table"],
 	spellChecker: false,
 	status: false,
 	status: ["autosave", "lines", "words", "cursor"], // Optional usage
+	status: ["autosave", "lines", "words", "cursor", {
+		className: "keystrokes",
+		defaultValue: function(el) {
+			this.keystrokes = 0;
+			el.innerHTML = "0 Keystrokes";
+		},
+		onUpdate: function(el) {
+			el.innerHTML = ++this.keystrokes + " Keystrokes";
+		}
+	}], // Another optional usage, with a custom status bar item that counts keystrokes
 	tabSize: 4,
 	toolbar: false,
 	toolbarTips: false,
@@ -157,30 +173,33 @@ var simplemde = new SimpleMDE({
 
 #### Toolbar icons
 
-Below are the built-in toolbar icons (only some of which are enabled by default), which can be reorganized however you like. "Name" is the name of the icon, referenced in the JS. "Action" is either a function or a URL to open. "Class" is the class given to the icon. "Tooltip" is the small tooltip that appears via the `title=""` attribute. Any `Ctrl` or `Alt` in the title tags will be converted automatically to their Mac equivalents when needed. Additionally, you can add a separator between any icons by adding `"|"` to the toolbar array.
+Below are the built-in toolbar icons (only some of which are enabled by default), which can be reorganized however you like. "Name" is the name of the icon, referenced in the JS. "Action" is either a function or a URL to open. "Class" is the class given to the icon. "Tooltip" is the small tooltip that appears via the `title=""` attribute. Note that shortcut hints are added automatically and reflect the specified action if it has a keybind assigned to it (i.e. with the value of `action` set to `bold` and that of `tooltip` set to `Bold`, the final text the user will see would be "Bold (Ctrl-B)").
+
+Additionally, you can add a separator between any icons by adding `"|"` to the toolbar array.
 
 Name | Action | Tooltip<br>Class
 :--- | :----- | :--------------
-bold | toggleBold | Bold (Ctrl+B)<br>fa fa-bold
-italic | toggleItalic | Italic (Ctrl+I)<br>fa fa-italic
+bold | toggleBold | Bold<br>fa fa-bold
+italic | toggleItalic | Italic<br>fa fa-italic
 strikethrough | toggleStrikethrough | Strikethrough<br>fa fa-strikethrough
-heading | toggleHeadingSmaller | Heading (Ctrl+H)<br>fa fa-header
-heading-smaller | toggleHeadingSmaller | Smaller Heading (Ctrl+H)<br>fa fa-header
-heading-bigger | toggleHeadingBigger | Bigger Heading (Shift+Ctrl+H)<br>fa fa-lg fa-header
+heading | toggleHeadingSmaller | Heading<br>fa fa-header
+heading-smaller | toggleHeadingSmaller | Smaller Heading<br>fa fa-header
+heading-bigger | toggleHeadingBigger | Bigger Heading<br>fa fa-lg fa-header
 heading-1 | toggleHeading1 | Big Heading<br>fa fa-header fa-header-x fa-header-1
 heading-2 | toggleHeading2 | Medium Heading<br>fa fa-header fa-header-x fa-header-2
 heading-3 | toggleHeading3 | Small Heading<br>fa fa-header fa-header-x fa-header-3
-code | toggleCodeBlock | Code (Ctrl+Alt+C)<br>fa fa-code
-quote | toggleBlockquote | Quote (Ctrl+')<br>fa fa-quote-left
-unordered-list | toggleUnorderedList | Generic List (Ctrl+L)<br>fa fa-list-ul
-ordered-list | toggleOrderedList | Numbered List (Ctrl+Alt+L)<br>fa fa-list-ol
-link | drawLink | Create Link (Ctrl+K)<br>fa fa-link
-image | drawImage | Insert Image (Ctrl+Alt+I)<br>fa fa-picture-o
+code | toggleCodeBlock | Code<br>fa fa-code
+quote | toggleBlockquote | Quote<br>fa fa-quote-left
+unordered-list | toggleUnorderedList | Generic List<br>fa fa-list-ul
+ordered-list | toggleOrderedList | Numbered List<br>fa fa-list-ol
+clean-block | cleanBlock | Clean block<br>fa fa-eraser fa-clean-block
+link | drawLink | Create Link<br>fa fa-link
+image | drawImage | Insert Image<br>fa fa-picture-o
 table | drawTable | Insert Table<br>fa fa-table
 horizontal-rule | drawHorizontalRule | Insert Horizontal Line<br>fa fa-minus
-preview | togglePreview | Toggle Preview (Ctrl+P)<br>fa fa-eye no-disable
-side-by-side | toggleSideBySide | Toggle Side by Side (F9)<br>fa fa-columns no-disable no-mobile
-fullscreen | toggleFullScreen | Toggle Fullscreen (F11)<br>fa fa-arrows-alt no-disable no-mobile
+preview | togglePreview | Toggle Preview<br>fa fa-eye no-disable
+side-by-side | toggleSideBySide | Toggle Side by Side<br>fa fa-columns no-disable no-mobile
+fullscreen | toggleFullScreen | Toggle Fullscreen<br>fa fa-arrows-alt no-disable no-mobile
 guide | [This link](http://nextstepwebs.github.io/simplemde-markdown-editor/markdown-guide) | Markdown Guide<br>fa fa-question-circle
 
 Customize the toolbar using the `toolbar` option like:
@@ -197,7 +216,7 @@ var simplemde = new SimpleMDE({
 			name: "bold",
 			action: SimpleMDE.toggleBold,
 			className: "fa fa-bold",
-			title: "Bold (Ctrl+B)",
+			title: "Bold",
 		},
 		{
 			name: "custom",
@@ -213,6 +232,43 @@ var simplemde = new SimpleMDE({
 });
 ```
 
+#### Keyboard shortcuts
+
+SimpleMDE comes with an array of predefined keyboard shortcuts, but they can be altered with a configuration option. The list of default ones is as follows:
+
+Shortcut | Action
+:------- | :-----
+*Cmd-'* | "toggleBlockquote"
+*Cmd-B* | "toggleBold"
+*Cmd-E* | "cleanBlock"
+*Cmd-H* | "toggleHeadingSmaller"
+*Cmd-I* | "toggleItalic"
+*Cmd-K* | "drawLink"
+*Cmd-L* | "toggleUnorderedList"
+*Cmd-P* | "togglePreview"
+*Cmd-Alt-C* | "toggleCodeBlock"
+*Cmd-Alt-I* | "drawImage"
+*Cmd-Alt-L* | "toggleOrderedList"
+*Shift-Cmd-H* | "toggleHeadingBigger"
+*F9* | "toggleSideBySide"
+*F11* | "toggleFullScreen"
+
+Here is how you can change a few, while leaving others untouched:
+
+```JavaScript
+var simplemde = new SimpleMDE({
+	shortcuts: {
+		"toggleOrderedList": "Ctrl-Alt-K", // alter the shortcut for toggleOrderedList
+		"toggleCodeBlock": null, // unbind Ctrl-Alt-C
+		"drawTable": "Cmd-Alt-T" // bind Cmd-Alt-T to drawTable action, which doesn't come with a default shortcut
+	}
+});
+```
+
+Shortcuts are automatically converted between platforms. If you define a shortcut as "Cmd-B", on PC that shortcut will be changed to "Ctrl-B". Conversely, a shortcut defined as "Ctrl-B" will become "Cmd-B" for Mac users.
+
+The list of actions that can be bound is the same as the list of built-in actions available for [toolbar buttons](#toolbar-icons).
+
 #### Height
 
 To change the minimum height (before it starts auto-growing):

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "simplemde",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "homepage": "https://github.com/NextStepWebs/simplemde-markdown-editor",
   "authors": [
 	"Wes Cossick"

debug/simplemde.css

@@ -1,5 +1,5 @@
 /**
- * simplemde v1.9.0
+ * simplemde v1.10.0
  * Copyright Next Step Webs, Inc.
  * @link https://github.com/NextStepWebs/simplemde-markdown-editor
  * @license MIT
@@ -551,6 +551,10 @@ span.CodeMirror-selectedtext { background: none; }
 	content: 'words: '
 }
 
+.editor-statusbar .characters:before {
+	content: 'characters: '
+}
+
 .editor-preview {
 	padding: 10px;
 	position: absolute;
@@ -659,6 +663,10 @@ span.CodeMirror-selectedtext { background: none; }
 .CodeMirror .CodeMirror-code .cm-strikethrough {
 	text-decoration: line-through;
 }
+
+.CodeMirror .CodeMirror-placeholder {
+	opacity: .5;
+}
 .CodeMirror .cm-spell-error:not(.cm-url):not(.cm-comment):not(.cm-tag):not(.cm-word) {
 	 background: rgba(255, 0, 0, .15);
 }