portalis-component

Portalis Component Library

Portalis is a component library for Nuxt.js 3, providing a collection of ready-to-use components built with Vue.js and TailwindCSS. These components are designed to be SSR-safe and are inspired by the sleek design principles of Vuetify.

📦 Installation

You can install Portalis via npm:

npm i @portalis/dev

Add the @portalis/dev module to your nuxt.config.ts:

export default defineNuxtConfig({
  modules: ["@portalis/dev"],
});

📚 Documentation

For full documentation and usage instructions, please visit Documentation.

✨ Features

• Ready-to-use Components: A variety of components designed for rapid development.
• SSR-Safe: Ensures compatibility with server-side rendering in Nuxt.js applications.
• Inspired by Vuetify: Draws design inspiration from Vuetify's intuitive UI components.
• Built with Vue.js and TailwindCSS: Utilizes the power of Vue.js for interactivity and TailwindCSS for styling flexibility.

🚀 Getting Started

To start using Portalis components in your Nuxt.js project, simply install the package via your preferred package manager as shown above. Then you can start incorporating them into your templates.

// In your Nuxt.js component
<template>
  <div>
    <Portalis-Button @click="handleClick">Click me!</Portalis-Button>
  </div>
</template>

<script setup lang="ts">
function handleClick() {
  console.log("Button clicked!");
}
</script>

🤝 Contribution

Contributions to Portalis are welcome! If you'd like to contribute new features, bug fixes, or improvements, please fork the repository, make your changes, and submit a pull request. Be sure to follow the contribution guidelines outlined in the documentation.

📄 License

Portalis is licensed under the MIT License. See the LICENSE file for more information.