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

@proddi/x-icons

v0.0.10

Published

icons the easy way

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

proddiproddi

Keywords

web-componentsx-iconsicon

Readme

Published on NPM Build status Published on webcomponents.org

x-icons - easy svg and png icons

The x-icons package allows you easily to embed icons to your page.

And the best it doesn't come with any depndency. This means it's super fast.

See: Documentation, Demo.

Usage

Installation

npm install --save @proddi/x-icons

Full example

<html>
  <head>
    <script type="module">
      import '@proddi/x-icons/x-iconset-svg.js';
      import '@proddi/x-icons/x-icon.js';
    </script>
  </head>
  <body>
     <!-- Load icons defined in the svg (id-attribute). -->
    <x-iconset-svg name="transit" href="icons/transit-icons.svg"></x-iconset-svg>

    <p>Normal sized icon: <x-icon icon="transit:bus"></x-icon></p<
    <p>Double sized icon: <x-icon size="2em" icon="transit:bus"></x-icon></p<

     <!-- Load icons from a sprite-map (id-attribute). -->
    <x-iconset-img name="pixel" width="256" icon-size="64" src="icons/demo-icons.png"
        icons="favorite play valid map-marker place profile star home invalid star2 route preferences layers date my-profile"></x-iconset-img>

    <p>Normal sized icon: <x-icon icon="pixel:play"></x-icon></p<
    <p>Double sized icon: <x-icon size="2em" icon="pixel:star"></x-icon></p<
  </body>
</html>

Components:

<x-icon>

The x-icon element displays an icon. The size is defined in the icon-set and by default 1em.

<html>
  <head>
    <script type="module" src="@proddi/x-icons/x-iconset-svg.js"></script>
    <script type="module" src="@proddi/x-icons/x-icon.js"></script>
    <x-iconset-svg href="icons/transit-icons.svg"></x-iconset-svg>
  </head>
  <body>
     <!-- Use an icon from the imported iconset. -->
     <x-icon icon="search"></x-icon>

     <!-- In rare cases you need to load the icon from a source. -->
     <x-icon src="demo/location.png"></x-icon>
  </body>
</html>

<x-iconset-svg>

The x-iconset-svg element allows users to define their own icon sets that contain svg icons.

<html>
  <head>
    <script type="module" src="@proddi/x-icons/x-iconset-svg.js"></script>
    <x-iconset-svg name="transit" href="icons/transit-icons.svg"></x-iconset-svg>
  </head>
  <body>
     ...
  </body>
</html>

<x-iconset-img>

The x-iconset-img element allows users to define their own icon sets that contain sprite-map like icons.

<html>
  <head>
    <script type="module" src="@proddi/x-icons/x-iconset-img.js"></script>
    <x-iconset-img name="demo" width="256" icon-size="64" src="icons/demo-icons.png"
        icons="favorite play valid map-marker place profile star home invalid star2 route preferences layers date my-profile">
    </x-iconset-img>
  </head>
  <body>
     ...
  </body>
</html>

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/proddi/x-icons
cd x-icons
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm