# Primer Avatars [![npm version](https://img.shields.io/npm/v/primer-avatars.svg)](https://www.npmjs.org/package/primer-avatars) [![Build Status](https://travis-ci.org/primer/primer.svg?branch=master)](https://travis-ci.org/primer/primer) > Avatars are images that users can set as their profile picture. On GitHub, they’re always going to be rounded squares. They can be custom photos, uploaded by users, or generated as Identicons as a placeholder. This repository is a module of the full [primer][primer] repository. ## Install This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-avatars` with this command. ``` $ npm install --save primer-avatars ``` ## Usage The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this. ```scss @import "primer-avatars/index.scss"; ``` You can also import specific portions of the module by importing those partials from the `/lib/` folder. _Make sure you import any requirements along with the modules._ ## Build For a compiled **css** version of this module, a npm script is included that will output a css version to `build/build.css` The built css file is also included in the npm package. ``` $ npm run build ``` ## Documentation Avatars are images that users can set as their profile picture. On GitHub, they're always going to be rounded squares. They can be custom photos, uploaded by users, or generated as Identicons as a placeholder. {:toc} ## Basic example Add `.avatar` to any `` element to make it an avatar. This resets some key styles for alignment, address a Firefox image placeholder bug, and rounds the corners. Be sure to set `width` and `height` attributes for maximum browser performance. ```html jonrohan ``` ### Small avatars We occasionally use smaller avatars. Anything less than `48px` wide should include the `.avatar-small` modifier class to reset the `border-radius` to a more appropriate level. ```html jonrohan ``` ### Parent-child avatars When you need a larger parent avatar, and a smaller child one, overlaid slightly, use the parent-child classes. ```html
jonrohan josh
``` ### Avatar stack Stacked avatars can be used to show multiple collaborators or participants when there is limited space available. When you hover over the stack, the avatars will reveal themselves. ```html
@octocat @octocat @octocat
``` Based on the number of avatars in the stack, add these modifier classes: - `AvatarStack--two` for 2 avatars. - `AvatarStack--three-plus` for 3 or more avatars. If you have more than three avatars, add a div with the classes `avatar avatar-more` as the third avatar in the stack, as such: ```html
@octocat @octocat
@octocat @octocat @octocat
``` You can also link individual avatars. To do this shift the `avatar` class over to the anchor: ```html
@octocat @octocat
``` Use `AvatarStack--right` to right-align the avatar stack. Remember to switch the alignment of tooltips when making this change. ```html
@octocat @octocat @octocat
``` ## Circle Badge `.CircleBadge` allows for the display of badge-like icons or logos. They are used mostly with Octicons or partner integration icons. `.CircleBadge` should have an `aria-label`, `title` (for a link), or an `alt` (for child `img` elements) attribute specified if there is no text-based alternative to describe it. If there is a text-based alternative or the icon has no semantic value, `aria-hidden="true"` or an empty `alt` attribute may be used. ### Small ```html " class="CircleBadge-icon" alt=""> <%= octicon "zap", :class => "CircleBadge-icon text-white" %> ``` ### Medium ```html
" alt="Travis CI" class="CircleBadge-icon">
``` ### Large ```html
" alt="Travis CI" class="CircleBadge-icon">
``` ### Dashed connection For specific cases where two badges or more need to be shown as related or connected (such as integrations or specific product workflows), a `DashedConnection` class was created. Use utility classes to ensure badges are spaced correctly. ```html
``` ## License [MIT](./LICENSE) © [GitHub](https://github.com/) [primer]: https://github.com/primer/primer [docs]: http://primer.github.io/ [npm]: https://www.npmjs.com/ [install-npm]: https://docs.npmjs.com/getting-started/installing-node [sass]: http://sass-lang.com/