mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 22:13:26 +00:00
7072fa5b37
This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
102 lines
2.8 KiB
JavaScript
102 lines
2.8 KiB
JavaScript
var typing = (function () {
|
|
var exports = {};
|
|
|
|
// This module handles the outbound side of typing indicators.
|
|
// We detect changes in the compose box and notify the server
|
|
// when we are typing. For the inbound side see typing_events.js.
|
|
//
|
|
// See docs/subsystems/typing-indicators.md for details on typing indicators.
|
|
|
|
function send_typing_notification_ajax(recipients, operation) {
|
|
channel.post({
|
|
url: '/json/typing',
|
|
data: {
|
|
to: recipients,
|
|
op: operation,
|
|
},
|
|
success: function () {},
|
|
error: function (xhr) {
|
|
blueslip.warn("Failed to send typing event: " + xhr.responseText);
|
|
},
|
|
});
|
|
}
|
|
|
|
function get_recipient() {
|
|
var compose_recipient = compose_state.recipient();
|
|
if (compose_recipient === "") {
|
|
return undefined;
|
|
}
|
|
return compose_recipient;
|
|
}
|
|
|
|
function is_valid_conversation(recipient) {
|
|
// TODO: Check to make sure we're in a PM conversation
|
|
// with valid emails.
|
|
if (!recipient) {
|
|
return false;
|
|
}
|
|
|
|
var compose_empty = !compose_state.has_message_content();
|
|
if (compose_empty) {
|
|
return false;
|
|
}
|
|
|
|
if (compose_state.get_message_type() !== 'private') {
|
|
// We only use typing indicators in PMs for now.
|
|
// There was originally some support for having
|
|
// typing indicators related to stream conversations,
|
|
// but the initial rollout led to users being
|
|
// confused by them. We may revisit this.
|
|
return false;
|
|
}
|
|
|
|
if (compose.get_invalid_recipient_emails().length > 0) {
|
|
// If we have invalid recipient emails, it's highly
|
|
// likely the user is either still deciding who to
|
|
// compose to, or is confused. Also, the server
|
|
// will just reject our requests.
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
function get_current_time() {
|
|
return new Date();
|
|
}
|
|
|
|
function notify_server_start(recipients) {
|
|
send_typing_notification_ajax(recipients, "start");
|
|
}
|
|
|
|
function notify_server_stop(recipients) {
|
|
send_typing_notification_ajax(recipients, "stop");
|
|
}
|
|
|
|
var worker = {
|
|
get_recipient: get_recipient,
|
|
is_valid_conversation: is_valid_conversation,
|
|
get_current_time: get_current_time,
|
|
notify_server_start: notify_server_start,
|
|
notify_server_stop: notify_server_stop,
|
|
};
|
|
|
|
$(document).on('input', '#new_message_content', function () {
|
|
// If our previous state was no typing notification, send a
|
|
// start-typing notice immediately.
|
|
typing_status.handle_text_input(worker);
|
|
});
|
|
|
|
// We send a stop-typing notification immediately when compose is
|
|
// closed/cancelled
|
|
$(document).on('compose_canceled.zulip compose_finished.zulip', function () {
|
|
typing_status.stop(worker);
|
|
});
|
|
|
|
return exports;
|
|
}());
|
|
|
|
if (typeof module !== 'undefined') {
|
|
module.exports = typing;
|
|
}
|