PHPackages                             linkrobins/shoutbox - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. linkrobins/shoutbox

ActiveFlarum-extension[Utility & Helpers](/categories/utility)

linkrobins/shoutbox
===================

Shoutbox widget for fof/forum-widgets-core

v1.3.0(1w ago)085↑76.5%MITTypeScriptPHP ^8.3

Since May 8Pushed 1w agoCompare

[ Source](https://github.com/linkrobins/shoutbox)[ Packagist](https://packagist.org/packages/linkrobins/shoutbox)[ RSS](/packages/linkrobins-shoutbox/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (7)Dependencies (2)Versions (7)Used By (0)

Link Robins Shoutbox
====================

[](#link-robins-shoutbox)

A real-time shoutbox widget for [Flarum 2.0](https://flarum.org), built as a widget for [`fof/forum-widgets-core`](https://github.com/FriendsOfFlarum/forum-widgets-core).

Features
--------

[](#features)

- **Live shoutbox** in any widget placement (sidebar, top, bottom, full-width sections)
- **Polling-based updates** every 15 seconds
- **Adaptive button** — icon-only when placed in the sidebar, icon + "Send" when placed in full-width sections
- **Configurable height** — admins can set the messages area height in the extension settings
- **Permission-aware** — usernames link to profiles only if the viewer has `viewForum` permission
- **Guest-friendly** — guests see the most recent 10 messages and a "Log in to shout!" prompt; members see the most recent 30 and can post
- **Admin-only deletion** — only administrators can delete shouts
- **280-character limit** per shout (Twitter-style)
- **Avatar fallback** — users without an avatar get a coloured letter avatar with a deterministic per-user colour

Requirements
------------

[](#requirements)

- Flarum **2.0** or later
- [`fof/forum-widgets-core`](https://github.com/FriendsOfFlarum/forum-widgets-core) installed and enabled

Installation
------------

[](#installation)

```
composer require linkrobins/shoutbox
php flarum migrate
php flarum cache:clear

```

4. In Flarum admin → **Extensions**, find **Link Robins Shoutbox** under the **Forum Widgets** category and enable it.
5. Open `fof/forum-widgets-core` settings and place the Shoutbox widget where you want it (sidebar, top, bottom, etc.).

Settings
--------

[](#settings)

- **Messages height (px)** — height of the scrollable messages area. Default is 320 pixels. Range is 100–1000.

Permissions
-----------

[](#permissions)

The shoutbox is intentionally simple about permissions.

Styling
-------

[](#styling)

The widget uses Flarum 2's CSS custom properties (`var(--primary-color)`, `var(--text-color)`, etc.) so it picks up your theme automatically. The send button shape changes based on placement, detected via parent class:

- `.sideNav`, `.IndexPage-nav`, `.FofWidgets-sideNavAlt` ancestors → icon-only square button
- Everything else (top, bottom, full-width sections) → icon + "Send" label

If you want to override styles, target `.ShoutboxWidget` and its modifier classes from your custom Less in **Admin → Appearance**.

Troubleshooting
---------------

[](#troubleshooting)

**Widget doesn't appear in `fof/forum-widgets-core` config page:**Run `php flarum cache:clear` and reload the admin page. If it still doesn't appear, verify the extension is enabled in **Extensions**.

**500 error on the homepage after enabling:**Almost always a missing migration. Run `php flarum migrate`. If it persists, check `storage/logs/flarum-YYYY-MM-DD.log` for the actual exception.

**Shouts post but don't appear until refresh:**Polling is set to 15 seconds. If you're seeing longer delays, check the browser's network tab for failing `GET /api/shoutbox` requests.

License
-------

[](#license)

MIT

###  Health Score

45

—

FairBetter than 91% of packages

Maintenance98

Actively maintained with recent releases

Popularity13

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

6

Last Release

10d ago

PHP version history (2 changes)v1.0.0PHP ^8.2

v1.1.0PHP ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/6ba4ada28098b217152b5ec67bff43409a54b808d7d038119af6f56715a1c3f9?d=identicon)[linkrobins](/maintainers/linkrobins)

---

Top Contributors

[![linkrobins](https://avatars.githubusercontent.com/u/213107296?v=4)](https://github.com/linkrobins "linkrobins (10 commits)")

### Embed Badge

![Health badge](/badges/linkrobins-shoutbox/health.svg)

```
[![Health](https://phpackages.com/badges/linkrobins-shoutbox/health.svg)](https://phpackages.com/packages/linkrobins-shoutbox)
```

###  Alternatives

[flarum-lang/russian

Russian language pack for Flarum.

12127.5k](/packages/flarum-lang-russian)[fof/byobu

Well integrated, advanced private discussions.

61112.4k10](/packages/fof-byobu)[flarum/tags

Organize discussions into a hierarchy of tags and categories.

38744.9k133](/packages/flarum-tags)[fof/gamification

Upvotes and downvotes for your Flarum community

4162.0k6](/packages/fof-gamification)[fof/polls

 A Flarum extension that adds polls to your discussions

25130.2k9](/packages/fof-polls)[michaelbelgium/flarum-discussion-views

Add views to flarum discussions

3155.4k6](/packages/michaelbelgium-flarum-discussion-views)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)