forked from alexrk/mercury-rails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mercury.js
258 lines (243 loc) · 14.7 KB
/
mercury.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/*!
* Mercury Editor is a Coffeescript and jQuery based WYSIWYG editor. Mercury Editor utilizes the HTML5 ContentEditable
* spec to allow editing sections of a given page (instead of using iframes) and provides an editing experience that's as
* realistic as possible. By not using iframes for editable regions it allows CSS to behave naturally.
*
* Mercury Editor was written for the future, and doesn't attempt to support legacy implementations of document editing.
*
* Currently supported browsers are
* - Firefox 4+
* - Chrome 10+
* - Safari 5+
*
* Copyright (c) 2011 Jeremy Jackson
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*= require_self
*= require mercury/mercury
*/
window.Mercury = {
// Turning silent mode on will disable asking about unsaved changes before leaving the page.
silent: false,
// Turning debug mode on will log events and other various things (using console.debug if available).
debug: false,
//
// Mercury Configuration
//
config: {
// Pasting (in Chrome/Safari)
//
// When copying content using webkit, it embeds all the user defined styles (from the css files) into the html
// style attributes directly. When pasting this content into HTML5 contentEditable elements it leaves these
// intact. This can be a desired feature, or an annoyance, so you can enable it or disable it here. Keep in mind
// this will only change the behavior in webkit, as mozilla doesn't do this.
cleanStylesOnPaste: true,
// Image Uploading (in supported regions)
//
// If you drag images (while pressing shift) from your desktop into regions that support it, it will be uploade
// to the server and inserted into the region. This configuration allows you to specify if you want to
// disable/enable this feature, the accepted mime-types, file size restrictions, and other things related to
// uploading.
uploading: {
enabled: true,
allowedMimeTypes: ['image/jpeg', 'image/gif', 'image/png'],
maxFileSize: 1235242880,
inputName: 'image[image]',
url: '/images'
},
// Toolbars
//
// This is where you can customize the toolbars by adding or removing buttons, or changing them and their
// behaviors. Any top level object put here will create a new toolbar. Buttons are simply nested inside the
// toolbars, along with button groups.
//
// Buttons can be grouped. A button group is simply a way to wrap buttons for styling, and can also handle
// enabling or disabling all the buttons within it by using a context. The table button group is a good example
// of this.
//
// The primary toolbar is always visible, but any other toolbar should have a name based on what type of region
// it's for. The toolbar will be enabled/disabled base on what region currently has focus. Some toolbars are
// custom (the snippetable toolbar for instance), and to denote that use _custom: true. You can then build the
// toolbar yourself with it's own behavior.
//
// It's important to note that each of the button names (keys), in each toolbar object must be unique, regardless
// of if it's in a button group, or nested, etc. This is because styling is applied to them by name.
//
// Button format: [label, description, {type: action, type: action, etc}] The available button types are:
//
// toggle: toggles on or off when clicked, otherwise behaves like a button
// modal: opens a modal window, expects the action to be one of:
// a string url
// a function that returns a string url
// panel: opens a panel dialog, expects the action to be one of:
// a string url
// a function that returns a string url
// palette: opens a palette window, expects the action to be one of:
// a string url
// a function that returns a string url
// select: opens a pulldown style window, expects the action to be one of:
// a string url
// a function that returns a string url
// context: calls a callback function, expects the action to be:
// a function that returns a boolean to highlight the button
// note: if a function isn't provided, the key will be passed to the contextHandler, in which case a
// default context will be used (for more info read the Contexts section below)
// mode: toggle a given mode in the editor, expects the action to be:
// a string, denoting the name of the mode
// note: it's assumed that when a specific mode is turned on, all other modes will be turned off, which
// happens automatically, thus putting the editor into a specific "state"
// regions: allows buttons to be enabled/disabled based on what region type has focus, expects the action to be:
// an array of region types (eg. ['editable', 'markupable']
// preload: allows some dialog views to be loaded whtn the button is created instead of on first open, expects:
// a boolean
// note: only used for panels, selects, and palettes
//
// Separators are any "button" that's not an array, and are expected to be a string. You can use two different
// separator styles: line ('-'), and spacer (' ').
toolbars: {
primary: {
save: ['Save', 'Save this page'],
preview: ['Preview', 'Preview this page', { toggle: true, mode: true }],
sep1: ' ',
undoredo: {
undo: ['Undo', 'Undo your last action'],
redo: ['Redo', 'Redo your last action'],
sep: ' '
},
insertLink: ['Link', 'Insert Link', { modal: '/mercury/modals/link', regions: ['editable', 'markupable'] }],
insertMedia: ['Media', 'Insert Media (images and videos)', { modal: '/mercury/modals/media', regions: ['editable', 'markupable'] }],
insertTable: ['Table', 'Insert Table', { modal: '/mercury/modals/table', regions: ['editable', 'markupable'] }],
insertCharacter: ['Character', 'Special Characters', { modal: '/mercury/modals/character', regions: ['editable', 'markupable'] }],
objectsPanel: ['Snippet', 'Snippet Panel', { panel: '/mercury/panels/snippets' }],
sep2: ' ',
historyPanel: ['History', 'Page Version History', { panel: '/mercury/panels/history' }],
sep3: ' ',
notesPanel: ['Notes', 'Page Notes', { panel: '/mercury/panels/notes' }]
},
editable: {
_regions: ['editable', 'markupable'],
predefined: {
style: ['Style', null, { select: '/mercury/selects/style', preload: true }],
sep1: ' ',
formatblock: ['Block Format', null, { select: '/mercury/selects/formatblock', preload: true }],
sep2: '-'
},
colors: {
backColor: ['Background Color', null, { palette: '/mercury/palettes/backcolor', context: true, preload: true, regions: ['editable'] }],
sep1: ' ',
foreColor: ['Text Color', null, { palette: '/mercury/palettes/forecolor', context: true, preload: true, regions: ['editable'] }],
sep2: '-'
},
decoration: {
bold: ['Bold', null, { context: true }],
italic: ['Italicize', null, { context: true }],
overline: ['Overline', null, { context: true, regions: ['editable'] }],
strikethrough: ['Strikethrough', null, { context: true, regions: ['editable'] }],
underline: ['Underline', null, { context: true, regions: ['editable'] }],
sep: '-'
},
script: {
subscript: ['Subscript', null, { context: true }],
superscript: ['Superscript', null, { context: true }],
sep: '-'
},
justify: {
justifyLeft: ['Align Left', null, { context: true, regions: ['editable'] }],
justifyCenter: ['Center', null, { context: true, regions: ['editable'] }],
justifyRight: ['Align Right', null, { context: true, regions: ['editable'] }],
justifyFull: ['Justify Full', null, { context: true, regions: ['editable'] }],
sep: '-'
},
list: {
insertUnorderedList: ['Unordered List', null, { context: true }],
insertOrderedList: ['Numbered List', null, { context: true }],
sep: '-'
},
indent: {
outdent: ['Decrease Indentation', null],
indent: ['Increase Indentation', null],
sep: '-'
},
table: {
_context: true,
insertRowBefore: ['Insert Table Row', 'Insert a table row before the cursor', { regions: ['editable'] }],
insertRowAfter: ['Insert Table Row', 'Insert a table row after the cursor', { regions: ['editable'] }],
deleteRow: ['Delete Table Row', 'Delete this table row', { regions: ['editable'] }],
insertColumnBefore: ['Insert Table Column', 'Insert a table column before the cursor', { regions: ['editable'] }],
insertColumnAfter: ['Insert Table Column', 'Insert a table column after the cursor', { regions: ['editable'] }],
deleteColumn: ['Delete Table Column', 'Delete this table column', { regions: ['editable'] }],
sep1: ' ',
increaseColspan: ['Increase Cell Columns', 'Increase the cells colspan'],
decreaseColspan: ['Decrease Cell Columns', 'Decrease the cells colspan and add a new cell'],
increaseRowspan: ['Increase Cell Rows', 'Increase the cells rowspan'],
decreaseRowspan: ['Decrease Cell Rows', 'Decrease the cells rowspan and add a new cell'],
sep2: '-'
},
rules: {
horizontalRule: ['Horizontal Rule', 'Insert a horizontal rule'],
sep1: '-'
},
formatting: {
removeFormatting: ['Remove Formatting', 'Remove formatting for the selection', { regions: ['editable'] }],
sep2: ' '
},
editors: {
htmlEditor: ['Edit HTML', 'Edit the HTML content', { regions: ['editable'] }]
}
},
snippetable: {
_custom: true,
actions: {
editSnippet: ['Edit Snippet Settings', null],
sep1: ' ',
removeSnippet: ['Remove Snippet', null]
}
}
},
// Behaviors
//
// Behaviors are used to change the default behaviors of a given region type when a given button is clicked. For
// example, you may prefer to add HR tags using an HR wrapped within a div with a classname (for styling). You
// can add your own complex behaviors here.
//
// You can see how the behavior matches up directly with the button name. It's also important to note that the
// callback functions are executed within the scope of the given region, so you have access to all it's methods.
behaviors: {
horizontalRule: function(selection) { selection.replace('<hr/>') },
htmlEditor: function() { Mercury.modal('/mercury/modals/htmleditor', { title: 'HTML Editor', fullHeight: true, handler: 'htmlEditor' }) }
},
// Contexts
//
// Contexts are used callback functions used for highlighting and disabling/enabling buttons and buttongroups.
// When the cursor enters an element within an html region for instance we want to disable or highlight buttons
// based on the properties of the given node. You can see some examples of contexts in:
//
// Mercury.Toolbar.Button.contexts
// and
// Mercury.Toolbar.ButtonGroup.contexts
// Styles
//
// Mercury tries to stay as much out of your code as possible, but because regions appear within your document we
// need to include a few styles to indicate regions, as well as the different states of them (eg. focused). These
// styles are injected into your document, and as simple as they might be, you may want to change them. You can do
// so here.
injectedStyles: '' +
'.mercury-region, .mercury-textarea { min-height: 10px; outline: 1px dotted #09F }' +
'.mercury-textarea { box-sizing: border-box; -moz-box-sizing: border-box; -webkit-box-sizing: border-box; resize: vertical; }' +
'.mercury-region:focus, .mercury-region.focus, .mercury-textarea.focus { outline: none; -webkit-box-shadow: 0 0 10px #09F, 0 0 1px #045; box-shadow: 0 0 10px #09F, 0 0 1px #045 }' +
'.mercury-region:after { content: "."; display: block; visibility: hidden; clear: both; height: 0; overflow: hidden; }' +
'.mercury-region table, .mercury-region td { border: 1px dotted red; }'
}
};