friendsofsilverstripe / backendmessages
DRY way to create message boxes in SilverStripe backend.
Fund package maintenance!
spekulatius
www.buymeacoffee.com/spekulatius
Installs: 13 093
Dependents: 2
Suggesters: 0
Security: 0
Stars: 7
Watchers: 2
Forks: 7
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- php: ^7.2 || ^8.0
- silverstripe/framework: ^4.0 | ^5
Requires (Dev)
- symfony/thanks: ^1.0
README
Generate SilverStripe backend messages with one simple call. Type less, do more.
![License](https://camo.githubusercontent.com/19ddde40f985167271f7765ed0bc0063d801757a5a65df7f79168320e2ff2f61/68747470733a2f2f706f7365722e707567782e6f72672f467269656e64734f6653696c7665725374726970652f6261636b656e646d657373616765732f6c6963656e73652e737667)
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
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 a reality.