File size: 8,938 Bytes
01cd082 |
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 |
// Add help panel at right side of notebook window
define([
'require',
'jqueryui',
'base/js/namespace',
'base/js/events',
], function (
requirejs,
$,
IPython,
events
) {
'use strict';
/**
* try to get bootstrap tooltip plugin.
* The require call may fail, since the plugin doesn't seem to be included
* in all Jupyter versions. In this case, we fallback to using jqueryui tooltips.
*/
var have_bs_tooltips = false;
requirejs(
['components/bootstrap/js/tooltip'],
// we don't actually need to do anything with the return
// just ensure that the plugin gets loaded.
function () { have_bs_tooltips = true; },
// The errback, error callback
// The error has a list of modules that failed
function (err) {
var failedId = err.requireModules && err.requireModules[0];
if (failedId === 'components/bootstrap/js/tooltip') {
// could do something here, like load a cdn version.
// For now, just ignore it.
have_bs_tooltips = false;
}
}
);
// define default values for config parameters
var params = {
help_panel_add_toolbar_button: false
};
// update params with any specified in the server's config file
function update_params () {
var config = IPython.notebook.config;
for (var key in params) {
if (config.data.hasOwnProperty(key))
params[key] = config.data[key];
}
}
var initialize = function () {
update_params();
if (params.help_panel_add_toolbar_button) {
$(IPython.toolbar.add_buttons_group([
IPython.keyboard_manager.actions.register({
help : 'Show help panel',
icon : 'fa-book',
handler: function() {
var visible = toggleHelpPanel();
var btn = $(this);
setTimeout(function() { btn.blur(); }, 500);
}
}, 'show-help-panel', 'help_panel'),
])).find('.btn').attr({
id: 'btn_help_panel',
'data-toggle': 'button',
'aria-pressed': 'false'
});
}
};
var side_panel_min_rel_width = 10;
var side_panel_max_rel_width = 90;
var side_panel_start_width = 45;
var build_side_panel = function (main_panel, side_panel, min_rel_width, max_rel_width) {
if (min_rel_width === undefined) min_rel_width = 0;
if (max_rel_width === undefined) max_rel_width = 100;
side_panel.css('display','none');
side_panel.insertAfter(main_panel);
var side_panel_splitbar = $('<div class="side_panel_splitbar"/>');
var side_panel_inner = $('<div class="side_panel_inner"/>');
var side_panel_expand_contract = $('<i class="btn fa fa-expand hidden-print">');
side_panel.append(side_panel_splitbar);
side_panel.append(side_panel_inner);
side_panel_inner.append(side_panel_expand_contract);
side_panel_expand_contract.attr({
title: 'expand/contract panel',
'data-toggle': 'tooltip'
}).tooltip({
placement: 'right'
}).click(function () {
var open = $(this).hasClass('fa-expand');
var site = $('#site');
slide_side_panel(main_panel, side_panel,
open ? 100 : side_panel.data('last_width') || side_panel_start_width);
$(this).toggleClass('fa-expand', !open).toggleClass('fa-compress', open);
var tooltip_text = (open ? 'shrink to not' : 'expand to') + ' fill the window';
if (open) {
side_panel.insertAfter(site);
site.slideUp();
$('#header').slideUp();
side_panel_inner.css({'margin-left': 0});
side_panel_splitbar.hide();
}
else {
side_panel.insertAfter(main_panel);
$('#header').slideDown();
site.slideDown({
complete: function() { events.trigger('resize-header.Page'); }
});
side_panel_inner.css({'margin-left': ''});
side_panel_splitbar.show();
}
if (have_bs_tooltips) {
side_panel_expand_contract.attr('title', tooltip_text);
side_panel_expand_contract.tooltip('hide').tooltip('fixTitle');
}
else {
side_panel_expand_contract.tooltip('option', 'content', tooltip_text);
}
});
// bind events for resizing side panel
side_panel_splitbar.mousedown(function (md_evt) {
md_evt.preventDefault();
$(document).mousemove(function (mm_evt) {
mm_evt.preventDefault();
var pix_w = side_panel.offset().left + side_panel.outerWidth() - mm_evt.pageX;
var rel_w = 100 * (pix_w) / side_panel.parent().width();
rel_w = rel_w > min_rel_width ? rel_w : min_rel_width;
rel_w = rel_w < max_rel_width ? rel_w : max_rel_width;
main_panel.css('width', (100 - rel_w) + '%');
side_panel.css('width', rel_w + '%').data('last_width', rel_w);
});
return false;
});
$(document).mouseup(function (mu_evt) {
$(document).unbind('mousemove');
});
return side_panel;
};
var slide_side_panel = function (main_panel, side_panel, desired_width) {
var anim_opts = {
step : function (now, tween) {
main_panel.css('width', 100 - now + '%');
}
};
if (desired_width === undefined) {
if (side_panel.is(':hidden')) {
desired_width = (side_panel.data('last_width') || side_panel_start_width);
}
else {
desired_width = 0;
}
}
var visible = desired_width > 0;
if (visible) {
main_panel.css({float: 'left', 'overflow-x': 'auto'});
side_panel.show();
}
else {
anim_opts['complete'] = function () {
side_panel.hide();
main_panel.css({float : '', 'overflow-x': '', width: ''});
};
}
side_panel.animate({width: desired_width + '%'}, anim_opts);
return visible;
};
var populate_side_panel = function(side_panel) {
var side_panel_inner = side_panel.find('.side_panel_inner');
var qh = IPython.quick_help;
var strip_modal = function(into) {
// strip qh modal, insert content into element 'into'
$('.quickhelp').closest('.modal-body').children().children().appendTo(into);
};
if ($('.quickhelp').length > 0) {
strip_modal(side_panel_inner);
}
else {
// ensure quickhelp shortcuts modal won't show
$('body').addClass('help_panel_hide');
// get quickhelp to show shortcuts
qh.show_keyboard_shortcuts();
// attach handler for qh showing shortcuts
var qh_dia = $(qh.shortcut_dialog);
qh_dia.on('shown.bs.modal', function(evt) {
strip_modal(side_panel_inner);
// delicately pretend that it was never shown, unbind handlers
qh_dia.on('hidden.bs.modal', function () {
$('body').removeClass('help_panel_hide');
qh_dia.off('hidden.bs.modal');
}).off('shown.bs.modal').modal("hide");
});
}
// make sure content we stripped will be rebuilt
qh.force_rebuild = true;
};
var toggleHelpPanel = function () {
var main_panel = $('#notebook_panel');
var side_panel = $('#side_panel');
if (side_panel.length < 1) {
side_panel = $('<div id="side_panel"/>');
build_side_panel(main_panel, side_panel,
side_panel_min_rel_width, side_panel_max_rel_width);
populate_side_panel(side_panel);
}
var visible = slide_side_panel(main_panel, side_panel);
if (params.help_panel_add_toolbar_button) {
$('#btn_help_panel').toggleClass('active', visible);
}
return visible;
};
var load_ipython_extension = function () {
$('head').append(
$('<link/>', {
rel: 'stylesheet',
type:'text/css',
href: requirejs.toUrl('./help_panel.css')
})
);
return IPython.notebook.config.loaded.then(initialize);
};
return {
load_ipython_extension : load_ipython_extension
};
});
|