availity-uikit

Availity UI Kit powered by Bootstrap 3 and sprinkles of Bootstrap 4 with overrides to match our style guidelines.

Table of Contents

• Demo
• Supported Browsers
• Quickstart
• Icon Fonts
• Contributing
• Authors
• Disclaimer
• License

Demo

http://availity.github.io/availity-uikit

Supported Browsers

• Internet Explorer 9+
• Google Chrome > 1% market share
• Mozilla Firefox > 1% market share

Internet Explorer 9 and below requires a CSS post processor in order to get circumvent the 4095 limit on selector on style sheets

• gulp-bless
• bless.js
• grunt-bless
• bless-webpack-plugin

Quickstart

• Install with npm

$ npm install availity-uikit --save

• If you use a module bundler like Webpack:

import 'availity-uikit';

Icon Fonts

Availity uses Fontello to manage the UIKit icon fonts. Our font configuration can be used on Fontello to edit the font catalog.

Contributing

Dependencies

• Node v5+
• NPM v3+

CLI

• npm start
  • runs webpack dev server on http://localhost:9100
  • watches library and docs changes and automatically compiles the assets into ./build
• npm run build
  • cleans /dist
  • runs the webpack module bundler
  • produces regular and minified assets in `/dist
• npm run docs
  • runs metalsmith and outputs to /build
  • runs webpack module bundler and outputs to /dist
• npm run lint
  • runs Eslint across dev and lib files

Update the Icon Font

• Navigate to Fontello and click on the wrench and import the config.json file located in /fonts/
• Use the Fontello browser page to drag and drop and new svg icon fonts to the pre-populated list
• Select any icon you want to be included in your updated icon font
• Click the red Download Webfont button in the upper right hand corner
• Extract the .zip file and overwrite the config.json in /fonts with the new config.json file within the .zip file
• Replace the fonts in /fonts/ with those from the /font folder in your extracted .zip file
• Add the new icons css style to /less/availity-icon-fonts.less file
• Add the new icons to the documentation page located at /docs/guide/pages/icons.html using the given formatting
• Finally push your changes to the develop branch

Authors

Robert McGuinness

• rob.mcguinness@availity.com

Robert Ventrone

• robert.ventrone@availity.com

Robert Warner

• rob.warner@availity.com

Bobby Bennett

• bobby.bennett@availity.com

Disclaimer

Open source software components distributed or made available in the Availity Materials are licensed to Company under the terms of the applicable open source license agreements, which may be found in text files included in the Availity Materials.

License

MIT

Copyright (c) 2017 Availity, LLC