Team Chat

• Why Filament Team Chat?
• Screenshots
• Features
  • Messaging
  • Collaboration
  • Awareness
  • Management
  • Technical
• Installation
• Getting Started
  • 1. Register the Plugin
  • 2. Add the Trait to Your User Model
  • 3. Notifications Table (if needed)
  • 4. Tailwind CSS Setup
• Configuration
  • Multi-Tenancy
• Programmatic API
  • Channels & DMs
  • Messages
  • Reactions, Read Tracking, Search
• Architecture
  • Database
  • Livewire Components
• Testing
• Changelog
• License

A complete Slack-like team chat for Filament v5. Drop it into any panel — channels, DMs, threads, reactions, mentions, file sharing, search, and unread tracking work out of the box. Self-hosted, no external services needed.

#Why Filament Team Chat?

• Zero external dependencies — No Pusher, no Redis, no WebSocket server. Works with Livewire polling out of the box.
• Filament-native — Lives inside your Filament panel. Uses your existing auth, your existing users, your existing database.
• Multi-tenant ready — Optional team_id scoping with automatic Filament tenant detection.
• Self-hosted — Your data stays on your server. No third-party chat services.

#Screenshots

Threaded Conversations Click any message to reply in a side panel — just like Slack.	File Attachments Share images (with inline preview) and documents.
Dark Mode Full dark mode support, following your Filament panel theme.

#Features

#Messaging

• Channels — Public and private channels with member management
• Direct Messages — 1-on-1 and group DMs
• Threads — Reply to any message in a side panel, with reply count on the main feed
• Markdown — Messages support bold, italic, code, lists, and links
• Edit & Delete — Edit or soft-delete your own messages (hover action bar)

#Collaboration

• Reactions — 8 built-in emoji reactions (toggle on/off)
• @Mentions — @user, @channel, @here with live autocomplete
• File Attachments — Upload multiple files per message, image previews, download links
• Search — Full-text search across all channels and DMs you belong to

#Awareness

• Unread Badges — Per-channel/DM unread counts with automatic read tracking
• Instant Refresh — Your own messages appear immediately; others update via polling
• Online Status — Presence indicators and custom status text
• Notifications — Database notifications for @mentions and DMs

#Management

• Inline Channel Settings — Edit name, topic, and visibility directly in the chat header (owner only)
• Archive Channels — Soft-archive channels to hide them from the sidebar
• Public Auto-Join — Public channels appear for all users; clicking auto-joins
• Member List — View channel/DM members with online indicators and profile cards

#Technical

• Multi-Tenancy — Optional team_id scoping with Filament tenant auto-detection
• Dark Mode — Follows your Filament panel theme
• 102 Tests — Comprehensive test suite with Orchestra Testbench

#Installation

composer require qalainau/filament-team-chat

Publish and run the migrations:

php artisan vendor:publish --tag=team-chat-migrations
php artisan migrate

#Getting Started

#1. Register the Plugin

use Filament\TeamChat\FilamentTeamChatPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugin(FilamentTeamChatPlugin::make());
}

#2. Add the Trait to Your User Model

use Filament\TeamChat\Concerns\HasTeamChat;

class User extends Authenticatable
{
    use HasTeamChat;
}

#3. Notifications Table (if needed)

Required for @mention and DM notifications:

php artisan make:notifications-table
php artisan migrate

#4. Tailwind CSS Setup

The plugin uses Tailwind CSS classes that must be included in your Filament theme.

If you don't have a custom theme yet, create one first:

php artisan filament:theme

Then add the package views as a source in your theme file:

/* resources/css/filament/admin/theme.css */
@source '../../../../vendor/qalainau/filament-team-chat/resources/views/**/*';

Build the theme:

npm run build

Done! Visit /admin/team-chat to start chatting.

#Configuration

Publish the config file:

php artisan vendor:publish --tag=team-chat-config

// config/team-chat.php
return [
    'table_prefix' => 'tc_',

    'user_model' => \App\Models\User::class,

    'polling' => [
        'messages' => 3,  // seconds
        'sidebar' => 5,   // seconds
    ],

    'uploads' => [
        'disk' => 'public',
        'directory' => 'team-chat-attachments',
        'max_size' => 10240, // KB
    ],

    'tenancy' => [
        'enabled' => false,
        'model' => null,    // e.g. \App\Models\Team::class
        'resolver' => null, // null = Filament::getTenant()
    ],
];

#Multi-Tenancy

Set tenancy.enabled to true to scope channels and conversations per team. The resolver supports:

#Programmatic API

All features are available as PHP classes — useful for seeders, commands, or integrations.

#Channels & DMs

use Filament\TeamChat\Models\Channel;

// Create a channel
$channel = Channel::create([
    'name' => 'general',
    'slug' => 'general',
    'type' => 'public', // or 'private'
    'created_by' => $user->id,
]);
$channel->members()->attach($user->id, ['role' => 'owner']);

// DMs (idempotent — returns existing conversation if found)
$dm = $user->findOrCreateDirectMessage($otherUser->id);

// Group DM
$group = $user->createGroupConversation(
    userIds: [$user2->id, $user3->id],
    name: 'Project Team',
);

#Messages

use Filament\TeamChat\Actions\SendMessage;

$message = app(SendMessage::class)->execute(
    messageable: $channel,    // Channel or Conversation
    userId: $user->id,
    body: 'Hello @Jordan! Check this **bold** text.',
    parentId: null,           // set for thread replies
    files: [],                // array of UploadedFile
);

#Reactions, Read Tracking, Search

use Filament\TeamChat\Actions\{ToggleReaction, MarkAsRead, SearchMessages};

// Toggle reaction (returns true=added, false=removed)
app(ToggleReaction::class)->execute($message->id, $user->id, '👍');

// Unread count
$channel->unreadCountFor($user->id); // => 3

// Mark as read
app(MarkAsRead::class)->execute($channel, $user->id);

// Search (respects channel/DM membership)
$results = app(SearchMessages::class)->execute($user->id, 'deploy', limit: 20);

#Architecture

#Database

All tables use a configurable tc_ prefix:

#Livewire Components

#Testing

# Run in the package directory
composer test

# Or in your Laravel app
php artisan test --filter=TeamChat

102 tests covering channels, DMs, threads, reactions, mentions, attachments, search, read receipts, notifications, user status, and channel management.

#Changelog

Please see CHANGELOG for more information on what has changed recently.

#License

The MIT License (MIT). Please see License File for more information.