i-lateral/silverstripe-systemmessages

Add popup notification messages to a Silverstripe site

Installs: 1 011

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 5

Forks: 1

Type:silverstripe-vendormodule

3.0.0 2021-07-23 18:59 UTC

This package is auto-updated.

Last update: 2022-05-23 21:01:30 UTC


README

Build Status Latest Stable Version Total Downloads License

Module for the Silverstripe CMS that adds content manageable messages to a site (that can be closed by via a user) via a template variable.

Author

This module was created by i-lateral.

Installation

Preferable you should installl this via composer using:

# composer require "i-lateral/silverstripe-systemmessages:0.*"

Alternativley install this module by downloading and adding to:

[silverstripe-root]/systemmessages

Then run:

http://yoursiteurl.com/dev/build/?flush=1

Or:

# sake dev/build flush=1

Usage

Once installed, you must add the template variable:

$SystemMessages.RenderedMessage

to any templates you require messages to appear on.

You can manage messages in the admin area using the "Messages" tab.

Built in JS libs

By default, system messages uses lightbox_me for modal messages. This can be disabled in the config for using your own jquery, disabling this will give the message the default bootstrap modal classes.

config.yml

SystemMessages:
  use_default_js: false

_config.php

SystemMessages::config()->use_default_js = false;

Bootstrap support

All HTML uses bootstrap class names as well as custom system message ones but the modal box will not auto open on load.

To enable modal auto opening on load, change the use_bootstrap config variable:

config.yml

SystemMessages:
  use_bootstrap: true

_config.php

SystemMessages::config()->use_bootstrap = true;