Skip to content

Commit

Permalink
documented the showOnEmptyLink option
Browse files Browse the repository at this point in the history
  • Loading branch information
Rishi Jain committed Jun 1, 2016
1 parent 01ff0ec commit ea44e1d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
7 changes: 7 additions & 0 deletions OPTIONS.md
Expand Up @@ -42,6 +42,7 @@ var editor = new MediumEditor('.editor', {
- [Anchor Preview options](#anchor-preview-options)
- [`hideDelay`](#hidedelay)
- [`previewValueSelector`](#previewvalueselector)
- [`showOnEmptyLinks`](#showonemptylinks)
- [Disabling Anchor Preview](#disabling-anchor-preview)
- [Placeholder Options](#placeholder-options)
- [`text`](#text)
Expand Down Expand Up @@ -334,6 +335,12 @@ Time in milliseconds to show the anchor tag preview after the mouse has left the

The default selector to locate where to put the activeAnchor value in the preview. You should only need to override this if you've modified the way in which the anchor-preview extension renders.

***
#### `showOnEmptyLinks`
**Default:** `true`

Determines whether the anchor tag preview shows up on link with href as "" or "#something". You should set this value to false if you do not want the preview to show up in such use cases.

***
#### `showWhenToolbarIsVisible`
**Default:** `false`
Expand Down
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -251,6 +251,7 @@ var editor = new MediumEditor('.editable', {
* __hideDelay__: time in milliseconds to show the anchor tag preview after the mouse has left the anchor tag. Default: `500`
* __previewValueSelector__: the default selector to locate where to put the activeAnchor value in the preview. You should only need to override this if you've modified the way in which the anchor-preview extension renders. Default: `'a'`
* __showWhenToolbarIsVisible__: determines whether the anchor tag preview shows up when the toolbar is visible. You should set this value to true if the static option for the toolbar is true and you want the preview to show at the same time. Default: `false`
* __showOnEmptyLinks__: determines whether the anchor tag preview shows up on link with href as '' or '#something'. You should set this value to false if you do not want the preview to show up in such use cases. Default: `true`

To disable the anchor preview, set the value of the `anchorPreview` option to `false`:
```javascript
Expand Down

0 comments on commit ea44e1d

Please sign in to comment.