Update formatting toolbar to include user definable settings and customized options.

This commit is contained in:
ForklessAnon 2014-10-31 21:53:02 -05:00 committed by czaks
parent 9265ebea43
commit 86ddb4ecbb

View File

@ -8,253 +8,357 @@
* $config['additional_javascript'][] = 'js/comment-toolbar.js'; * $config['additional_javascript'][] = 'js/comment-toolbar.js';
*/ */
if (active_page == 'thread' || active_page == 'index') { if (active_page == 'thread' || active_page == 'index') {
$(document).ready(function () { var formatText = (function($){
'use strict'; "use strict";
var formats = { var self = {};
bold: { self.rules = {
displayText: 'B', spoiler: {
altText: 'bold', text: 'Spoiler',
styleCSS: 'font-weight: bold;', key: 's',
options: { multiline: false,
prefix: "'''", exclusiveline: false,
suffix: "'''" prefix:'**',
}, suffix:'**'
edit: function (box, options) {
wrapSelection(box, options);
},
shortcutKey: 'b'
}, },
italics: { italics: {
displayText: 'i', text: 'Italics',
altText: 'italics', key: 'i',
styleCSS: 'font-style: italic;', multiline: false,
options: { exclusiveline: false,
prefix: "''", prefix: "''",
suffix: "''" suffix: "''"
}, },
edit: function (box, options) { bold: {
wrapSelection(box, options); text: 'Bold',
key: 'b',
multiline: false,
exclusiveline: false,
prefix: "'''",
suffix: "'''"
}, },
shortcutKey: 'i' underline: {
}, text: 'Underline',
under: { key: 'u',
displayText: 'U', multiline: false,
altText: 'underline', exclusiveline: false,
styleCSS: 'text-decoration: underline;',
options: {
prefix:'__', prefix:'__',
suffix:'__' suffix:'__'
}, },
edit: function (box, options) {
wrapSelection(box, options);
},
shortcutKey: 'u'
},
spoiler: {
displayText: 'spoiler',
altText: 'mark as spoiler',
styleCSS: '',
options: {
prefix: '[spoiler]',
suffix: '[/spoiler]'
},
edit: function (box, options) {
wrapSelection(box, options);
},
shortcutKey: 's'
},
code: { code: {
displayText: 'code', text: 'Code',
altText: "code formatting", key: 'f',
styleCSS: 'font-family: "Courier New", Courier, monospace;', multiline: true,
options: { exclusiveline: false,
prefix: '[code]', prefix: '[code]',
suffix: '[/code]', suffix: '[/code]'
multiline: true
},
edit: function (box, options) {
wrapSelection(box, options);
},
shortcutKey: 'd'
}, },
strike: { strike: {
displayText: 'strike', text: 'Strike',
altText: 'strikethrough', key: 'd',
styleCSS: 'text-decoration: line-through;', multiline:false,
options: { exclusiveline:false,
prefix:'~~', prefix:'~~',
suffix:'~~' suffix:'~~'
}, },
edit: function (box, options) {
wrapSelection(box, options);
}
},
heading: { heading: {
displayText: 'heading', text: 'Heading',
altText: 'redtext', key: 'r',
styleCSS: 'color: #AF0A0F; font-weight: bold;', multiline:false,
options: { exclusiveline:true,
prefix:'==', prefix:'==',
suffix: '==', suffix:'=='
exclusiveLine: true
},
edit: function (box, options) {
wrapSelection(box, options);
}
} }
}; };
var key, name, altText, ele; self.toolbar_wrap = function(node) {
var strBuilder = []; if (!localStorage.formatText_enable || localStorage.formatText_enable == 'false') return;
var subStr = ''; var parent = $(node).parents('form[name="post"]');
var styleRules = ''; self.wrap(parent.find('#body')[0],'textarea[name="body"]', parent.find('.format-text > select')[0].value, false);
};
//not exactly mine self.wrap = function(ref, target, option, expandedwrap) {
var wrapSelection = function (box, options) { if (!localStorage.formatText_enable || localStorage.formatText_enable == 'false') return;
if (box == null) { // clean and validate arguments
return; if (ref == null) return;
var settings = {multiline: false, exclusiveline: false, prefix:'', suffix: null};
$.extend(settings,JSON.parse(localStorage.formatText_rules)[option]);
// resolve targets into array of proper node elements
// yea, this is overly verbose, oh well.
var res = [];
if (target instanceof Array) {
for (var indexa in target) {
if (target.hasOwnProperty(indexa)) {
if (typeof target[indexa] == 'string') {
var nodes = $(target[indexa]);
for (var indexb in nodes) {
if (indexa.hasOwnProperty(indexb)) res.push(nodes[indexb]);
} }
var prefix = options.prefix; } else {
var suffix = options.suffix; res.push(target[indexa]);
var multiline = options.multiline || false; }
var exclusiveLine = options.exclusiveLine || false; }
}
} else {
if (typeof target == 'string') {
var nodes = $(target);
for (var index in nodes) {
if (nodes.hasOwnProperty(index)) res.push(nodes[index]);
}
} else {
res.push(target);
}
}
target = res;
//record scroll top to restore it later. //record scroll top to restore it later.
var scrollTop = box.scrollTop; var scrollTop = ref.scrollTop;
var selectionStart = box.selectionStart;
var selectionEnd = box.selectionEnd;
var text = box.value;
var beforeSelection = text.substring(0, selectionStart);
var selectedText = text.substring(selectionStart, selectionEnd);
var afterSelection = text.substring(selectionEnd);
//We will restore the selection later, so record the current selection
var selectionStart = ref.selectionStart;
var selectionEnd = ref.selectionEnd;
var text = ref.value;
var before = text.substring(0, selectionStart);
var selected = text.substring(selectionStart, selectionEnd);
var after = text.substring(selectionEnd);
var whiteSpace = [" ","\t"];
var breakSpace = ["\r","\n"]; var breakSpace = ["\r","\n"];
var trailingSpace = ""; var cursor;
var cursor = selectedText.length - 1;
//remove trailing space // handles multiline selections on formatting that doesn't support spanning over multiple lines
while (cursor > 0 && selectedText[cursor] === " ") { if (!settings.multiline) selected = selected.replace(/(\r|\n|\r\n)/g,settings.suffix +"$1"+ settings.prefix);
trailingSpace += " ";
cursor--;
}
selectedText = selectedText.substring(0, cursor + 1);
if (!multiline) // handles formatting that requires it to be on it's own line OR if the user wishes to expand the wrap to the nearest linebreak
selectedText = selectedText.replace(/(\r|\n|\r\n)/g, suffix +"$1"+ prefix); if (settings.exclusiveline || expandedwrap) {
if (exclusiveLine) {
// buffer the begining of the selection until a linebreak // buffer the begining of the selection until a linebreak
cursor = beforeSelection.length -1; cursor = before.length -1;
while (cursor >= 0 && breakSpace.indexOf(beforeSelection.charAt(cursor)) == -1) { while (cursor >= 0 && breakSpace.indexOf(before.charAt(cursor)) == -1) {
cursor--; cursor--;
} }
selectedText = beforeSelection.substring(cursor +1) + selectedText; selected = before.substring(cursor +1) + selected;
beforeSelection = beforeSelection.substring(0, cursor +1); before = before.substring(0, cursor +1);
// buffer the end of the selection until a linebreak // buffer the end of the selection until a linebreak
cursor = 0; cursor = 0;
while (cursor < afterSelection.length && breakSpace.indexOf(afterSelection.charAt(cursor)) == -1) { while (cursor < after.length && breakSpace.indexOf(after.charAt(cursor)) == -1) {
cursor++; cursor++;
} }
selectedText += afterSelection.substring(0, cursor); selected += after.substring(0, cursor);
afterSelection = afterSelection.substring(cursor); after = after.substring(cursor);
} }
box.value = beforeSelection + prefix + selectedText + suffix + trailingSpace + afterSelection; // set values
var res = before + settings.prefix + selected + settings.suffix + after;
$(target).val(res);
box.selectionEnd = beforeSelection.length + prefix.length + selectedText.length; // restore the selection area and scroll of the reference
ref.selectionEnd = before.length + settings.prefix.length + selected.length;
if (selectionStart === selectionEnd) { if (selectionStart === selectionEnd) {
box.selectionStart = box.selectionEnd; ref.selectionStart = ref.selectionEnd;
} else { } else {
box.selectionStart = beforeSelection.length + prefix.length; ref.selectionStart = before.length + settings.prefix.length;
} }
box.scrollTop = scrollTop; ref.scrollTop = scrollTop;
}; };
/* Generate the HTML for the toolbar self.build_toolbars = function(){
*/ if (!localStorage.formatText_enable || localStorage.formatText_enable == 'false') return;
for (ele in formats) { if (localStorage.formatText_toolbar == 'true'){
if (formats.hasOwnProperty(ele) && formats[ele].displayText != null) { // remove existing toolbars
name = formats[ele].displayText; if ($('.format-text').length > 0) $('.format-text').remove();
altText = formats[ele].altText || '';
key = formats[ele].shortcutKey;
//add tooltip text // Place toolbar above each textarea input
if (altText) { var name, options = '', rules = JSON.parse(localStorage.formatText_rules);
if (key) { for (var index in rules) {
altText += ' (ctrl+'+ key +')'; if (!rules.hasOwnProperty(index)) continue;
name = rules[index].text;
//add hint if key exists
if (rules[index].key) {
name += ' (CTRL + '+ rules[index].key.toUpperCase() +')';
} }
altText = 'title="'+ altText +'"'; options += '<option value="'+ index +'">'+ name +'</option>';
}
$('[name="body"]').before('<div class="format-text"><a href="javascript:;" onclick="formatText.toolbar_wrap(this);">Wrap</a><select>'+ options +'</select></div>');
$('body').append('<style>#quick-reply .format-text>a{width:15%;display:inline-block;text-align:center;}#quick-reply .format-text>select{width:85%;};</style>');
}
};
self.add_rule = function(rule, index){
if (rule === undefined) rule = {
text: 'New Rule',
key: '',
multiline:false,
exclusiveline:false,
prefix:'',
suffix:''
} }
subStr = '<a href="javascript:void(0)" '+ altText +' id="tf-'+ ele +'">'+ name +'</a>'; // generate an id for the rule
strBuilder.push(subStr); if (index === undefined) {
var rules = JSON.parse(localStorage.formatText_rules);
while (rules[index] || index === undefined) {
index = ''
index +='abcdefghijklmnopqrstuvwxyz'.substr(Math.floor(Math.random()*26),1);
index +='abcdefghijklmnopqrstuvwxyz'.substr(Math.floor(Math.random()*26),1);
index +='abcdefghijklmnopqrstuvwxyz'.substr(Math.floor(Math.random()*26),1);
}
}
if (window.Options && Options.get_tab('formatting')){
var html = $('<div class="format_rule" name="'+ index +'"></div>').html('\
<input type="text" name="text" class="format_option" size="10" value=\"'+ rule.text.replace(/"/g, '&quot;') +'\">\
<input type="checkbox" name="multiline" class="format_option" '+ (rule.multiline ? 'checked' : '') +'>\
<input type="checkbox" name="exclusiveline" class="format_option" '+ (rule.exclusiveline ? 'checked' : '') +'>\
<input type="text" name="prefix" class="format_option" size="8" value=\"'+ (rule.prefix ? rule.prefix.replace(/"/g, '&quot;') : '') +'\">\
<input type="text" name="suffix" class="format_option" size="8" value=\"'+ (rule.suffix ? rule.suffix.replace(/"/g, '&quot;') : '') +'\">\
<input type="text" name="key" class="format_option" size="2" maxlength="1" value=\"'+ rule.key +'\">\
<input type="button" value="X" onclick="if(confirm(\'Do you wish to remove the '+ rule.text +' formatting rule?\'))$(this).parent().remove();">\
');
if ($('.format_rule').length > 0) {
$('.format_rule').last().after(html);
} else { } else {
continue; Options.extend_tab('formatting', html);
} }
} }
};
$( 'textarea[name="body"]' ).before( '<div class="tf-toolbar"></div>' ); self.save_rules = function(){
$( '.tf-toolbar' ).html( strBuilder.join(' | ') ); var newrules = {}, rules = $('.format_rule');
for (var index=0;rules[index];index++) {
console.log(rules[index]);
newrules[$(rules[index]).attr('name')] = {
text: $(rules[index]).find('[name="text"]').val(),
key: $(rules[index]).find('[name="key"]').val(),
prefix: $(rules[index]).find('[name="prefix"]').val(),
suffix: $(rules[index]).find('[name="suffix"]').val(),
multiline: $(rules[index]).find('[name="multiline"]').is(':checked'),
exclusiveline: $(rules[index]).find('[name="exclusiveline"]').is(':checked')
};
}
console.log(newrules);
localStorage.formatText_rules = JSON.stringify(newrules);
self.build_toolbars();
};
/* Sets the CSS style self.reset_rules = function() {
*/ localStorage.formatText_rules = JSON.stringify(self.rules);
styleRules = '\n/* generated by 8chan Formatting Tools */'+ };
'\n.tf-toolbar {padding: 0px 5px 1px 5px;}'+
'\n.tf-toolbar :link {text-decoration: none;}'; // store default rules for customizing
for (ele in formats) { if (!localStorage.formatText_rules) self.reset_rules();
if (formats.hasOwnProperty(ele) && formats[ele].styleCSS) {
styleRules += ' \n#tf-' + ele + ' {' + formats[ele].styleCSS + '}'; // Add settings to Options panel general tab
} if (window.Options && Options.get_tab('general')) {
} var s1 = '#formatText_enable>input', s2 = '#formatText_toolbar>input', e = 'change';
//add CSS rule to user's custom CSS if it exist Options.extend_tab('general', '<label id="formatText_enable"><input type="checkbox" checked="checked" id="formatText_enable">' + _('Enable post formatting') + '</label>');
if ($( '.user-css' ).length !== 0) { Options.extend_tab('general', '<label id="formatText_toolbar"><input type="checkbox" checked="checked" id="formatText_toolbar">' + _('Show formatting toolbar') + '</label>');
$( '.user-css' ).append( styleRules );
} else { } else {
$( 'body' ).append( '<style>'+ styleRules +'\n</style>' ); var s1 = '#formatText_enable', s2 = '#formatText_toolbar', e = 'click';
$('hr:first').before('<div id="formatText_enable" style="text-align:right"><a class="unimportant" href="javascript:void(0)">'+ _('Enable post formatting') +'</a></div>');
$('hr:first').before('<div id="formatText_toolbar" style="text-align:right"><a class="unimportant" href="javascript:void(0)">'+ _('Show formatting toolbar') +'</a></div>');
} }
/* Attach event listeners // setting for enableing text formatting
*/ $(s1).on(e, function(e) {
$( 'body' ).on( 'keydown', 'textarea[name="body"]', {formats: formats}, function (e) { if (!localStorage.formatText_enable || localStorage.formatText_enable == 'false') {
//shortcuts localStorage.formatText_enable = 'true';
if (e.ctrlKey) { if (window.Options && Options.get_tab('general')) e.target.checked = true;
var ch = String.fromCharCode(e.which).toLowerCase(); } else {
var box = e.target; localStorage.formatText_enable = 'false';
var formats = e.data.formats; if (window.Options && Options.get_tab('general')) e.target.checked = false;
for (var ele in formats) { }
if (formats.hasOwnProperty(ele) && (ch === formats[ele].shortcutKey)) { });
formats[ele].edit(box, formats[ele].options);
// setting for toolbar injection
$(s2).on(e, function(e) {
if (!localStorage.formatText_toolbar || localStorage.formatText_toolbar == 'false') {
localStorage.formatText_toolbar = 'true';
if (window.Options && Options.get_tab('general')) e.target.checked = true;
formatText.build_toolbars();
} else {
localStorage.formatText_toolbar = 'false';
if (window.Options && Options.get_tab('general')) e.target.checked = false;
$('.format-text').remove();
}
});
// make sure the tab settings are switch properly at loadup
if (window.Options && Options.get_tab('general')) {
if (localStorage.formatText_enable == 'true') $(s1)[0].checked = true;
else $(s1)[0].checked = false;
if (localStorage.formatText_toolbar == 'true') $(s2)[0].checked = true;
else $(s2)[0].checked = false;
}
// add the tab for customizing the format settings
if (window.Options && !Options.get_tab('formatting')) {
Options.add_tab('formatting', 'angle-right', 'Customize Formatting');
Options.extend_tab('formatting', '\
<style>\
.format_option{\
margin-right:5px;\
overflow:initial;\
font-size:15px;\
}\
.format_option[type="text"]{\
text-align:center;\
padding-bottom: 2px;\
padding-top: 2px;\
}\
.format_option:last-child{\
margin-right:0;\
}\
</style>\
');
// Data control row
Options.extend_tab('formatting', '\
<button onclick="formatText.add_rule();">Add Rule</button>\
<button onclick="formatText.save_rules();">Save Rules</button>\
<button onclick="formatText.reset_rules();">Reset Rules to Default</button>\
');
// Descriptor row
Options.extend_tab('formatting', '\
<span class="format_option" style="margin-left:25px;">Name</span>\
<span class="format_option" style="margin-left:45px;" title="Multi-line: Allow formatted area to contain linebreaks.">ML</span>\
<span class="format_option" style="margin-left:0px;" title="Exclusive-line: Require formatted area to start after and end before a linebreak.">EL</span>\
<span class="format_option" style="margin-left:25px;" title="Text injected at the start of a format area.">Prefix</span>\
<span class="format_option" style="margin-left:60px;" title="Text injected at the end of a format area.">Suffix</span>\
<span class="format_option" style="margin-left:40px;" title="Optional keybind value to allow keyboard shortcut access.">Key</span>\
');
// Rule rows
var rules = JSON.parse(localStorage.formatText_rules);
for (var index in rules){
if (!rules.hasOwnProperty(index)) continue;
self.add_rule(rules[index], index);
}
}
return self;
})(jQuery);
// run initial toolbar injection
formatText.build_toolbars();
//attach listeners to <body> so it also works on quick-reply box
$('body').on('keydown', '#body, #quick-reply #body', function(e) {
if (!localStorage.formatText_enable || localStorage.formatText_enable == 'false') return;
var key = String.fromCharCode(e.which).toLowerCase();
var rules = JSON.parse(localStorage.formatText_rules);
for (var index in rules) {
if (!rules.hasOwnProperty(index)) continue;
if (key === rules[index].key && e.ctrlKey) {
e.preventDefault(); e.preventDefault();
if (e.shiftKey) {
formatText.wrap(e.target, 'textarea[name="body"]', index, true);
} else {
formatText.wrap(e.target, 'textarea[name="body"]', index, false);
} }
} }
} }
}); });
$( 'body' ).on( 'keydown', '#quick-reply textarea[name="body"]', {formats: formats}, function (e) { $(document).trigger('formatText');
//close quick reply when esc is prssed
if (e.which === 27) {
$( '.close-btn' ).trigger( 'click' );
}
});
$( 'body' ).on( 'click', '.tf-toolbar a[id]', {formats: formats}, function (e) {
//toolbar buttons
var formats = e.data.formats;
var box = $(e.target).parent().next()[0];
for (var ele in formats) {
if (formats.hasOwnProperty(ele) && (e.target.id === 'tf-' + ele)) {
formats[ele].edit(box, formats[ele].options);
}
}
});
// $( 'body' ).on( 'keydown', function (e) {
// if (e.which === 67 &&
// e.target.nodeName !== 'INPUT' && //The C, the whole C, and nothing but the C
// e.target.nodeName !== 'TEXTAREA' &&
// !(e.ctrlKey || e.altKey || e.shiftKey)) {
// document.location.href = '//'+ document.location.host +'/'+ board_name +'/catalog.html';
// }
// });
});
} }