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

    3.1.1 • Public • Published

    Jdenticon

    JavaScript library for generating highly recognizable identicons using HTML5 canvas or SVG.

    Sample identicons

    Tests Downloads jsDelivr npm bundle size License MIT

    Live demo

    https://jdenticon.com

    Getting started

    Using Jdenticon is simple. Follow the steps below to integrate Jdenticon into your website.

    1. Add identicon placeholders

    Jdenticon is able to render both raster and vector identicons. Raster icons are rendered slightly faster than vector icons, but vector icons scale better on high resolution screens. Add a canvas to render a raster icon, or an inline svg element to render a vector icon.

    <!-- Vector icon -->
    <svg width="80" height="80" data-jdenticon-value="icon value"></svg>
    
    <!-- OR -->
    
    <!-- Raster icon -->
    <canvas width="80" height="80" data-jdenticon-value="icon value"></canvas>

    2. Add reference to Jdenticon

    Include the Jdenticon library somewhere on your page. You can either host it yourself or use it right off jsDelivr.

    <!-- Using jsDelivr -->
    <script src="https://cdn.jsdelivr.net/npm/jdenticon@3.1.1/dist/jdenticon.min.js"
            integrity="sha384-l0/0sn63N3mskDgRYJZA6Mogihu0VY3CusdLMiwpJ9LFPklOARUcOiWEIGGmFELx"
            crossorigin="anonymous">
    </script>
    
    <!-- OR -->
    
    <!-- Hosting it yourself -->
    <script src="-path-to-/jdenticon.min.js"></script>

    That's it!

    Other resources

    API documentation

    For more usage examples and API documentation, please see:

    https://jdenticon.com

    Other platforms

    There are ports or bindings for Jdenticon available for the following platforms:

    Hosted Jdenticon

    Same icons but generated server-side. Service provided by Aaroh Mankad.

    http://identicon-api.herokuapp.com/

    License

    Jdenticon is available under the MIT license.

    Install

    npm i jdenticon

    DownloadsWeekly Downloads

    18,440

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    706 kB

    Total Files

    20

    Last publish

    Collaborators

    • dmester