@robuust-digital/vue-components 1.3.0 → 1.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Robuust Digital
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+# Robuust Vue 3 Components
+
+A modern and customizable component library built with **Vue 3** and **Tailwind CSS**, designed to deliver a flexible, cohesive UI experience across all projects. Quickly integrate reusable components with ease, and customize them to suit your unique branding needs.
+
+## Features
+
+- ✨ **Vue 3 Components**: Carefully crafted components that work seamlessly with Vue 3
+- 💎 **Tailwind CSS Integration**: Leverage Tailwind CSS for styling, with full theme customization support
+- 🎨 **Theming & Customization**: Tailor components to your project’s branding directly from the `tailwind.config.js`
+- 🖖🏽 **Accessibility First**: Components are designed with accessibility in mind, ensuring compliance with best practices
+- 📦 **Nuxt 3 module available**: Easily integrate with Nuxt 3 projects for seamless server-side rendering and enhanced performance
+
+## Docs
+
+[**See full docs here**](https://robuust.github.io/vue-components/)
+
+## Installation
+
+1. **Install the component library via yarn or npm:**
+
+```bash
+yarn add @robuust-digital/vue-components
+```
+
+```bash
+npm i @robuust-digital/vue-components
+```
+
+2. **Add the component library plugin to your `tailwind.config.js`:**
+
+```javascript
+// tailwind.config.js
+import components from '@robuust-digital/vue-components/tailwind';
+
+export default {
+  theme: {
+    extend: {
+      // Customize component styles here
+      components: (theme) => ({
+        button: {
+          '--rvc-button-height': theme('height.9'),
+          // ...
+        },
+      }),
+    },
+  },
+  plugins: [components],
+};
+```
+
+## Import the CSS
+
+Import our base CSS file in your main entry file:
+
+```javascript
+import '@robuust-digital/vue-components/css';
+```
+
+*This CSS file includes essential base styles and transitions required by the components. Make sure to import it before using any components.*
+
+## For Nuxt 3 Projects
+
+**Add the module to your `nuxt.config.ts` or `nuxt.config.js`:**
+
+```javascript
+export default defineNuxtConfig({
+  modules: ['@robuust-digital/vue-components/nuxt'],
+});
+```
+
+This will automatically register all components globally in your Nuxt application, making them available for immediate use.
+
+
+## License
+
+MIT © Robuust Digital
+
+
+*With `@robuust-digital/vue-components`, bring consistency, flexibility, and a polished look to all your Vue 3 applications.*

package/dist/vue-components.es.js

@@ -1959,14 +1959,12 @@ const Nt = {
         He({ crossAxis: !0, padding: 5 }),
         Re({ element: n }),
         De({
-          /* c8 ignore start */
           apply({ availableWidth: o, availableHeight: y, elements: g }) {
             Object.assign(g.floating.style, {
               maxWidth: a.maxWidth ? `${Math.min(o, a.maxWidth) / 16}rem` : "",
               maxHeight: `${y / 16}rem `
             });
           }
-          /* c8 ignore stop */
         })
       ],
       whileElementsMounted: Ee,

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@robuust-digital/vue-components",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "A modern and customizable component library built with **Vue 3** and **Tailwind CSS**.",
   "directories": {
-    "doc": "docs",
     "test": "tests"
   },
   "repository": {
@@ -20,9 +19,9 @@
   "main": "./dist/vue-components.es.js",
   "module": "./dist/vue-components.es.js",
   "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
+    "./dist",
+    "./README.md",
+    "./LICENSE"
   ],
   "exports": {
     ".": {
@@ -49,6 +48,23 @@
     "@tiptap/vue-3": "^2.11.2",
     "vue": "^3.5.12"
   },
+  "peerDependenciesMeta": {
+    "@floating-ui/vue": {
+      "optional": true
+    },
+    "@headlessui/vue": {
+      "optional": true
+    },
+    "@tiptap/extension-link": {
+      "optional": true
+    },
+    "@tiptap/starter-kit": {
+      "optional": true
+    },
+    "@tiptap/vue-3": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@vitejs/plugin-vue": "~4.5.0",
     "@vitest/coverage-v8": "^2.1.4",