nuance-ui 0.2.5 → 0.2.7

package/LICENSE.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2023 NuxtLabs
-
-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.
+MIT License
+
+Copyright (c) 2023 NuxtLabs
+
+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

@@ -1,75 +1,75 @@
-# Nuance-UI
-
-A modern UI kit module for Nuxt 3 with thoughtfully designed components and subtle interaction details.
-
-## 📦 Installation
-
-```bash
-# npm
-npm install nuance-ui
-
-# yarn
-yarn add nuance-ui
-
-# pnpm
-pnpm add nuance-ui
-```
-
-### Install modules
-
-```bash
-npx nuxt module add color-mode icon
-```
-
-## Quick Start
-
-Add `nuance-ui` to the `modules` section of your `nuxt.config.ts`:
-
-```typescript
-export default defineNuxtConfig({
-	modules: ['nuance-ui'],
-})
-```
-
-Now you can use components in your application:
-
-```vue
-<template>
-	<div>
-		<NButton variant='primary'>
-			Click me
-		</NButton>
-
-		<NCard>
-			<p>Card content goes here</p>
-		</NCard>
-	</div>
-</template>
-```
-
-## Contributing
-
-We welcome contributions! Please:
-
-1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## Links
-
-- Documentation **WIP**
-- [GitHub](https://github.com/Igor-Iugin/nuance-ui)
-- [NPM](https://www.npmjs.com/package/nuance-ui)
-
-## Support
-
-If you have questions or issues:
-
-- [Create an Issue](https://github.com/Igor-Iugin/nuance-ui/issues)
-- [Discussions](https://github.com/Igor-Iugin/nuance-ui/discussions)
-
-## License
-
-Licensed under the [MIT license](https://github.com/Igor-Iugin/nuance-ui/blob/main/LICENSE.md).
+# Nuance-UI
+
+A modern UI kit module for Nuxt 3 with thoughtfully designed components and subtle interaction details.
+
+## 📦 Installation
+
+```bash
+# npm
+npm install nuance-ui
+
+# yarn
+yarn add nuance-ui
+
+# pnpm
+pnpm add nuance-ui
+```
+
+### Install modules
+
+```bash
+npx nuxt module add color-mode icon
+```
+
+## Quick Start
+
+Add `nuance-ui` to the `modules` section of your `nuxt.config.ts`:
+
+```typescript
+export default defineNuxtConfig({
+	modules: ['nuance-ui'],
+})
+```
+
+Now you can use components in your application:
+
+```vue
+<template>
+	<div>
+		<NButton variant='primary'>
+			Click me
+		</NButton>
+
+		<NCard>
+			<p>Card content goes here</p>
+		</NCard>
+	</div>
+</template>
+```
+
+## Contributing
+
+We welcome contributions! Please:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Links
+
+- Documentation **WIP**
+- [GitHub](https://github.com/Igor-Iugin/nuance-ui)
+- [NPM](https://www.npmjs.com/package/nuance-ui)
+
+## Support
+
+If you have questions or issues:
+
+- [Create an Issue](https://github.com/Igor-Iugin/nuance-ui/issues)
+- [Discussions](https://github.com/Igor-Iugin/nuance-ui/discussions)
+
+## License
+
+Licensed under the [MIT license](https://github.com/Igor-Iugin/nuance-ui/blob/main/LICENSE.md).

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^4.0.0"
   },
-  "version": "0.2.5",
+  "version": "0.2.7",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -33,10 +33,9 @@ const module$1 = defineNuxtModule({
   setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
     const aliases = {
-      composals: resolve("./runtime/composals"),
+      composables: resolve("./runtime/composables"),
       components: resolve("./runtime/components"),
       utils: resolve("./runtime/utils"),
-      helpers: resolve("./runtime/helpers"),
       types: resolve("./runtime/types"),
       modals: resolve("./runtime/modals")
     };
@@ -61,7 +60,7 @@ const module$1 = defineNuxtModule({
     });
     if (options.autoImport) {
       addComponentsDir({
-        path: resolve("./runtime/components"),
+        path: aliases.components,
         prefix: options.prefix,
         pathPrefix: false,
         extensions: [".vue"],
@@ -71,8 +70,8 @@ const module$1 = defineNuxtModule({
           "**/*.module.css"
         ]
       });
-      addImportsDir(resolve("./runtime/composals"));
-      addImportsDir(resolve("./runtime/helpers"));
+      addImportsDir(aliases.composables);
+      addImportsDir(aliases.utils);
     }
     nuxt.options.css.push(resolve("./runtime/styles/global.css"));
   }

package/dist/runtime/components/action-icon/action-icon-group.d.vue.ts

@@ -1,5 +1,9 @@
 import type { BoxProps } from '../box.vue.js';
 export interface ActionIconGroupProps extends BoxProps {
+    /**
+     * Layout direction of the group
+     * @default 'horizontal'
+     */
     orientation?: 'horizontal' | 'vertical';
 }
 declare var __VLS_8: {};

package/dist/runtime/components/action-icon/action-icon-group.vue

@@ -9,7 +9,7 @@ const { mod, orientation = "horizontal", is } = defineProps({
 </script>
 
 <template>
-	<Box :is :class='css.group' :mod='[mod, { orientation }]' role='group'>
-		<slot />
-	</Box>
+	<Box :is :class='css.group' :mod='[mod, { orientation }]' role='group'>
+		<slot />
+	</Box>
 </template>

package/dist/runtime/components/action-icon/action-icon-group.vue.d.ts

@@ -1,5 +1,9 @@
 import type { BoxProps } from '../box.vue.js';
 export interface ActionIconGroupProps extends BoxProps {
+    /**
+     * Layout direction of the group
+     * @default 'horizontal'
+     */
     orientation?: 'horizontal' | 'vertical';
 }
 declare var __VLS_8: {};

package/dist/runtime/components/action-icon/action-icon-section.d.vue.ts

@@ -1,11 +1,20 @@
 import type { NuanceColor, NuanceGradient, NuanceRadius, NuanceSize } from '@nui/types';
 import type { BoxProps } from '../box.vue.js';
 export interface ActionIconSectionProps extends BoxProps {
+    /** Component size */
     size?: NuanceSize | `compact-${NuanceSize}`;
+    /**
+     * Visual variant
+     * @default 'default'
+     */
     variant?: 'filled' | 'light' | 'outline' | 'subtle' | 'default' | 'gradient';
+    /** Gradient configuration (used with `variant="gradient"`) */
     gradient?: NuanceGradient;
+    /** Loading state */
     loading?: boolean;
+    /** Color from theme */
     color?: NuanceColor;
+    /** Border radius */
     radius?: NuanceRadius;
 }
 declare var __VLS_8: {};

package/dist/runtime/components/action-icon/action-icon-section.vue

@@ -1,5 +1,5 @@
 <script setup>
-import { useStyleResolver } from "@nui/composals";
+import { useStyleResolver } from "@nui/composables";
 import { createVariantColorResolver, getFontSize, getRadius, getSize } from "@nui/utils";
 import { computed } from "vue";
 import Box from "../box.vue";

package/dist/runtime/components/action-icon/action-icon-section.vue.d.ts

@@ -1,11 +1,20 @@
 import type { NuanceColor, NuanceGradient, NuanceRadius, NuanceSize } from '@nui/types';
 import type { BoxProps } from '../box.vue.js';
 export interface ActionIconSectionProps extends BoxProps {
+    /** Component size */
     size?: NuanceSize | `compact-${NuanceSize}`;
+    /**
+     * Visual variant
+     * @default 'default'
+     */
     variant?: 'filled' | 'light' | 'outline' | 'subtle' | 'default' | 'gradient';
+    /** Gradient configuration (used with `variant="gradient"`) */
     gradient?: NuanceGradient;
+    /** Loading state */
     loading?: boolean;
+    /** Color from theme */
     color?: NuanceColor;
+    /** Border radius */
     radius?: NuanceRadius;
 }
 declare var __VLS_8: {};

package/dist/runtime/components/action-icon/action-icon.d.vue.ts

@@ -1,19 +1,28 @@
-import type { NuanceColor, NuanceGradient, NuanceRadius, NuanceSize } from '@nui/types';
+import type { Classes, NuanceColor, NuanceGradient, NuanceRadius, NuanceSize } from '@nui/types';
 import type { BoxProps } from '../box.vue.js';
 export interface ActionIconProps {
+    /** Component size */
     size?: NuanceSize | `input-${NuanceSize}` | string;
+    /**
+     * Visual variant
+     * @default 'default'
+     */
     variant?: 'filled' | 'light' | 'outline' | 'subtle' | 'default' | 'gradient';
+    /** Gradient configuration (used with `variant="gradient"`) */
     gradient?: NuanceGradient;
+    /** Loading state */
     loading?: boolean;
+    /** Color from theme */
     color?: NuanceColor;
+    /** Border radius */
     radius?: NuanceRadius;
     /** Styles API */
-    classes?: {
-        root?: string;
-        icon?: string;
-    };
+    classes?: Classes<'root' | 'icon'>;
+    /** Modifiers passed through to the underlying `Box` */
     mod?: BoxProps['mod'];
+    /** Icon name rendered inside the button when no default slot is provided */
     icon?: string;
+    /** Disables the component */
     disabled?: boolean;
 }
 declare var __VLS_19: {};

package/dist/runtime/components/action-icon/action-icon.vue

@@ -1,5 +1,5 @@
 <script setup>
-import { useStyleResolver } from "@nui/composals";
+import { useStyleResolver } from "@nui/composables";
 import { createVariantColorResolver, getRadius, getSize } from "@nui/utils";
 import { computed } from "vue";
 import Box from "../box.vue";
@@ -49,6 +49,7 @@ const style = computed(() => useStyleResolver((theme) => {
 <template>
 	<Box
 		is='button'
+		type='button'
 		:mod='[{ loading }, mod]'
 		:style
 		:class='[css.root, classes?.root]'

package/dist/runtime/components/action-icon/action-icon.vue.d.ts

@@ -1,19 +1,28 @@
-import type { NuanceColor, NuanceGradient, NuanceRadius, NuanceSize } from '@nui/types';
+import type { Classes, NuanceColor, NuanceGradient, NuanceRadius, NuanceSize } from '@nui/types';
 import type { BoxProps } from '../box.vue.js';
 export interface ActionIconProps {
+    /** Component size */
     size?: NuanceSize | `input-${NuanceSize}` | string;
+    /**
+     * Visual variant
+     * @default 'default'
+     */
     variant?: 'filled' | 'light' | 'outline' | 'subtle' | 'default' | 'gradient';
+    /** Gradient configuration (used with `variant="gradient"`) */
     gradient?: NuanceGradient;
+    /** Loading state */
     loading?: boolean;
+    /** Color from theme */
     color?: NuanceColor;
+    /** Border radius */
     radius?: NuanceRadius;
     /** Styles API */
-    classes?: {
-        root?: string;
-        icon?: string;
-    };
+    classes?: Classes<'root' | 'icon'>;
+    /** Modifiers passed through to the underlying `Box` */
     mod?: BoxProps['mod'];
+    /** Icon name rendered inside the button when no default slot is provided */
     icon?: string;
+    /** Disables the component */
     disabled?: boolean;
 }
 declare var __VLS_19: {};

package/dist/runtime/components/alert.d.vue.ts

@@ -1,31 +1,27 @@
-import type { NuanceColor, NuanceRadius } from '@nui/types';
+import type { Classes, NuanceColor, NuanceRadius } from '@nui/types';
 import type { BoxProps } from './box.vue.js';
 export interface AlertProps extends BoxProps {
+    /**
+     * Visual variant
+     * @default 'light'
+     */
     variant?: 'filled' | 'light' | 'outline' | 'default';
-    /** Key of `theme.radius` or any valid CSS value to set border-radius @default `theme.defaultRadius` */
+    /** Border radius */
     radius?: NuanceRadius;
-    /** Key of `theme.colors` or any valid CSS color @default `theme.primaryColor`  */
+    /** Color from theme */
     color?: NuanceColor;
     /** Alert title */
     title?: string;
     /** Icon displayed next to the title */
     icon?: string;
-    /** Determines whether close button should be displayed @default `false` */
+    /** Renders a close button in the top-right corner */
     withCloseButton?: boolean;
     /** Called when the close button is clicked */
     onClose?: () => void;
-    /** Close button `aria-label` */
+    /** `aria-label` for the close button */
     closeButtonLabel?: string;
     /** Styles API */
-    classes?: {
-        root?: string;
-        icon?: string;
-        body?: string;
-        title?: string;
-        label?: string;
-        message?: string;
-        closeButton?: string;
-    };
+    classes?: Classes<'root' | 'icon' | 'body' | 'title' | 'label' | 'message' | 'closeButton'>;
 }
 declare var __VLS_19: {}, __VLS_27: {};
 type __VLS_Slots = {} & {

package/dist/runtime/components/alert.vue

@@ -1,5 +1,5 @@
 <script setup>
-import { useStyleResolver } from "@nui/composals";
+import { useStyleResolver } from "@nui/composables";
 import { createVariantColorResolver, getRadius } from "@nui/utils";
 import { computed, useId } from "vue";
 import ActionIcon from "./action-icon/action-icon.vue";

package/dist/runtime/components/alert.vue.d.ts

@@ -1,31 +1,27 @@
-import type { NuanceColor, NuanceRadius } from '@nui/types';
+import type { Classes, NuanceColor, NuanceRadius } from '@nui/types';
 import type { BoxProps } from './box.vue.js';
 export interface AlertProps extends BoxProps {
+    /**
+     * Visual variant
+     * @default 'light'
+     */
     variant?: 'filled' | 'light' | 'outline' | 'default';
-    /** Key of `theme.radius` or any valid CSS value to set border-radius @default `theme.defaultRadius` */
+    /** Border radius */
     radius?: NuanceRadius;
-    /** Key of `theme.colors` or any valid CSS color @default `theme.primaryColor`  */
+    /** Color from theme */
     color?: NuanceColor;
     /** Alert title */
     title?: string;
     /** Icon displayed next to the title */
     icon?: string;
-    /** Determines whether close button should be displayed @default `false` */
+    /** Renders a close button in the top-right corner */
     withCloseButton?: boolean;
     /** Called when the close button is clicked */
     onClose?: () => void;
-    /** Close button `aria-label` */
+    /** `aria-label` for the close button */
     closeButtonLabel?: string;
     /** Styles API */
-    classes?: {
-        root?: string;
-        icon?: string;
-        body?: string;
-        title?: string;
-        label?: string;
-        message?: string;
-        closeButton?: string;
-    };
+    classes?: Classes<'root' | 'icon' | 'body' | 'title' | 'label' | 'message' | 'closeButton'>;
 }
 declare var __VLS_19: {}, __VLS_27: {};
 type __VLS_Slots = {} & {

package/dist/runtime/components/app-shell/app-shell-aside.vue

@@ -7,37 +7,37 @@ const { mod } = defineProps({
 </script>
 
 <template>
-	<Box is='aside' :mod :class='$style.root'>
-		<slot />
-	</Box>
+	<Box is='aside' :mod :class='$style.root'>
+		<slot />
+	</Box>
 </template>
 
 <style module lang="postcss">
-.root {
-	position: fixed;
-	z-index: 1;
-	top: var(--app-shell-header-offset, 0);
-
-	inset-inline-end: 0;
-	transform: var(--app-shell-aside-transform);
-
-	display: flex;
-	flex-direction: column;
-
-	width: var(--app-shell-aside-width);
-
-	height: calc(100dvh - var(--app-shell-header-offset, 0rem));
-
-	padding-block: var(--app-shell-element-padding);
-
-	background-color: var(--color-aside);
-
-	transition-timing-function: var(--app-shell-transition-timing-function);
-	transition-duration: var(--app-shell-transition-duration);
-	transition-property: transform, top, height;
-
-	:where([data-with-border]) > & {
-		border-inline-start: 1px solid var(--app-shell-border-color);
-	}
-}
+.root {
+	position: fixed;
+	z-index: 1;
+	top: var(--app-shell-header-offset, 0);
+
+	inset-inline-end: 0;
+	transform: var(--app-shell-aside-transform);
+
+	display: flex;
+	flex-direction: column;
+
+	width: var(--app-shell-aside-width);
+
+	height: calc(100dvh - var(--app-shell-header-offset, 0rem));
+
+	padding-block: var(--app-shell-element-padding);
+
+	background-color: var(--color-aside);
+
+	transition-timing-function: var(--app-shell-transition-timing-function);
+	transition-duration: var(--app-shell-transition-duration);
+	transition-property: transform, top, height;
+
+	:where([data-with-border]) > & {
+		border-inline-start: 1px solid var(--app-shell-border-color);
+	}
+}
 </style>

package/dist/runtime/components/app-shell/app-shell-footer.vue

@@ -7,36 +7,36 @@ const { mod } = defineProps({
 </script>
 
 <template>
-	<Box is='footer' :mod :class='$style.root'>
-		<slot />
-	</Box>
+	<Box is='footer' :mod :class='$style.root'>
+		<slot />
+	</Box>
 </template>
 
 <style module lang="postcss">
-.root {
-	position: fixed;
-	z-index: 1;
-
-	bottom: 0;
-	inset-inline: 0;
-	transform: var(--app-shell-footer-transform);
-
-	height: calc(var(--app-shell-footer-height) + env(safe-area-inset-bottom));
-	padding-bottom: env(safe-area-inset-bottom);
-
-	background-color: var(--color-body);
-
-	transition-timing-function: var(--app-shell-transition-timing-function);
-	transition-duration: var(--app-shell-transition-duration);
-	transition-property: transform, left, right;
-
-	:where([data-layout='alt']) > & {
-		inset-inline-start: var(--app-shell-navbar-offset, 0rem);
-		inset-inline-end: var(--app-shell-aside-offset, 0rem);
-	}
-
-	:where([data-with-border]) > & {
-		border-top: 1px solid var(--app-shell-border-color);
-	}
-}
+.root {
+	position: fixed;
+	z-index: 1;
+
+	bottom: 0;
+	inset-inline: 0;
+	transform: var(--app-shell-footer-transform);
+
+	height: calc(var(--app-shell-footer-height) + env(safe-area-inset-bottom));
+	padding-bottom: env(safe-area-inset-bottom);
+
+	background-color: var(--color-body);
+
+	transition-timing-function: var(--app-shell-transition-timing-function);
+	transition-duration: var(--app-shell-transition-duration);
+	transition-property: transform, left, right;
+
+	:where([data-layout='alt']) > & {
+		inset-inline-start: var(--app-shell-navbar-offset, 0rem);
+		inset-inline-end: var(--app-shell-aside-offset, 0rem);
+	}
+
+	:where([data-with-border]) > & {
+		border-top: 1px solid var(--app-shell-border-color);
+	}
+}
 </style>