Download the PHP package sergeykasyanov/oc-popups-plugin without Composer
On this page you can find all versions of the php package sergeykasyanov/oc-popups-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sergeykasyanov/oc-popups-plugin
More information about sergeykasyanov/oc-popups-plugin
Files in sergeykasyanov/oc-popups-plugin
Package oc-popups-plugin
Short Description PopupController behavior plugin for OctoberCMS.
License MIT
Informations about the package oc-popups-plugin
Popups plugin
Plugin provides PopupController controller behavior for easy creating popups on OctoberCMS backend pages.
Creating popups
Add PopupController behavior to your controller.
You can add multiple configurations.
For render open popup button call method from controller with definition as optional parameter.
Or you can write html by yourself.
Popup types
PopupController supports 3 types of popups: content, msg and form.
Content Popup is popup with static content.
Msg popups is popup with message like static flash message.
Form popup is popup with custom form.
Popup config
Common options
Common options for popups of all types:
Option | Description | Default value |
---|---|---|
type | Popup type. Possible values: , or . | |
openBtnLabel | Open popup button label. | |
openBtnClass | Open popup button css class. | btn btn-default |
popupSize | Size of popup. Available sizes: , , , , , . | medium |
noPadding | Remove padding from popup body. | |
popupId | Popup Id attribute. | definition name |
inset | Do not wrap popup in div with id. | false |
type is required for every popup config.
openBtnLabel is required for render open popup button.
Msg
Option | Description | Default value |
---|---|---|
msgType | Message type. Available values: , , , | info |
content | Message text |
Config for msg popup must contain both of these options.
Content
Option | Description |
---|---|
title | Popup title. |
content | Popup content. |
contentPartial | Partial name with popup content. Overrides content property. |
Config for content popup must contain content or contentPartial.
Form
Option | Description | Default value |
---|---|---|
title | Popup title. | |
content | Popup content. Renders above the form. | |
contentBelow | Popup content. Renders below the form. | |
contentPartial | Popup content partial. Renders above the form. Overrides content property. | |
contentPartialBelow | Popup content partial. Renders below the form. Overrides contentBelow property. | |
actionBtnLabel | Label of form submit button. | OK |
actionBtnClass | Css class of form submit button. | btn btn-primary |
actionOnClick | Action on form submit button. | |
loadIndicator | Show loading popup on performing actionOnClick action? | false |
confirm | Confirm message for form submit button. | null |
successCallback | Javascript callback for execute after success. | null |
form | Form config. Must contain fields config. | |
modelClass | Model class for form. | \October\Rain\Database\Model |
Config for form popup must contain actionOnClick and form options.
Overrides
There are two methods for the override.
You can use it for override content of popups and form model of form popups.
Below param of getPopupContent() is for overriding the contentBelow.
Complex example
Below is example of using PopupController for make simple wizard. For doing this you can use popup id.