https://github.com/opensource-paper/papericons

Paper Icons is a modern and beautiful icon library built to seamlessly integrate with Paper UI.
https://github.com/opensource-paper/papericons

documentation figma html icon icon-pack icons javascript js npm open-source paper paper-icons paper-ui paperui svg svg-icons svgs ui-components ui-library

Last synced: 12 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/opensource-paper/papericons
• Owner: Opensource-Paper
• License: mit
• Created: 2024-05-28T09:13:59.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T22:36:18.000Z (8 months ago)
• Last Synced: 2024-05-29T06:12:25.824Z (8 months ago)
• Topics: documentation, figma, html, icon, icon-pack, icons, javascript, js, npm, open-source, paper, paper-icons, paper-ui, paperui, svg, svg-icons, svgs, ui-components, ui-library
• Language: JavaScript
• Homepage: https://icons.paperui.com
• Size: 413 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        







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



[Documentation](https://icons.paperui.com/)



## Installation

### CDN

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

```html

```

#### 🚧 Specific Version

```html

```

### NPM

Install Paper Icons using [npm and node](https://nodejs.org/en).

```bash

npm install papericons

```

## Import

Import icon definitions from ```papericons```.

```index.js```

```js

import paperIcons from 'papericons';

document.addEventListener('DOMContentLoaded', () => {

  paperIcons.replaceIcons();

});

```

## Usage

Use the `````` tag in HTML markup. Refer to the [Icon Docs](https://icons.paperui.com) for more guidance on using each icon. That's it 🎉.

```HTML```

```html



  document.addEventListener('DOMContentLoaded', () => {

    window.PaperIcons.replaceIcons();

  });

```

Check out the demo on [codepen](https://codepen.io/GreenestGoat/pen/YzbpOBv).

## Copyright and license

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

See [LICENSE](https://github.com/Opensource-Paper/PaperIcons/blob/main/LICENSE) for more information.