/PaperUI

The Paper UI library allows users to easily import and style a wide range of components with a singular cdn link.

Primary LanguageJavaScriptMIT LicenseMIT

Logo Banner

The Paper UI library allows users to easily import and style a wide range of components with a singular cdn link.

Documentation

Installation

CDN

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

<script type="module" src="https://unpkg.com/paperui-web"></script>

🚧 Development

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

NPM

Install Paper UI web components using npm and node.

npm install paperui-web

Import

Import element definitions from paperui-web/<component>/<component>.js.

index.js

import 'paperui-web/switch/switch.js';
import 'paperui-web/checkbox/checkbox.js';

Usage

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

HTML

<media-button-filled>Filled</media-button-filled>
<media-button-outlined>Outlined</media-button-outlined>
<media-switch></media-switch>
<media-switch disabled checked></media-switch>

Check out the demo on codepen.

Copyright and license

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

See LICENSE for more information.