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

@getable/avatar

v1.2.1

Published

Component that displays an image within a bordered bounding box.

Downloads

5

Readme

Avatar NPM version Build Status Dependency Status

Component that displays an image within a bordered bounding box.

Table of Contents generated with DocToc

Usage

  import React from 'react'
  import Avatar from 'avatar'
  React.render(<Avatar image="http://myimage"/>, document.createElement('div'))
@import "avatar";

Props

<String> image Required

Path to an image.

<String> OR <Number> size Required

Defaults to "normal". One of "normal", "large", or a number of pixels for the width.

<String> alt Required

Required because it's good for accessibility and the spec says so. The alt attribute for the image.

<Function> onClick

Handler for a a click on the avatar. Defaults to nothing.

<Boolean> borderless

Defaults to false. If enabled, turns off the border. This might be useful if you just need an image constrained to a certain size.

<Object> or <String> srcSet

Sets srcset on the image. If a string, set this just like you would in normal HTML. If an object, the keys are the size and the values are the url

srcSet={{'1x': 'http://…', '2x': 'http://'}}

Tests

Tests are in tape.

  • npm test will run the tests in a browser.
  • npm run tdd will run the tests in a browser on every file change.

Developing

Install ribcage

npm i -g ribcage
ribcage preview .
# run with client side js enabled
ribcage preview . -s

Open http://localhost:4001/default

Releasing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

  • npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
  • git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Joey Baker