Get a chat for your ActiveAdmin app out of the box.
- It assumes you have models for your admins and users in place.
- It assumes that your users have an
- For production you need to configure ActionCable by providing it with a Redis or Postgres connection in
Add to Gemfile:
And then run:
$ bundle install
$ rails generate active_admin_chat:install
It will generate:
Messagemodels and migrations.
- Initializer that configures the model names for conversation, message, admin user and user.
- Default chat page.
You can customize the namings of the models when installing ActiveAdminChat with the usage of the
$ rails generate active_admin_chat:install --conversation_model_name=chat
Once you've successfully installed ActiveAdminChat, run:
$ rails db:migrate
Add including of CSS to
And including of JS to
#= require active_admin_chat
All you need to get the chat up and running is to authenticate your users in the websocket connection in
app/channels/application_cable/connection.rb. It's important that you identify them as the
current_user here, this will be used by the gem internally.
For example with the
module ApplicationCable class Connection < ActionCable::Connection::Base identified_by :current_user def connect self.current_user = find_verified_user end private def find_verified_user verified_user = env['warden'].user reject_unauthorized_connection unless verified_user verified_user end end end
You can change the chat page name and namespace the same way you do with other ActiveAdmin pages.
If you'd like to change the chat styling you can override the following classes:
.active-admin-chat__title: Title above the conversations list
.active-admin-chat__conversation-item: List of conversations
.active-admin-chat__conversation-history: Conversation panel
.active-admin-chat__message-container: Message in the conversation panel
.active-admin-chat__send-message-container: Send message button
If you'd like to change the whole HTML you can do it in the chat page by specifying its content:
ActiveAdmin.register_chat 'Chat' do content do # your code end end
If you'd like to change the controller actions you can do it in the chat page by specifying its controller:
ActiveAdmin.register_chat 'Chat' do controller do def show # your code end end end
If you'd like to add a button in the user's index in the admin dashboard to start a chat with a user:
ActiveAdmin.register_chat User do index do # your code actions do |user| send_message_link user end end end
Bug reports (please use Issues) and pull requests are welcome on GitHub at https://github.com/rootstrap/active_admin_chat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.