npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

underdog-pup

v3.13.0

Published

Underdog.io's front end styleguide.

Downloads

19

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

brett_langdonbrett_langdonrestlessbitrestlessbit

Keywords

Readme

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:

Table of contents

Installation

You can use Pup in your project by installing it with npm:

yarn add underdog-pup@<VERSION>

# Example
yarn add [email protected]

After 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 'underdog-pup/styles/pup/shared';

// Import individual components
@import 'underdog-pup/styles/pup/base/btn';
@import 'underdog-pup/styles/pup/components/btn';
@import 'underdog-pup/styles/pup/helpers/list';

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
require('underdog-pup/scripts/vendor/polyfills');

// Import and initialze individual components
require('underdog-pup/scripts/components/carousel')();

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
<square70x70logo src="/path/to/favicons/mstile-70x70.png"/>
manifest.json
{
  "src": "\/path\/to\/favicons\/android-chrome-36x36.png",
  "sizes": "36x36",
  "type": "image\/png",
  "density": 0.75
}

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.

<meta name="apple-mobile-web-app-title" content="Underdog.io" />
<meta name="application-name" content="Underdog.io" />
<meta name="msapplication-TileColor" content="#4CC193" />
<meta name="msapplication-TileImage" content="/mstile-144x144.png" />
<meta name="theme-color" content="#4CC193" />

<link rel="apple-touch-icon" sizes="57x57" href="/apple-touch-icon-57x57.png" />
<link rel="apple-touch-icon" sizes="60x60" href="/apple-touch-icon-60x60.png" />
<link rel="apple-touch-icon" sizes="72x72" href="/apple-touch-icon-72x72.png" />
<link rel="apple-touch-icon" sizes="76x76" href="/apple-touch-icon-76x76.png" />
<link rel="apple-touch-icon" sizes="114x114" href="/apple-touch-icon-114x114.png" />
<link rel="apple-touch-icon" sizes="120x120" href="/apple-touch-icon-120x120.png" />
<link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon-144x144.png" />
<link rel="apple-touch-icon" sizes="152x152" href="/apple-touch-icon-152x152.png" />
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon-180x180.png" />
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192" />
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96" />
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16" />
<link rel="manifest" href="/manifest.json" />
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#4CC193" />

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.

$icon-font-path: '/fonts/';

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:

  1. Bump the version in package.json and create a new tag, following semantic versioning:
npm version <major|minor|patch>
  1. Push the updated package.json and new tag to master:
git push origin master --tags
  1. Publish to npm:
npm publish

Contributing

For guidelines on modifying the styleguide, please see CONTRIBUTING.md.