Skip to main content

Installation

Use hosted CSS and JS or download assets to include in your project.

Use Hosted Assets​

To use the hosted CSS, add this <link> to the <head> of your document.

<link rel="stylesheet" href="https://assets.bux.osu.edu/v1.5.1/css/bux-styles.min.css"/>

To use the hosted JS, add this <script> to the end of your document, just before the closing </body> tag.

<script src="https://assets.bux.osu.edu/v1.5.1/js/bux.min.js"></script>

Major & Minor Releases​

In addition to the latest tagged version, we will also provide major and minor versions in the following format. If you'd like to receive automatic updates you may choose to use one of these versions instead.

Major Release​

https://assets.bux.osu.edu/v1.5.x/css/bux-styles.min.css
https://assets.bux.osu.edu/v1.5.x/js/bux.min.js

Minor Release​

https://assets.bux.osu.edu/v1.x/css/bux-styles.min.css
https://assets.bux.osu.edu/v1.x/js/bux.min.js

Download Project Assets​

This ZIP file contains compiled and minified CSS and JS, Sass source files, Twig templates, images, and a starter HTML file.

css/
  |—— bux-styles.css
  |—— bux-styles.min.css
images/
  |—— favicons/
  |—— osu-logos/
  |—— placeholders/
js/
  |—— bux.js
  |—— bux.min.js
sass/
  |—— components/
  |—— variables/
  |—— (global sass files and partials)
twig/
  |—— (A Twig template for each component as necessary.)
html/
  |-- (Rendered HTML for each component and variant.)

Use a Package Manager​

NPM and Composer packages are hosted via the University Code Repository (UCR). Each version of the package will include a dist directory that includes the same files listed in the "Download Project Assets" section above.

NPM​

Add the @osu namespace to your project by adding the following line to your project's .npmrc file. If your project doesn't have an .npmrc file, create one at the root of your project.

@osu:registry=https://code.osu.edu/api/v4/packages/npm/

Then install the package from your terminal at the root of the project.

npm install @osu/bux-source

Composer​

Add the following item to the "repositories" section of your project's composer.json file.

"repositories": [
  {
    "type": "composer",
    "url": "https://code.osu.edu/api/v4/group/6209/-/packages/composer/packages.json"
  }
]

Require the package from your terminal at the root of the project.

composer require osu/bux

Drupal Single Directory Components Module​

In addition to the dist/ folder, the Composer package is configured to be a Drupal Module as of v1.5.0. Refer to the BUX with Drupal documentation for more information.

Back to top