Wondering what’s next for npm?Check out our public roadmap! »

    badges
    TypeScript icon, indicating that this package has built-in type declarations

    4.24.0 • Public • Published

    badges

    NPM version NPM downloads Dependency Status Dev Dependency Status
    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    The definitive collection of badges for rendering

    Usage

    Complete API Documentation.

    import { renderBadges } from 'badges'
     
    // Listing of badges to output
    const list = [
        // Custom Badges
        ['badge', { image: 'image', alt: 'alt' }],
        ['badge', { image: 'image', alt: 'alt', url: 'url', title: 'title' }],
        [
            'shields',
            {
                left: 'left',
                right: 'right',
                alt: 'alt',
                url: 'url',
                title: 'title',
            },
        ],
        [
            'shields',
            {
                left: 'left',
                right: 'right',
                color: 'red',
                alt: 'alt',
                url: 'url',
                title: 'title',
            },
        ],
        '---',
        // Development Badges
        'npmversion',
        'npmdownloads',
        'daviddm',
        'daviddmdev',
        'nodeico',
        '---',
        // Testing Badges
        'saucelabsbm',
        'saucelabs',
        'travisci',
        'codeship',
        'coveralls',
        'codeclimate',
        'bithound',
        'waffle',
        '---',
        // Funding Badges
        'sixtydevstips',
        'patreon',
        'opencollective',
        'gratipay',
        'flattr',
        'paypal',
        'bitcoin',
        'wishlist',
        '---',
        // Social Badges
        'slackinscript',
        'slackin',
        'gabeacon',
        'googleplusone',
        'redditsubmit',
        'hackernewssubmit',
        'facebooklike',
        'facebookfollow',
        'twittertweet',
        'twitterfollow',
        'githubfollow',
        'githubstar',
        'quorafollow',
    ]
     
    // Configuration for the badges
    const config = {
        npmPackageName: 'badges',
     
        saucelabsUsername: 'bevry',
        saucelabsAuthToken: '123',
        codeshipProjectUUID: '123',
        codeshipProjectID: '123',
        githubSlug: 'bevry/badges',
        nodeicoQueryString: { downloads: true, compact: true, height: 2 },
     
        sixtydevstipsID: 'd2dcf439c9759e88f3ccec1cef394c10',
        patreonUsername: 'bevry',
        opencollectiveUsername: 'bevry',
        gratipayUsername: 'bevry',
        flattrUsername: 'balupton',
        paypalURL: 'https://paypal.me/bevry',
        paypalButtonID: 'QB8GQPZAH84N6', // another option instead of paypalURL
        paypalUsername: 'bevry', // another option instead of paypalURL
        bitcoinURL: 'https://bevry.me/bitcoin',
        wishlistURL: 'https://bevry.me/wishlist',
     
        slackinURL: 'https://slack.bevry.me',
        gaTrackingID: 'UA-XXXXX-XX',
        homepage: 'https://bevry.me',
        facebookApplicationID: '123123',
        facebookUsername: 'balupton',
        twitterUsername: 'bevryme',
        githubUsername: 'balupton',
        quoraUsername: 'Benjamin-Lupton',
        quoraRealname: 'Benjamin Arthur Lupton', // optional, will extract from username
    }
     
    // Options for rendering the badges
    const options = {
        // Filter Category
        // When set to a string, will only render badges from the list that of the specified category
        // Values can be 'development', 'testing', 'funding', or 'social'
        // E.g. to render only funding badges, set to 'funding'
        filterCategory: false,
     
        // Filter Scripts
        // When true, do not render any badges from the list that are scripts
        filterScripts: false,
    }
     
    // Render the badges to a string
    const result = renderBadges(list, config, options)
     
    // Output the result
    console.log(result)

    If you want to render badges inside your own project's readme files, check out the meta builder projectz which uses this package for badge rendering.

    Not all the badges are showcased in the above example. Browse the Complete API Documentation instead.

    Install

    npm

    • Install: npm install --save badges
    • Import: import * as pkg from ('badges')
    • Require: const pkg = require('badges')

    Skypack

    <script type="module">
        import * as pkg from '//cdn.skypack.dev/badges@^4.24.0'
    </script> 

    unpkg

    <script type="module">
        import * as pkg from '//unpkg.com/badges@^4.24.0'
    </script> 

    jspm

    <script type="module">
        import * as pkg from '//dev.jspm.io/badges@4.24.0'
    </script> 

    Editions

    This package is published with the following editions:

    History

    Discover the release history by heading on over to the HISTORY.md file.

    Contribute

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    Adding a badge

    If you there is a badge that you believe will be common enough for others to benefit from, send in a pull request. Each pull request should:

    1. Add the badge rendering code to the appropriate category section inside source/badges.js
    2. If your badge requires a script to run, it should have badgeScript = true - see other badges for an example
    3. Also remember to export your badge
    4. Add the badges test data to the test file source/test.js
    5. Add the badge configuration information to this readme file README.md
    6. Add the badge name to the keyword field of package.json

    These changes can be done in multiple commits or the same, it doesn't matter, as we will squash the commits on merge. We will also the changelog entry, so you don't need to do.

    Backers

    Maintainers

    These amazing people are maintaining this project:

    Sponsors

    No sponsors yet! Will you be the first?

    GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i badges

    DownloadsWeekly Downloads

    3,527

    Version

    4.24.0

    License

    MIT

    Unpacked Size

    224 kB

    Total Files

    21

    Last publish

    Collaborators

    • avatar
    • avatar