Pup
Underdog.io's front end styleguide.
Pup defines a common set of components, patterns, and static assets that are used to create a coherent visual style and user experience across all of Underdog.io's products.
The styleguide contains things like:
- UI Components
- Definitions for typography and spacing
- Illustrations
- Favicons
Table of contents
Installation
You can use Pup in your project by installing it with npm:
yarn add underdog-pup@<VERSION> # Example yarn add underdog-pup@1.0.0After installing Pup, you can then include individual components in your project.
Usage
Requirements
In order to make use of Pup, your project must have support for the following:
For an example of how to set up a build system that uses Pup, check out the package.json file for this repo.
Importing components
While Pup does include a stylesheet and JavaScript bundle that contains styles and scripts for every available component, it is recommended that you only import the assets required for the components that are used by your project.
Importing just the assets that are used by your project will result in smaller CSS and JavaScript file sizes.
Styles
Before importing components, you must import shared Sass functions, variables, and mixins before you import any components, like so:
// Import shared SCSS ; // Import individual components ;;;JavaScript
A few components, like the carousel, require JavaScript in order to function.
JavaScript modules are written with CommonJS syntax, so you must be using Browserify in your project in order to use them.
All components export a function that initializes the component.
// Import polyfills; // Import and initialze individual components;Favicons
Favicons are kept under favicons/*. In order to use these favicons you must copy them into your project.
You must also update the paths to the favicons in favicons/browserconfig.xml, favicons/manifest.json, and
in the <head /> tag of your HTML document.
Updating browserconfig.xml and manifest.json
By default browserconfig.xml and manifest.json are assuming that icons are being served from /. The path to each icon defined in these files must be manually updated to match the path where the favicons are being served from.
browserconfig.xml
manifest.json
Markup for importing icons in an HTML document
You must include the following markup in the <head /> tag of the HTML document you want the favicons to be displayed for.
Note: The following markup is assuming that icons are being served from the root (/) directory..
You must manually update the paths for each icon to the actual path where the favicons are being served from.
Icon font
We use a custom icon font which is generated from individual SVGs stored in icons/*.svg.
In order to utilize the icon font that is generated in this project you will need to copy the fonts into your project.
If you are using the icon font in your project you will also have to override the $icon-font-path variable to ensure the fonts get loaded properly.
Images
Images that are shared by all of our projects, such as our logo and illustrations, are kept under the /images directory.
Developing
Requirements
Your local machine must be running Node v6.4.0.
Running a local development server
First, install dependencies with yarn add.
Then run yarn develop to start a development server and watch script that will rebuild assets whenever you make a change to a file.
To see what other scripts are available, run yarn run.
Publishing a new version to npm
Run the following to publish a new version of underdog-pup to npm:
- Bump the version in
package.jsonand create a new tag, following semantic versioning:
npm version <major|minor|patch>
- Push the updated package.json and new tag to master:
git push origin master --tags
- Publish to npm:
npm publish
Contributing
For guidelines on modifying the styleguide, please see CONTRIBUTING.md.