Skip to content

Latest commit

 

History

History
executable file
·
142 lines (95 loc) · 4.68 KB

README.md

File metadata and controls

executable file
·
142 lines (95 loc) · 4.68 KB
Raw

Private Message Messenger

Private messages in Drupal 8, that look like sweet!

This is "Facebook messenger" style UX for the Private Message module.

The whole UX is build using Backbone & Marionette, making it a snappy single page app. View messages, chnage threads, compose and reply to messages without a single page reload.

It is build with mobile in mind and will switch between mobile/desktop layout as space provides.

Screenshots

Desktop

Desktop

Mobile

Inbox

thread

Dependencies

Private Message

The Private Message module provides the framework for this module to work. It does a great job of handling message and thread structure using entites.

MarionetteJS

This module utilizes MarionetteJS to improve on BackboneJS capabilities. As of writing, it is not on drupal.org yet. Grab it from: https://github.com/jez500/Drupal8-Marionette-JS

This module was built using Marionette v3.5.1, download the zip from https://marionettejs.com/download/ and extract into your /libraries folder.

Selectize

The selectize JS library is used for adding new recipients to messages, install the Selectize drupal module and download the library to your /libraries folder.

Installation

Composer only instructions until I work out what to do with this module.

1. Add repo and install Private Message Messenger with deps

Add the repo to your composer.json

    "repositories": [
        ...

        {
            "type": "git",
            "url": "https://github.com/jez500/Drupal8-Marionette-JS.git"
        },
        {
            "type": "git",
            "url": "https://github.com/jez500/Private-Message-Messenger.git"
        }
    ],

Then... composer require drupal/marionettejs

And... composer require drupal/private_message_messenger

3. Download libraries

Download and extract the following to the /libraries folder

3. Enable

drush en -y private_message_messenger

4. Configure

  • Go to /admin/config/private_message/config and set preferred configuration then Save
  • Set the permission to use private message for the required roles.
  • Visit /messenger to see the messenger page
  • Blocks:
    • The Recent Messenger Messages block provides a dropdown containing recent messages
    • The Private Message Messenger block is the same as the /messenger page just exposed in a block

Docs for private_message: https://www.drupal.org/docs/8/modules/private-message

Paths

  • Thread path /messenger#thread-[THREAD_ID] eg /messenger#thread-1
  • Compose new message path /messenger#new
  • Compose new message to a specific user /messenger#new-[UID] eg /messenger#new-1]
  • Inbox (Only really applies to mobile, but will also refresh inbox) /messenger#new

Optional

Instant updates and notifications without polling

See Private Message NodeJS which was specifically made to compliment this module.

Improved timestamps

To make the dates on threads and messages look a lot nicer and use a live XX mins ago style format, you can include the timeago library in your theme, along with a behaviour that looks like this:

  Drupal.behaviors.timeAgoUpdate = {
    attach: function attach(context) {
      $('.pmm-timestamp', context).once('pmm-timestamp').each(function(){
        timeago().render(this);
      });
    }
  }

Todo's / Wishlist

  • Look into token validation
  • Email - Correct url / allow override of email notification template
  • Create a private_message_nodejs module that eliminates the need for polling and provides instant updates.
  • Pagination for thread list and message list
    • Currently thread list is limited to specified config
    • Currently ALL messages are shown in a loaded thread, have tested with 100's of messages and JSON response is still very small eg < 30k. More of a problem could potentially be the browser rendering that much, but no issues observed yet.

Author

This module is created by Jeremy Graham but wouldn't be possible without all the great work done by Jaypan on the Private Message module