Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 1.98 KB

README.md

File metadata and controls

86 lines (55 loc) · 1.98 KB
Raw

Logo Banner

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

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

Licensed under the MIT License, Copyright © 2024-present Opensource-Paper.

See LICENSE for more information.