Skip to main content ↑ ↓
[Addon] Custom Board Icons Started by vbgamer45 · · Read 264 times 0 Members and 1 Guest are viewing this topic. previous topic - next topic

[Addon] Custom Board Icons

Custom Board Icons
Version: 1.0
Author: vbgamer45
Website: https://www.elkartemods.com
Compatible with: ElkArte 1.1 - 1.1.99

Description

Custom Board Icons allows forum administrators to upload a custom icon image for each board, replacing the default CSS status icons on the board index. Upload any image (JPG, PNG, GIF, WebP, or SVG) through a simple drag-and-drop interface on the board edit page.

When a board has a custom icon, a small animated badge dot can optionally overlay the icon to indicate new/unread posts. Boards without a custom icon continue to use the default ElkArte status icons.

Features

  • Per-board custom icon images on the board index
  • Drag-and-drop upload UI in Admin > Boards > Modify Board
  • AJAX upload with instant preview - no page reload needed
  • Optional new post badge overlay (green pulsing dot) on custom icons
  • Badge toggle in Admin > Configuration >Add-on Settings
  • Supports JPG, PNG, GIF, WebP, and SVG formats (max 512KB)
  • Clean uninstall removes all files and database changes

Installation

1. Upload the package via Admin > Packages > Upload a Package.
2. Click Install and follow the prompts.
3. The mod will add a board_icon column to the boards table and create a board_icons/ upload directory in your forum root.

Usage

Adding an icon to a board:
1. Go to Admin > Boards > Modify Board (click the modify link next to any board).
2. Scroll down to the "Board Icon" section at the bottom of the settings.
3. Drag and drop an image onto the drop zone, or click it to browse for a file.
4. The image will upload immediately and show a preview.
5. Click "Modify" to save the board settings.

Removing an icon:
1. Edit the board in Admin > Boards.
2. Click "Remove icon" next to the current icon preview.
3. Click "Modify" to save.

New post badge setting:
1. Go to Admin > Configuration > Addon Settings.
2. Under "Custom Board Icons", toggle "Show new post badge on custom board icons".
3. When enabled (default), a small green pulsing dot appears on custom icons when the board has unread posts.

Notes

  • Icons can only be added when editing an existing board. Create the board first, then add the icon.
  • Icons are displayed at 40x40 pixels on the board index. For best results, use square images.
  • Uploaded files are stored in the board_icons/ directory in your forum root.
  • If JavaScript is disabled, boards with custom icons will show the default CSS icons as a fallback.

Uninstallation

1. Go to Admin > Packages > Installed Modifications.
2. Click Uninstall next to Custom Board Icons.
3. All uploaded icon files, the upload directory, and the database column will be removed.

Support

For support, questions, or bug reports visit https://www.elkartemods.com.