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 repository.
$ npm install --save primer-avatars
The source files included are written in Sass (
scss) You can simply point your sass
include-path at your
node_modules directory and import it like this.
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.
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
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.
.avatar to any
<img> 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
height attributes for maximum browser performance.
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.
When you need a larger parent avatar, and a smaller child one, overlaid slightly, use the parent-child classes.
Stacked avatars can be used to show who is participating in thread when there is limited space available. When you hover over the stack, the avatars will reveal themselves. Optimally, you should put no more than 3 avatars in the stack.
.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
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.
<%= octicon "zap", :class => "CircleBadge-icon text-white" %>
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.
<%= octicon "mark-github", :class => "width-full height-full" %>