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

social-images

v1.2.1

Published

FTC social images

Downloads

4

Readme

Usage

SCSS API

@mixin socialImagesSetImageFor($social-name, $theme: null)

parameters:

  • $social-name String. One of 'wechat', 'weibo', 'linkedin', 'facebook', or 'twitter'
  • $theme String. 'default' or 'pink' to distinguish image file names.

@mixin socialImagesBaseStyles

API

It can be used as a node module in you project.

npm install social-images --save-dev
const socialImages = require('social-images');

Syntax:

socialImages(config)

config Object.

  • @param {Array} config.images - Default to ['wechat', 'weibo', 'linkedin', 'facebook', 'twitter']. You can use one or serveral of them.
  • @param {String | Object} config.feature - one of ['default', 'round', 'pink'] or a custom object.
  • @param {String} config.feature.fill - fill color for svg path. e.g. "#fff"
  • @param {String} config.feature.background - background color for output image. e.g. "transparent"
  • @param {String} config.feature.rx - radius of image. e.g. "50%"
  • @param {String} config.feature.ry - radius of image.
  • @param {String} config.dest - output directory. Default to public/images under process.cwd()

Example:

socialImages({
    names: ['wechat', 'weibo'],
    feature: 'pink'
    dest: 'client/images'
});

This will generate wechat and weibo images, with the "pink" theme, put in you project directory client/images.

You can also use custom styles:

socialImages({
    feature: {
        fill: "#eeeeee",
        background: "#2bbbbf",
        rx: "10px",
        ry: "10px"
    }
});

Commands

Generate all svg and png files

src/js/settings.json specifies what kind of images will be generated. Each image may have different fill color, background color and radius. The themes field corresponds to these specifications. To generated all svg and png file:

npm run buildall
// or
node index.js

Generate a single svg and png file with custom style

npm run buildone -- -i=image-name -b=background-color -f=fill-color -x=radius-x -y=radius-y

All arguments are optional. If omitted, it will generate the default images.

Gulp tasks

  • gulp svgmin
  • gulp templates
  • gulp svgstore