friendsofsilverstripe/backendmessages

DRY way to create message boxes in SilverStripe backend.

4.1.3 2020-08-21 14:14 UTC

This package is auto-updated.

Last update: 2020-11-21 15:02:29 UTC


README

Requirements

  • SilverStripe Framework ^3.0 or ^4.0

Installation

composer require friendsofsilverstripe/backendmessages

Usage

Within any FieldList you can call any of the following static methods to create a message box:

use FriendsOfSilverStripe\Backendmessages\ErrorMessage;
use FriendsOfSilverStripe\Backendmessages\WarningMessage;
use FriendsOfSilverStripe\Backendmessages\SuccessMessage;
use FriendsOfSilverStripe\Backendmessages\NoticeMessage;
use FriendsOfSilverStripe\Backendmessages\Message;

// [...]

FieldList::create(
	ErrorMessage::create('Ehh, something went wrong.'),
	WarningMessage::create('Be careful with this!'),
	SuccessMessage::create('Yeah, that went through just fine.'),
	NoticeMessage::create('This is a useful hint.'),
	Message::generic('Some more information.')
);

generates

messages.png

Allow HTML in the backend messages

Add the following to your config.yml

FriendsOfSilverStripe\Backendmessages\MessageBoxField:
  allow_html: true

MISC: Future ideas/development, issues, Contributing, License

This project is supported by bring your own ideas Ltd.. Bring Your Own Ideas Ltd. helps you to make your project ideas to reality.

bring your own ideas