Papanasi

The frontend UI library to use cross Frameworks. A set of components to use...

README

Papanasi

The Universal UI Library


🔍 Overview


🥯Papanasi _(pronunced pɑpənæʃ or papanash)_ is a UI library to use cross Frameworks. A set of components to use in Angular, Preact, Qwik, React, Solid, Svelte, Vue and Web Components. Is based on the Mitosis library and documented using Storybook.

Package version GitHub stars Tweet Sponsor


🚀 Platforms



Angular
Angular Sandbox Angular downloads

Preact
Preact Sandbox Preact downloads

Qwik
Qwik Sandbox Qwik downloads

React
React Sandbox React downloads

Solid
Solid Sandbox Solid downloads

Svelte
Svelte Sandbox Svelte downloads

Vue
Vue Sandbox Vue downloads

Web Comps.
Webcomponents Sandbox Web Components downloads

🔮 Demos



Nextjs
Nextjs Demo

Nuxt 3
Nuxt Demo

Svelte Kit
Svelte Kit Demo

Solid Start
Solid Start Demo

Qwik City
Svelte Kit Demo


📣 Manifesto


This library born as a pet project to create universal components, easy to extend in any project and easy to use with any framework, is based on the next principles:

A Component...

...should be cross-libraries but the code should be written once.
...should have a minimum style but easy to extend it via CSS by any dev.
...should provide some  optional themes to make it easy to use.
...should be accessible (FUTURE RELEASES).
...should be made for developers not for non-coders, they will decide how to style most of the things.
...should be tree-shakable.
...should be compatible with StoryBook.
...should be inspired by other UI Libraries and don't reinvent the wheel.
...should be easy to create new variants.

🧩 Elements Showcase


Layout


Container
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Row
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Column
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Grid
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Components


Avatar
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Button
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Code
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Pill
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Spinner
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Enterprise


Itchio
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

Extensions


Tooltip
Angular status Preact status Qwik status React status
Solid status Svelte status Vue status W3c status
Preview

📚 Setup and scripts

With npm:

  1. ```
  2. $ npm install @papanasi/[target] # ex: @papanasi/react
  3. ```
With yarn:

  1. ```
  2. $ yarn add @papanasi/[target] # ex: @papanasi/vue
  3. ```

🪲 Debugger

To debug elements you can use setDebugLevel function from @papanasi/[target] package. This function is totally optional and the default value is DebugLevel.None the recommended is to use DebugLevel.Log to have a log of the different events happening.

  1. ``` js
  2. window.addEventListener('load', () => {
  3.   setDebugLevel(DebugLevel.Log);
  4. });
  5. ```

📗 Documentation


To learn more about Papanasi, check the documentation.

📃 License



🚀 Contributing



To build the project run:

  1. ```
  2. > yarn compile
  3. ```

You can choose which frameworks to build by passing the --platforms:

  1. ```
  2. > yarn compile --platforms react vue
  3. ```

It is also possible to specify which components to build --elements:

  1. ```
  2. > yarn compile --elements avatar pill
  3. ```

If you want to disable the linting use --no-lint:

  1. ```
  2. > yarn compile --no-lint
  3. ```

To contribute and watch the changes in local environment just use:

  1. ```
  2. > yarn dev
  3. ```

Finally, to launch storybook use:

  1. ```
  2. > yarn start
  3. ```

Our Sponsors



Sponsor the project

HelpDev

Thanks to everyone who contributed: Contributors


And special thanks to @samijaber @mhevery  and Builder project