PHPackages                             fof/forum-widgets-core - 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. [Framework](/categories/framework)
4. /
5. fof/forum-widgets-core

ActiveFlarum-extension[Framework](/categories/framework)

fof/forum-widgets-core
======================

Core Extension for Managing Forum Widgets

1.0.0(3mo ago)14.1k↓49.5%1[2 issues](https://github.com/FriendsOfFlarum/forum-widgets-core/issues)11MITTypeScriptPHP ^8.2CI passing

Since Apr 12Pushed 3mo agoCompare

[ Source](https://github.com/FriendsOfFlarum/forum-widgets-core)[ Packagist](https://packagist.org/packages/fof/forum-widgets-core)[ Docs](https://friendsofflarum.org)[ Fund](https://opencollective.com/fof/donate)[ RSS](/packages/fof-forum-widgets-core/feed)WikiDiscussions 2.x Synced 1w ago

READMEChangelog (4)Dependencies (2)Versions (7)Used By (11)

FoF Forum Widgets
=================

[](#fof-forum-widgets)

[![License](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Latest Stable Version](https://camo.githubusercontent.com/a33e9ea4f69e69d2de2f523be85508431836f2116e57f283a2c850ac89cf822c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f666f662f666f72756d2d776964676574732d636f72652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/fof/forum-widgets-core)[![Total Downloads](https://camo.githubusercontent.com/ded1d86941f0221a65fb1e75560bacd1795860870abc47b99d7cf04cb2fa6636/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f666f662f666f72756d2d776964676574732d636f72652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/fof/forum-widgets-core)

A [Flarum](http://flarum.org) extension. Core framework for managing forum widgets.

[![animated screenshot](https://user-images.githubusercontent.com/20267363/127786249-4f17bb07-9dfb-4066-8d91-6c92b61358cd.gif)](https://user-images.githubusercontent.com/20267363/127786249-4f17bb07-9dfb-4066-8d91-6c92b61358cd.gif)

[![forum screenshot](https://user-images.githubusercontent.com/20267363/127903214-a96f08ba-1a71-42b0-bc17-5b2c65a68859.png)](https://user-images.githubusercontent.com/20267363/127903214-a96f08ba-1a71-42b0-bc17-5b2c65a68859.png)

Note

This package was previously maintained as [`afrux/forum-widgets-core`](https://github.com/afrux/forum-widgets-core) by [@SychO9](https://github.com/SychO9). It has been transferred to FriendsOfFlarum and is now published as `fof/forum-widgets-core`. The `composer.json` `replace` field ensures existing installs upgrade transparently — no manual removal needed.

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

[](#installation)

Remember that this is just a forum widgets editor, it doesn't actually come with any widgets.

```
composer require fof/forum-widgets-core:"*"
```

### Migrating from `afrux/forum-widgets-core`

[](#migrating-from-afruxforum-widgets-core)

If you currently have `afrux/forum-widgets-core` installed, run:

```
composer require fof/forum-widgets-core:"*"
composer remove afrux/forum-widgets-core
php flarum cache:clear
```

Updating
--------

[](#updating)

```
composer update fof/forum-widgets-core:"*"
php flarum migrate
php flarum cache:clear
```

Extend
------

[](#extend)

Extension developers wanting to create widgets with this small framework, the following explains how you can register a new widget, for now you should only register one widget per extension.

1. Require this extension in your extension's `composer.json`:

```
"require": {
  "flarum/core": "^2.0.0",
  "fof/forum-widgets-core": "^2.0.0"
}
```

2. Create your widget's component in `common/components` by extending the base `Widget` component:

```
import Widget from 'ext:fof/forum-widgets-core/common/components/Widget';

export default class MyWidget extends Widget {
  className() {
    // Custom class name.
    // Use "FofWidgets-Widget--flat" for a flat widget (no container block).
    return 'MyWidget';
  }

  icon() {
    return 'fas fa-circle';
  }

  title() {
    return app.translator.trans('my-extension.forum.widget.title');
  }

  content() {
    return ...;
  }
}
```

3. Register your widget in both frontends. Create `common/registerWidget.js`:

```
import Widgets from 'ext:fof/forum-widgets-core/common/extend/Widgets';
import MyWidget from './components/MyWidget';

export default function (app) {
  new Widgets()
    .add({
      key: 'myWidget',
      component: MyWidget,
      // Can be a callback: () => app.forum.attribute('mySetting')
      isDisabled: false,
      // Is this a one-time-use widget? Leave true if unsure.
      isUnique: true,
      // Default values, overridable by the admin.
      placement: 'end',
      position: 1,
    })
    .extend(app, 'my-extension-id');
}
```

Then in both `admin/index.js` and `forum/index.js`:

```
import registerWidget from '../common/registerWidget';

app.initializers.add('my-extension-id', () => {
  registerWidget(app);
});
```

4. For TypeScript, add this to the `paths` key in your `tsconfig.json`:

```
"ext:fof/forum-widgets-core/*": ["../vendor/fof/forum-widgets-core/js/dist-typings/*"]
```

Links
-----

[](#links)

- [Packagist](https://packagist.org/packages/fof/forum-widgets-core)
- [GitHub](https://github.com/FriendsOfFlarum/forum-widgets-core)
- [Discuss](https://discuss.flarum.org/d/39064)

###  Health Score

42

—

FairBetter than 88% of packages

Maintenance61

Regular maintenance activity

Popularity26

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 55.6% 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 ~2 days

Total

6

Last Release

92d ago

Major Versions

1.x-dev → 2.0.0-beta.12026-04-12

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/16573496?v=4)[IanM](/maintainers/imorland)[@imorland](https://github.com/imorland)

---

Top Contributors

[![SychO9](https://avatars.githubusercontent.com/u/20267363?v=4)](https://github.com/SychO9 "SychO9 (40 commits)")[![flarum-bot](https://avatars.githubusercontent.com/u/39334649?v=4)](https://github.com/flarum-bot "flarum-bot (16 commits)")[![imorland](https://avatars.githubusercontent.com/u/16573496?v=4)](https://github.com/imorland "imorland (13 commits)")[![davwheat](https://avatars.githubusercontent.com/u/7406822?v=4)](https://github.com/davwheat "davwheat (1 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)")[![weeliem](https://avatars.githubusercontent.com/u/2240115?v=4)](https://github.com/weeliem "weeliem (1 commits)")

---

Tags

frameworkcorewidgetsflarum

### Embed Badge

![Health badge](/badges/fof-forum-widgets-core/health.svg)

```
[![Health](https://phpackages.com/badges/fof-forum-widgets-core/health.svg)](https://phpackages.com/packages/fof-forum-widgets-core)
```

###  Alternatives

[flarum-lang/russian

Russian language pack for Flarum.

12128.3k](/packages/flarum-lang-russian)[afrux/forum-widgets-core

Core Extension for Managing Forum Widgets

1856.8k33](/packages/afrux-forum-widgets-core)[flarum-lang/french

French language pack to localize the Flarum forum software plus its official and third-party extensions.

1938.7k](/packages/flarum-lang-french)[caffeina-core/core

Platform for rapid application development.

345.9k6](/packages/caffeina-core-core)

PHPackages © 2026

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