Compass Side Panels

The compass Side Panels are a great way to display your views in a side panel. The side panels provide automatic handling of forms.

Basic usage

Local installation:

Clone the sidepanel repository: git@gitlab.noardcode.nl:compass/side-panels.git Add the codesnippet below to composer.json

then run composer update noardcode/compass-side-panels

"repositories": [
    {
        "type": "path",
        "url": "packages/noardcode/side-panels",
        "options": {
            "symlink": true
        }
    }
],

Events

Event Triggers when Event variable {object}
nc.sidePanel.hide Sidepanel is starting to hide, has fadeout of 200ms sidePanel
nc.sidePanel.hidden Sidepanel is fully hidden sidePanel
nc.sidePanel.show Sidepanel is starting to show sidePanel
nc.sidePanel.shown Sidepanel is shown sidePanel
nc.sidePanel.reload Sidepanel will be reloaded sidePanel
nc.sidePanel.reloaded Sidepanel has been reloaded sidePanel
nc.sidePanel.formSuccess Form validation was successful result form sidePanel
nc.sidePanel.formError Form validation encountered an error error form sidePanel

Event variables

  • Form: Form element that was posted via AJAX
  • Error: Returns error messages
  • Result: Response from the AJAX request
  • Sidepanel: Sidepanel from where the event was triggered