You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
roundcubemail-swipe/swipe.js

464 lines
20 KiB
JavaScript

/**
* Swipe plugin script
*
* @licstart The following is the entire license notice for the
* JavaScript code in this file.
*
* Copyright (C) 2018-2019 Philip Weir
*
* The JavaScript code in this page is free software: you can redistribute it
* and/or modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* @licend The above is the entire license notice
* for the JavaScript code in this file.
*/
rcube_webmail.prototype.swipe = {
position_target: function(obj, pos, transition, max_move) {
var translate = '';
if (pos && transition) {
if (transition == 'scale') {
pos = pos > 0 ? pos : 0;
translate = 'scale(' + pos / max_move + ')';
}
else {
translate = transition + '(' + pos + 'px)';
}
}
if (bw.edge && $(obj).is('tr')) { // Edge does not support transform on <tr>s
$(obj).children('td').css('transform', translate);
}
else {
$(obj).css('transform', translate);
}
},
action_callback: function(command, props) {
if (!props.uid)
return;
var prev_uid = rcmail.env.uid;
rcmail.env.uid = props.uid;
var type = null;
if (matches = command.match(/([a-z0-9_-]+)\/([a-z0-9-_]+)/)) {
type = matches[1];
command = matches[2];
}
if (type == 'mark') {
rcmail.mark_message(command);
}
else if (type == 'compose') {
rcmail.enable_command(command, true);
rcmail.command(command, '', props.obj, props.originalEvent);
}
else if (type == 'select') {
rcmail.env.swipe_list.highlight_row(props.uid, true);
}
else {
var prev_command = rcmail.commands[command];
rcmail.enable_command(command, true);
// some actions require a button click in the UI to trigger things like popovers
// rather than a direct command call
$('#' + rcmail.buttons[command][0].id).trigger('click');
// restore original state
rcmail.enable_command(command, prev_command);
}
rcmail.env.uid = prev_uid;
},
select_action: function(direction, obj) {
var actions = {
'archive': {
'class': rcmail.env.archive_folder ? 'archive swipe_warning' : null,
'text': rcmail.env.archive_folder ? 'archive.buttontext': null,
'command': rcmail.env.archive_folder ? 'plugin.archive' : null
},
'checkmail': {
'class': 'refresh swipe_primary',
'text': 'refresh',
'callback': function(p) { rcmail.command('checkmail'); }
},
'delete': {
'class': 'delete swipe_danger',
'text': 'delete',
'command': 'delete'
},
'forward': {
'class': 'forward swipe_compose',
'text': 'forward',
'command': 'compose/forward'
},
'markasjunk': {
'class': !rcmail.env.markasjunk_spam_only && rcmail.env.mailbox == rcmail.env.markasjunk_spam_mailbox ? 'notjunk swipe_compose' : 'junk swipe_danger',
'text': !rcmail.env.markasjunk_spam_only && rcmail.env.mailbox == rcmail.env.markasjunk_spam_mailbox ? 'markasjunk.markasnotjunk' : 'markasjunk.markasjunk',
'command': !rcmail.env.markasjunk_spam_only && rcmail.env.mailbox == rcmail.env.markasjunk_spam_mailbox ? 'plugin.markasjunk.not_junk' : 'plugin.markasjunk.junk'
},
'move': {
'class': 'move swipe_warning',
'text': 'moveto',
'command': 'move'
},
'reply': {
'class': 'reply one swipe_compose',
'text': 'reply',
'command': 'compose/reply'
},
'reply-all': {
'class': 'reply all swipe_compose',
'text': 'replyall',
'command': 'compose/reply-all'
},
'swipe-read': {
'class': (obj && obj.hasClass('unread') ? 'read' : 'unread') + ' swipe_primary',
'text': obj && obj.hasClass('unread') ? 'swipe.markasread' : 'swipe.markasunread',
'command': obj && obj.hasClass('unread') ? 'mark/read' : 'mark/unread'
},
'swipe-flagged': {
'class': (obj && obj.hasClass('flagged') ? 'unflag' : 'flag') + ' swipe_primary',
'text': obj && obj.hasClass('flagged') ? 'swipe.markasunflagged' : 'swipe.markasflagged',
'command': obj && obj.hasClass('flagged') ? 'mark/unflagged' : 'mark/flagged'
},
'swipe-select': {
'class': (obj && obj.hasClass('selected') ? 'select invert' : 'select all') + ' swipe_primary',
'text': obj && obj.hasClass('selected') ? 'swipe.deselect' : 'select',
'command': obj && obj.hasClass('selected') ? 'select/deselect' : 'select/select'
},
'none': {
'class': null,
'text': null,
'callback': null,
'command': null
}
};
ret = rcmail.triggerEvent('swipe-action', {'direction': direction, 'obj': obj});
if (ret !== undefined) {
// abort if one of the handlers returned false
return ret === false ? actions['none'] : ret;
}
else if (action = actions[rcmail.env.swipe_actions[direction]]) {
if (!action.callback && action.command) {
action.callback = function(p) { rcmail.swipe.action_callback(action.command, p); };
}
}
else {
// fall back to no action if nothing was found
action = actions['none'];
}
return action;
},
init: function(opts) {
var swipeevents = {
'startevent': 'pointerdown',
'moveevent': 'pointermove',
'endevent': 'pointerup',
'cancelevent': 'pointercancel',
'id': function(e) { return e.pointerId; },
'type': function(e) { return e.pointerType; },
'pos': function(e, x) { return e.originalEvent[ x ? 'pageX' : 'pageY']; },
'clearswipe': function(e) {
rcmail.swipe.position_target(opts[swipedata.axis].target_obj, 0);
opts[swipedata.axis].target_obj.removeClass('swipe-active');
swipedata = {};
rcmail.swipe.active = null;
// reset #swipe-action
$('#swipe-action').removeClass().hide();
$('.swipe-container').attr('class', rcmail.env.swipe_container_class);
$('.swipe-action').attr('class', rcmail.env.swipe_button_class);
if (opts.parent_obj)
opts.parent_obj.off(swipeevents.moveevent, rcube_event.cancel);
}
};
var swipedata = {};
// fallback to touch events if there is no pointer support
if (!bw.pointer) {
swipeevents.startevent = 'touchstart';
swipeevents.moveevent = 'touchmove';
swipeevents.endevent = 'touchend';
swipeevents.cancelevent = 'touchcancel';
swipeevents.id = function(e) { return e.changedTouches.length == 1 ? e.changedTouches[0].identifier : -1; };
swipeevents.type = function(e) { return 'touch'; };
swipeevents.pos = function(e, x) { return e.originalEvent.targetTouches[0][ x ? 'pageX' : 'pageY']; };
}
// swipe on list container
opts.source_obj
.on(swipeevents.startevent, function(e) {
if (!rcmail.swipe.active && swipeevents.type(e) == 'touch') {
swipedata.x = swipeevents.pos(e, true);
swipedata.y = swipeevents.pos(e, false);
swipedata.id = swipeevents.id(e);
swipedata.scrollable = rcmail.swipe.parent[0].offsetHeight < rcmail.swipe.parent[0].scrollHeight;
if (opts.parent_obj)
opts.parent_obj.off(swipeevents.moveevent, rcube_event.cancel);
}
})
.on(swipeevents.moveevent, function(e) {
// make sure no other swipes are active and no other pointers
if (swipedata.id != swipeevents.id(e) || swipeevents.type(e) != 'touch')
return;
var changeX = swipeevents.pos(e, true) - swipedata.x;
var changeY = swipeevents.pos(e, false) - swipedata.y;
// stop the row from sliding off the screen completely
changeY = opts.vertical ? Math.min(opts.vertical.maxmove, changeY) : 0;
changeX = opts.horizontal ? (changeX < 0 ? Math.max(opts.horizontal.maxmove * -1, changeX) : Math.min(opts.horizontal.maxmove, changeX)) : 0;
// use Math.abs() to ensure value is always a positive number
var min_move = 5; // the minimum amount of pointer movement required to trigger the swipe
var temp_axis;
if (opts.vertical && (Math.abs(changeY) > min_move || opts.vertical.target_obj.hasClass('swipe-active'))) {
temp_axis = 'vertical';
}
else if (opts.horizontal && (Math.abs(changeX) > min_move || opts.horizontal.target_obj.hasClass('swipe-active'))) {
temp_axis = 'horizontal';
}
else {
return;
}
// make sure no other swipes are active
if (!temp_axis || !opts[temp_axis] || (rcmail.swipe.active && rcmail.swipe.active != temp_axis))
return;
// do not interfere with normal list scrolling
if (temp_axis == 'vertical' && rcmail.swipe.parent.scrollTop() != 0) {
if (bw.pointer && swipedata.scrollable)
rcmail.swipe.parent.css('touch-action', 'pan-y');
if (swipedata.axis)
swipeevents.clearswipe(e);
return;
}
// save the axis info
swipedata.axis = temp_axis;
var direction = (swipedata.axis == 'vertical' ? 'down' : (changeX < 0 ? 'left' : 'right'));
var action = rcmail.swipe.select_action(direction, opts.source_obj);
// if there is no callback then abort
if (!action.callback)
return;
$('#swipe-action').attr('class', temp_axis).data('callback', action.callback);
$('.swipe-container').attr('class', rcmail.env.swipe_container_class + ' ' + direction);
$('.swipe-action').attr('class', rcmail.env.swipe_button_class + ' ' + action.class);
$('.swipe-label').text(rcmail.gettext(action.text));
if (!opts[swipedata.axis].target_obj.hasClass('swipe-active')) {
var action_style = opts[swipedata.axis].action_sytle(opts[swipedata.axis].target_obj);
$('#swipe-action').css({
'top': action_style.top,
'left': action_style.left,
'width': action_style.width,
'height': action_style.height
}).show();
opts[swipedata.axis].target_obj.addClass('swipe-active');
rcmail.swipe.active = swipedata.axis; // set the active swipe
if (opts.parent_obj)
opts.parent_obj.on(swipeevents.moveevent, rcube_event.cancel);
}
// the user must swipe a certain about before the action is activated, try to prevent accidental actions
// do not activate if there is no callback
if (((swipedata.axis == 'vertical' && changeY > opts[swipedata.axis].minmove) ||
(swipedata.axis == 'horizontal' && (changeX < (opts[swipedata.axis].minmove * -1) || changeX > opts[swipedata.axis].minmove))) && action.callback) {
$('#swipe-action').addClass(action.class);
}
else {
// reset the swipe if the user takes the row back to the start
$('#swipe-action').removeClass(action.class);
$('#swipe-action').data('callback', null);
}
var pos = swipedata.axis == 'vertical' ? changeY : changeX;
rcmail.swipe.position_target(opts[swipedata.axis].target_obj, pos, opts[swipedata.axis].transition, opts[swipedata.axis].maxmove);
})
.on(swipeevents.endevent, function(e) {
if (swipeevents.type(e) == 'touch' && swipedata.id == swipeevents.id(e) && rcmail.swipe.active &&
rcmail.swipe.active == swipedata.axis && opts[swipedata.axis].target_obj.hasClass('swipe-active')) {
var callback = null;
if (callback = $('#swipe-action').data('callback'))
callback({'uid': opts[swipedata.axis].uid, 'obj': opts[swipedata.axis].target_obj, 'originalEvent': e});
swipeevents.clearswipe(e);
}
})
.on(swipeevents.cancelevent, function(e) {
if (swipedata.axis)
swipeevents.clearswipe(e);
});
}
};
$(document).ready(function() {
if (window.rcmail && ((bw.touch && !bw.ie) || bw.pointer)) {
rcmail.addEventListener('init', function() {
rcmail.env.swipe_list = rcmail.message_list;
rcmail.env.swipe_menuname = 'messagelistmenu';
rcmail.env.swipe_container_class = 'swipe-container toolbarmenu';
rcmail.env.swipe_button_class = 'swipe-action';
var list_container = $(rcmail.env.swipe_list.list).parent();
if (rcmail.env.swipe_list.draggable || !list_container[0].addEventListener)
return;
// minic toolbarmenu structure to pickup CSS from core
var swipe_action = $('<div>').attr('id', 'swipe-action').append(
$('<ul>').addClass(rcmail.env.swipe_container_class).append($('<li>').append($('<a>').addClass(rcmail.env.swipe_button_class).append($('<span>').addClass('swipe-label'))))
);
rcmail.swipe.parent = list_container;
rcmail.swipe.parent.prepend(swipe_action.hide());
// down swipe on list container
var swipe_config = {
'source_obj': rcmail.swipe.parent,
'parent_obj': null,
'vertical': {
'minmove': $(window).height() * 0.19,
'maxmove': $(window).height() * 0.2,
'transition': 'scale',
'action_sytle': function(o) {
return {
'top': '',
'left': 0,
'width': rcmail.swipe.parent.width() + 'px',
'height': ''
};
},
'target_obj': $('#swipe-action'),
'uid': null
}
};
rcmail.swipe.init(swipe_config);
// prevent accidental list scroll when swipe active
rcmail.swipe.parent.on('scroll', function() {
if (!bw.pointer) {
if (rcmail.swipe.active)
return false;
}
else if ($(this).scrollTop() == 0) {
// allow vertical pointer events to fire (if one is configured)
var action = rcmail.swipe.select_action('down');
// Edge does not support pan-down, only pan-y
rcmail.swipe.parent.css('touch-action', action.callback && ! bw.edge ? 'pan-down' : 'pan-y');
}
}).trigger('scroll');
});
// right/left/down swipe on list
rcmail.addEventListener('insertrow', function(props) {
if (rcmail.env.swipe_list.draggable || !$('#' + props.row.id)[0].addEventListener)
return;
var row_width = $('#' + props.row.id).width();
// if no row width is available then use window width as fall back
row_width = row_width == 0 ? $(window).width() : row_width;
var swipe_config = {
'source_obj': $('#' + props.row.id),
'parent_obj': rcmail.swipe.parent,
'horizontal': {
'minmove': row_width * 0.25,
'maxmove': row_width * 0.6,
'transition': 'translatex',
'action_sytle': function(o) {
return {
'top': o.position().top,
'left': o.position().left,
'width': o.width() + 'px',
'height': (o.height() - 2) + 'px' // subtract the border
};
},
'target_obj': $('#' + props.row.id),
'uid': props.uid
}
};
rcmail.swipe.init(swipe_config);
});
// save swipe options
rcmail.set_list_options_core = rcmail.set_list_options;
rcmail.set_list_options = function(cols, sort_col, sort_order, threads, layout) {
var post = {};
$.each(['left', 'right', 'down'], function() {
var option_input = $('.swipeoptions-' + this).find('select,input').first();
if ($(option_input).is('input[type="radio"]')) {
selector = 'input[name="swipe_' + this + '"]:checked';
}
else if ($(option_input).is('select')) {
selector = 'select[name="swipe_' + this + '"]';
selector += $(selector).length > 1 ? ':visible' : '';
}
if ($(selector).val() != rcmail.env.swipe_actions[this]) {
rcmail.env.swipe_actions[this] = $(selector).val();
post['swipe_' + this] = rcmail.env.swipe_actions[this];
}
});
if (!$.isEmptyObject(post))
rcmail.http_post('plugin.swipe.save_settings', post);
rcmail.set_list_options_core(cols, sort_col, sort_order, threads, layout);
};
}
// show swipe options in the list options menu
rcmail.addEventListener('beforemenu-open', function(name) {
if (name == rcmail.env.swipe_menuname) {
var menu_obj = $('.swipe-menu');
if (!rcmail.env.swipe_list.draggable && menu_obj.find('select > option,input').length > 0) {
if (bw.edge)
menu_obj.find('.swipeoptions-down').hide();
menu_obj.show();
}
else {
menu_obj.hide();
}
}
});
// set the values swipe options menu
// done in menu-open not beforemenu-open because of Elastic's Bootstrap popovers
rcmail.addEventListener('menu-open', function(p) {
if (p.name == rcmail.env.swipe_menuname && $('.swipe-menu').is(':visible')) {
$.each(rcmail.env.swipe_actions, function(direction, action) {
var option_input = $('.swipeoptions-' + direction).find('select,input');
if (option_input.is('input[type="radio"]')) {
option_input.filter('[value="' + action + '"]').prop('checked', true);
}
else if (option_input.is('select') && option_input.first().children('option').length > 0) {
option_input.val(action);
}
else {
$('.swipeoptions-' + direction).hide();
}
});
}
});
});