Download the PHP package uconn/banner without Composer
On this page you can find all versions of the php package uconn/banner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package banner
Short Description The UConn Banner - Branding for the top of your web pages.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package banner
UConn Banner
A (UConn brand) standards-compliant implementation of the University's web banner.
History
As with most of our web branding efforts, University Communications has teamed with the UITS Web Dev Lab to create a new look for the University's web presence. While the majority of university departments and organizations can be brought into brand compliance through the use of the Aurora (WordPress) platform courtesy of UITS, there is still a need for static templates. This project attempts to bridge that gap.
As of January 16, 2020, the master branch of this repository represents 3.x of the banner. The key differences are outlined below:
| 1.x (deprecated) | 2.x (deprecated) | 3.x | 4.x |
|---|---|---|---|
| - Designed for use with Bootstrap | - Bootstrap classes removed | - Added support for a School/College type banner. This includes support for optional mobile menu and popups. | |
| - Embedded media queries intended to mirror Bootstrap | - No media queries. User must define them. | - Added support for white banner with blue text | |
| - npm compatible | - composer compatible | - Added support for popups with search box | |
| - Added a php generator to quickly create static banners | |||
| - Updated dependencies and build process | |||
| - Deprecated jekyll in favor of 11ty | |||
| - Removed support for Compass | |||
| - Improved support for level 1 and 2 site titles | |||
| - Download buttons for banner markup and assets | |||
| - Added typescript support to project |
Who should use this?
Anyone building a new *.uconn.edu website that won't be hosting on the Aurora platform.
Site Requirements (Recommended)
Usage:
There are a number of ways to use this code. Here are just a few:
- HTML - You can download the latest zip file and use the assets in the "_site" directory to start building your website.
- PHP - Use Composer to embed the banner in your page.
- npm - Include as a node_module with
npm install uconn-banner --save-dev, use the HTML/CSS/JS from the "_site" directory.
Tests
This repo uses Pest to test the attributes of the banner. Tests can be run with ./vendor/bin/pest tests/Unit/BannerTest.php.
Contributing / Development
Clone/download this repo and use 11ty.
Open up http://localhost:8080/ in your web browser to view your changes.
Javascript
If you plan to use this banner with the mobile menu enabled, please make sure to read the following carefully. You must implement your own mobile menu. While the banner provides a menu toggle, it is (almost) completely un-opinioated when it comes to the markup or style for the menu. The only thing you must do is make sure that the id of the component that wraps the menu matches the aria-controls attribute of the menu toggle button.
When the button is clicked, it will dispatch a custom javascript event called ucBannerMenuState that can be listened to. This lets you control the menu from any other script.
For a complete example, consult the unminified menu-demo.js files.
Deployment to github pages
Static output
To create a static html version of the banner, you can use the included Generator.php file. It covers the full range of options available to the Banner. You can use the generator with the command php src/Banner/Generator.php <options>. For help or to see a list of options - php src/Banner/Generator.php --help.
