papericons

A modern and beautiful icon library built to seamlessly integrate with Paper UI.

0.0.39
latest
Source
npm

Version published: 9 months ago

Weekly downloads: 14; decreased by-17.65%

Maintainers: 1

Weekly downloads

Created: 9 months ago

Source

Paper Icons is a modern and beautiful icon library built to seamlessly integrate with Paper UI.

Documentation

Installation

CDN

Import Paper Icons using CDN. The import.min.js file will automatically import all styles and JavaScript files into the <head>.

<script type="module" src="https://unpkg.com/papericons"></script>

🚧 Specific Version

<script type="module" src="https://unpkg.com/papericons@latest"></script>

NPM

Install Paper Icons using npm and node.

npm install papericons

Import

Import icon definitions from papericons.

index.js

import paperIcons from 'papericons';

document.addEventListener('DOMContentLoaded', () => {
  paperIcons.replaceIcons();
});

Usage

Use the <icon-name> tag in HTML markup. Refer to the Icon Docs for more guidance on using each icon. That's it 🎉.

HTML

<!-- example icon -->
<i paper-icon="disc"></i>

<!-- using vanilla js with no framework -->

<script>
  document.addEventListener('DOMContentLoaded', () => {
    window.PaperIcons.replaceIcons();
  });
</script>

Check out the demo on codepen.

Copyright and license

See LICENSE for more information.

Keywords

FAQs

What is papericons?

Is papericons popular?

Is papericons well maintained?

Package last updated on 12 Jun 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install