Download the PHP package ucf/ucf-alert-plugin without Composer
On this page you can find all versions of the php package ucf/ucf-alert-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ucf/ucf-alert-plugin
More information about ucf/ucf-alert-plugin
Files in ucf/ucf-alert-plugin
Package ucf-alert-plugin
Short Description Provides a shortcode, functions, and default styles for displaying UCF alerts.
License
Informations about the package ucf-alert-plugin
UCF Alert Plugin
Provides a shortcode, functions, and default styles for displaying UCF alerts.
Description
This plugin provides a shortcode, helper functions, and default styles for displaying latest alerts from ucf.edu/alert. It is written to work out-of-the-box for non-programmers, but is also extensible and customizable for developers.
Note: jQuery is required for the JavaScript included with this plugin to work.
Documentation
Head over to the UCF Alert Plugin wiki for detailed information about this plugin, installation instructions, and more.
Changelog
2.0.2
Enhancements:
- Added composer file.
2.0.1
Enhancements:
- Updated packages and added linter configs, issue/PR templates and a CONTRIBUTING doc.
- Added cache busting to enqueued assets.
Bug fixes:
- Updated
ucfalert.removedtrigger to only fire when an alert is actually removed from the DOM.
2.0.0
- Removed plugin options for specifying global alert links and call-to-action text, in favor of using per-alert values provided by the Alert theme's RSS feed.
- Updated default alert layout to remove references to deleted plugin options.
- Updated plugin js to populate alert URL and CTA values.
1.0.0
- Initial release
Upgrade Notice
n/a
Development
Note that compiled, minified css and js files are included within the repo. Changes to these files should be tracked via git (so that users installing the plugin using traditional installation methods will have a working plugin out-of-the-box.)
Enabling debug mode in your wp-config.php file is recommended during development to help catch warnings and bugs.
Requirements
- node v16+
- gulp-cli
Instructions
- Clone the UCF-Alert-Plugin repo into your local development environment, within your WordPress installation's
plugins/directory:git clone https://github.com/UCF/UCF-Alert-Plugin.git cdinto the new UCF-Alert-Plugin directory, and runnpm installto install required packages for development intonode_modules/within the repo-
Optional: If you'd like to enable BrowserSync for local development, or make other changes to this project's default gulp configuration, copy
gulp-config.template.json, make any desired changes, and save asgulp-config.json.To enable BrowserSync, set
synctotrueand assigntargetthe base URL of a site on your local WordPress instance that will use this plugin, such ashttp://localhost/wordpress/my-site/. Yourtargetvalue will vary depending on your local host setup.The full list of modifiable config values can be viewed in
gulpfile.js(seeconfigvariable). - Run
gulp defaultto process front-end assets. - If you haven't already done so, create a new WordPress site on your development environment to test this plugin against.
- Activate this plugin on your development WordPress site.
- Configure plugin settings from the WordPress admin under "UCF Alert".
- Run
gulp watchto continuously watch changes to scss and js files. If you enabled BrowserSync ingulp-config.json, it will also reload your browser when plugin files change.
Other Notes
- This plugin's README.md file is automatically generated. Please only make modifications to the README.txt file, and make sure the
gulp readmecommand has been run before committing README changes. See the contributing guidelines for more information.
Contributing
Want to submit a bug report or feature request? Check out our contributing guidelines for more information. We'd love to hear from you!