nuance-ui 0.2.6 → 0.2.8

package/dist/runtime/components/tabs/tabs-list.vue.d.ts

@@ -1,7 +1,9 @@
 import type { CSSProperties } from 'vue';
 import type { BoxProps } from '../box.vue.js';
 export interface TabsListProps extends BoxProps {
+    /** If set, tabs take all available width */
     grow?: boolean;
+    /** CSS `justify-content` value for the tab list */
     justify?: CSSProperties['justify-content'];
 }
 declare var __VLS_8: {};

package/dist/runtime/components/tabs/tabs-panel.d.vue.ts

@@ -1,5 +1,6 @@
 import type { BoxProps } from '../box.vue.js';
 export interface TabsPanelProps extends BoxProps {
+    /** Panel value, must match the corresponding `TabsTab` value */
     value: string;
 }
 declare var __VLS_8: {};

package/dist/runtime/components/tabs/tabs-panel.vue.d.ts

@@ -1,5 +1,6 @@
 import type { BoxProps } from '../box.vue.js';
 export interface TabsPanelProps extends BoxProps {
+    /** Panel value, must match the corresponding `TabsTab` value */
     value: string;
 }
 declare var __VLS_8: {};

package/dist/runtime/components/tabs/tabs-root.d.vue.ts

@@ -1,26 +1,53 @@
 import type { NuanceColor, NuanceRadius } from '@nui/types';
 import type { BoxProps } from '../box.vue.js';
 export interface TabsRootProps extends BoxProps {
+    /** Value of the tab activated by default (uncontrolled) */
     defaultTab?: string;
-    /** Tabs orientation, `'horizontal'` by default */
+    /**
+     * Tabs orientation
+     * @default `'horizontal'`
+     */
     orientation?: 'vertical' | 'horizontal';
-    /** `TabsList` placement relative to `TabsPanel`, applicable only when `orientation="vertical"`, `'left'` by default */
+    /**
+     * `TabsList` placement relative to `TabsPanel`, applicable only when `orientation="vertical"`
+     * @default `'left'`
+     */
     placement?: 'left' | 'right';
+    /**
+     * Visual variant
+     * @default `'default'`
+     */
     variant?: 'default' | 'pills' | 'outline';
-    /** Determines whether arrow key presses should loop though items (first to last and last to first), `true` by default */
+    /**
+     * Whether arrow key presses loop through items
+     * @default `true`
+     */
     loop?: boolean;
-    /** Determines whether tab should be activated with arrow key press, `true` by default */
+    /**
+     * Whether a tab is activated on arrow key press
+     * @default `true`
+     */
     activateTabWithKeyboard?: boolean;
-    /** Determines whether tab can be deactivated, `false` by default */
+    /**
+     * Whether a tab can be deactivated
+     * @default `false`
+     */
     allowTabDeactivation?: boolean;
-    /** Changes colors of `TabsTab` components when variant is `pills` or `default`, does nothing for other variants */
+    /** Color from theme */
     color?: NuanceColor;
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, `theme.defaultRadius` by default */
+    /** Border radius */
     radius?: NuanceRadius;
-    /** Determines whether tabs should have inverted styles, `false` by default */
+    /**
+     * Inverts tab styles
+     * @default `false`
+     */
     inverted?: boolean;
-    /** If set to `false`, `TabsPanel` content will be unmounted when the associated tab is not active, `true` by default */
+    /**
+     * If `false`, panel content is unmounted when inactive
+     * @default `true`
+     */
     keepMounted?: boolean;
+    /** Root element id */
     id?: string;
 }
 type __VLS_Props = TabsRootProps;

package/dist/runtime/components/tabs/tabs-root.vue

@@ -1,8 +1,9 @@
 <script setup>
-import { useStyleResolver } from "@nui/composals";
-import { getRadius, getSafeId, getThemeColor } from "@nui/utils";
+import { useStyleResolver } from "@nui/composables";
+import { getRadius, getThemeColor } from "@nui/utils";
+import { computed, onMounted, useId } from "vue";
 import Box from "../box.vue";
-import { useProvideTabsContext } from "../tabs/lib";
+import { getSafeId, useProvideTabsContext } from "./lib";
 import css from "./tabs.module.css";
 const {
   is,

package/dist/runtime/components/tabs/tabs-root.vue.d.ts

@@ -1,26 +1,53 @@
 import type { NuanceColor, NuanceRadius } from '@nui/types';
 import type { BoxProps } from '../box.vue.js';
 export interface TabsRootProps extends BoxProps {
+    /** Value of the tab activated by default (uncontrolled) */
     defaultTab?: string;
-    /** Tabs orientation, `'horizontal'` by default */
+    /**
+     * Tabs orientation
+     * @default `'horizontal'`
+     */
     orientation?: 'vertical' | 'horizontal';
-    /** `TabsList` placement relative to `TabsPanel`, applicable only when `orientation="vertical"`, `'left'` by default */
+    /**
+     * `TabsList` placement relative to `TabsPanel`, applicable only when `orientation="vertical"`
+     * @default `'left'`
+     */
     placement?: 'left' | 'right';
+    /**
+     * Visual variant
+     * @default `'default'`
+     */
     variant?: 'default' | 'pills' | 'outline';
-    /** Determines whether arrow key presses should loop though items (first to last and last to first), `true` by default */
+    /**
+     * Whether arrow key presses loop through items
+     * @default `true`
+     */
     loop?: boolean;
-    /** Determines whether tab should be activated with arrow key press, `true` by default */
+    /**
+     * Whether a tab is activated on arrow key press
+     * @default `true`
+     */
     activateTabWithKeyboard?: boolean;
-    /** Determines whether tab can be deactivated, `false` by default */
+    /**
+     * Whether a tab can be deactivated
+     * @default `false`
+     */
     allowTabDeactivation?: boolean;
-    /** Changes colors of `TabsTab` components when variant is `pills` or `default`, does nothing for other variants */
+    /** Color from theme */
     color?: NuanceColor;
-    /** Key of `theme.radius` or any valid CSS value to set `border-radius`, `theme.defaultRadius` by default */
+    /** Border radius */
     radius?: NuanceRadius;
-    /** Determines whether tabs should have inverted styles, `false` by default */
+    /**
+     * Inverts tab styles
+     * @default `false`
+     */
     inverted?: boolean;
-    /** If set to `false`, `TabsPanel` content will be unmounted when the associated tab is not active, `true` by default */
+    /**
+     * If `false`, panel content is unmounted when inactive
+     * @default `true`
+     */
     keepMounted?: boolean;
+    /** Root element id */
     id?: string;
 }
 type __VLS_Props = TabsRootProps;

package/dist/runtime/components/tabs/tabs-tab.d.vue.ts

@@ -1,15 +1,19 @@
 import type { Mod } from '@nui/utils';
 export interface TabsTabProps {
+    /** Tab value, must match the corresponding `TabsPanel` value */
     value: string;
+    /** Element modifiers transformed into `data-` attributes, falsy values are removed */
     mod?: Mod | Mod[];
+    /** Icon displayed before the label */
+    icon?: string;
 }
-declare var __VLS_10: {}, __VLS_12: {}, __VLS_14: {};
+declare var __VLS_10: {}, __VLS_17: {}, __VLS_19: {};
 type __VLS_Slots = {} & {
     leftSection?: (props: typeof __VLS_10) => any;
 } & {
-    default?: (props: typeof __VLS_12) => any;
+    default?: (props: typeof __VLS_17) => any;
 } & {
-    rightSection?: (props: typeof __VLS_14) => any;
+    rightSection?: (props: typeof __VLS_19) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<TabsTabProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<TabsTabProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/runtime/components/tabs/tabs-tab.vue

@@ -3,9 +3,10 @@ import { computed } from "vue";
 import UnstyledButton from "../button/unstyled-button.vue";
 import { useTabsState } from "./lib";
 import css from "./tabs.module.css";
-const { value, mod } = defineProps({
+const { value, mod, icon } = defineProps({
   value: { type: String, required: true },
-  mod: { type: [Object, Array], required: false }
+  mod: { type: [Object, Array], required: false },
+  icon: { type: String, required: false }
 });
 const ctx = useTabsState();
 const active = computed(() => value === ctx?.active.value);
@@ -28,8 +29,10 @@ const active = computed(() => value === ctx?.active.value);
 		:aria-controls='ctx?.getPanelId(value)'
 		@click='ctx?.onUpdate(value)'
 	>
-		<span v-if='$slots.leftSection' :class='css.tabSection' data-position='left'>
-			<slot name='leftSection' />
+		<span v-if='$slots.leftSection || icon' :class='css.tabSection' data-position='left'>
+			<slot name='leftSection'>
+				<Icon v-if='icon' :name='icon' />
+			</slot>
 		</span>
 		<span v-if='$slots.default' :class='css.tabLabel'>
 			<slot />

package/dist/runtime/components/tabs/tabs-tab.vue.d.ts

@@ -1,15 +1,19 @@
 import type { Mod } from '@nui/utils';
 export interface TabsTabProps {
+    /** Tab value, must match the corresponding `TabsPanel` value */
     value: string;
+    /** Element modifiers transformed into `data-` attributes, falsy values are removed */
     mod?: Mod | Mod[];
+    /** Icon displayed before the label */
+    icon?: string;
 }
-declare var __VLS_10: {}, __VLS_12: {}, __VLS_14: {};
+declare var __VLS_10: {}, __VLS_17: {}, __VLS_19: {};
 type __VLS_Slots = {} & {
     leftSection?: (props: typeof __VLS_10) => any;
 } & {
-    default?: (props: typeof __VLS_12) => any;
+    default?: (props: typeof __VLS_17) => any;
 } & {
-    rightSection?: (props: typeof __VLS_14) => any;
+    rightSection?: (props: typeof __VLS_19) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<TabsTabProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<TabsTabProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

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

@@ -14,12 +14,17 @@ export interface TextProps extends BoxProps {
     inline?: boolean;
     /** Determines whether font properties should be inherited from the parent, `false` by default */
     inherit?: boolean;
-    /** Gradient configuration, ignored when `variant` is not `gradient`, `theme.defaultGradient` by default */
+    /** Gradient configuration (used with `variant="gradient"`) */
     gradient?: NuanceGradient;
+    /** Visual variant */
     variant?: 'text' | 'gradient';
+    /** Font size token */
     fz?: NuanceSize | `h${TitleOrder}` | string;
+    /** Line height token */
     lh?: NuanceSize | string;
+    /** Font weight */
     fw?: CSSProperties['font-weight'];
+    /** Text color from theme */
     c?: NuanceColor | 'dimmed';
 }
 declare var __VLS_8: {};

package/dist/runtime/components/text.vue

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

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

@@ -14,12 +14,17 @@ export interface TextProps extends BoxProps {
     inline?: boolean;
     /** Determines whether font properties should be inherited from the parent, `false` by default */
     inherit?: boolean;
-    /** Gradient configuration, ignored when `variant` is not `gradient`, `theme.defaultGradient` by default */
+    /** Gradient configuration (used with `variant="gradient"`) */
     gradient?: NuanceGradient;
+    /** Visual variant */
     variant?: 'text' | 'gradient';
+    /** Font size token */
     fz?: NuanceSize | `h${TitleOrder}` | string;
+    /** Line height token */
     lh?: NuanceSize | string;
+    /** Font weight */
     fw?: CSSProperties['font-weight'];
+    /** Text color from theme */
     c?: NuanceColor | 'dimmed';
 }
 declare var __VLS_8: {};

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

@@ -1,22 +1,24 @@
 import type { InputBaseProps, InputWrapperProps } from './input/index.js';
 export interface TextareaProps extends InputWrapperProps, InputBaseProps {
+    /** Icon displayed in the left section */
+    icon?: string;
 }
 type __VLS_Props = TextareaProps;
 type __VLS_ModelProps = {
     modelValue?: string;
 };
 type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
-declare var __VLS_15: {}, __VLS_19: {}, __VLS_22: {}, __VLS_25: {}, __VLS_28: {};
+declare var __VLS_15: {}, __VLS_24: {}, __VLS_27: {}, __VLS_30: {}, __VLS_33: {};
 type __VLS_Slots = {} & {
     leftSection?: (props: typeof __VLS_15) => any;
 } & {
-    rightSection?: (props: typeof __VLS_19) => any;
+    rightSection?: (props: typeof __VLS_24) => any;
 } & {
-    label?: (props: typeof __VLS_22) => any;
+    label?: (props: typeof __VLS_27) => any;
 } & {
-    error?: (props: typeof __VLS_25) => any;
+    error?: (props: typeof __VLS_30) => any;
 } & {
-    description?: (props: typeof __VLS_28) => any;
+    description?: (props: typeof __VLS_33) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {
     $el: HTMLTextAreaElement | null | undefined;

package/dist/runtime/components/textarea.vue

@@ -3,7 +3,8 @@ import { unrefElement, useTextareaAutosize } from "@vueuse/core";
 import { useTemplateRef } from "vue";
 import InputBase from "./input/ui/input-base.vue";
 import InputWrapper from "./input/ui/input-wrapper.vue";
-const props = defineProps({
+const { icon, ...props } = defineProps({
+  icon: { type: String, required: false },
   error: { type: String, required: false },
   description: { type: String, required: false },
   label: { type: String, required: false },
@@ -34,8 +35,10 @@ defineExpose({
 <template>
 	<InputWrapper v-bind='props' :multiline :class='$attrs?.class'>
 		<InputBase>
-			<template v-if='!!$slots.leftSection' #leftSection>
-				<slot name='leftSection' />
+			<template v-if='!!$slots.leftSection || icon' #leftSection>
+				<slot name='leftSection'>
+					<Icon v-if='icon' :name='icon' />
+				</slot>
 			</template>
 
 			<template #default='{ id, css }'>

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

@@ -1,22 +1,24 @@
 import type { InputBaseProps, InputWrapperProps } from './input/index.js';
 export interface TextareaProps extends InputWrapperProps, InputBaseProps {
+    /** Icon displayed in the left section */
+    icon?: string;
 }
 type __VLS_Props = TextareaProps;
 type __VLS_ModelProps = {
     modelValue?: string;
 };
 type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
-declare var __VLS_15: {}, __VLS_19: {}, __VLS_22: {}, __VLS_25: {}, __VLS_28: {};
+declare var __VLS_15: {}, __VLS_24: {}, __VLS_27: {}, __VLS_30: {}, __VLS_33: {};
 type __VLS_Slots = {} & {
     leftSection?: (props: typeof __VLS_15) => any;
 } & {
-    rightSection?: (props: typeof __VLS_19) => any;
+    rightSection?: (props: typeof __VLS_24) => any;
 } & {
-    label?: (props: typeof __VLS_22) => any;
+    label?: (props: typeof __VLS_27) => any;
 } & {
-    error?: (props: typeof __VLS_25) => any;
+    error?: (props: typeof __VLS_30) => any;
 } & {
-    description?: (props: typeof __VLS_28) => any;
+    description?: (props: typeof __VLS_33) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {
     $el: HTMLTextAreaElement | null | undefined;

package/dist/runtime/components/time-picker/index.d.ts

@@ -2,5 +2,5 @@ export * from './lib/clamp-time.js';
 export * from './lib/get-time-string.js';
 export * from './lib/pad-time.js';
 export * from './lib/split-time-string.js';
-export * from './model.js';
 export type * from './time-picker.vue';
+export * from './types.js';

package/dist/runtime/components/time-picker/index.js

@@ -2,4 +2,4 @@ export * from "./lib/clamp-time.js";
 export * from "./lib/get-time-string.js";
 export * from "./lib/pad-time.js";
 export * from "./lib/split-time-string.js";
-export * from "./model.js";
+export * from "./types.js";

package/dist/runtime/components/time-picker/lib/get-parsed-time.d.ts

@@ -1,4 +1,4 @@
-import type { TimePickerAmPmLabels, TimePickerFormat } from '../model.js';
+import type { TimePickerAmPmLabels, TimePickerFormat } from '../types.js';
 export declare function getParsedTime({ time, format, amPmLabels }: {
     time: string;
     format: TimePickerFormat;

package/dist/runtime/components/time-picker/lib/get-time-string.d.ts

@@ -1,4 +1,4 @@
-import type { TimePickerAmPmLabels, TimePickerFormat } from '../model.js';
+import type { TimePickerAmPmLabels, TimePickerFormat } from '../types.js';
 export declare function getTimeString({ hours, minutes, seconds, format, withSeconds, amPm, amPmLabels, }: {
     hours: number | null;
     minutes: number | null;

package/dist/runtime/components/time-picker/lib/use-time-picker.d.ts

@@ -1,5 +1,5 @@
 import type { ModelRef } from 'vue';
-import type { TimePickerAmPmLabels, TimePickerFormat, TimePickerPasteSplit } from '../model.js';
+import type { TimePickerAmPmLabels, TimePickerFormat, TimePickerPasteSplit } from '../types.js';
 type TimeField = 'hours' | 'minutes' | 'seconds' | 'amPm';
 export declare function useTimePicker({ model, format, amPmLabels, withSeconds, min, max, pasteSplit, }: {
     model: ModelRef<string | undefined>;

package/dist/runtime/components/time-picker/time-picker.d.vue.ts

@@ -1,7 +1,7 @@
 import type { Classes } from '@nui/types';
 import type { InputBaseProps } from '../input/index.js';
 import type { InputWrapperProps } from '../input/ui/input-wrapper.vue.js';
-import type { TimePickerAmPmLabels, TimePickerFormat, TimePickerPasteSplit } from './model.js';
+import type { TimePickerAmPmLabels, TimePickerFormat, TimePickerPasteSplit } from './types.js';
 /**
  * - presets
  * - dropdown select
@@ -18,23 +18,23 @@ interface FieldStep {
     seconds?: number;
 }
 interface FieldPlaceholder {
-    /** Hours input placeholder, @default `--` */
+    /** Hours input placeholder @default `--` */
     hours?: string;
-    /** Minutes input placeholder, @default `--` */
+    /** Minutes input placeholder @default `--` */
     minutes?: string;
-    /** Seconds input placeholder, @default `--` */
+    /** Seconds input placeholder @default `--` */
     seconds?: string;
 }
 export interface TimePickerProps extends InputWrapperProps, InputBaseProps {
     /** Determines whether the clear button should be displayed @default `false` */
     clearable?: boolean;
-    /** `name` prop passed down to the hidden input */
+    /** Input name */
     name?: string;
     /** Min possible time value in `hh:mm:ss` format @default `00:00:00` */
     min?: string;
     /** Max possible time value in `hh:mm:ss` format @default `23:59:59` */
     max?: string;
-    /** Time format, @default `24h` */
+    /** Time format @default `24h` */
     format?: TimePickerFormat;
     /** Number by which fields are incremented/decremented @default `1` */
     step?: number | FieldStep;
@@ -52,8 +52,9 @@ export interface TimePickerProps extends InputWrapperProps, InputBaseProps {
     amPmInputLabel?: string;
     /** Labels used for am/pm values @default `{ am: 'AM', pm: 'PM' }` @todo @deprecated */
     amPmLabels?: TimePickerAmPmLabels;
-    /** A function to transform pasted values, by default time in 24h format can be parsed on paste for example `23:34:22` */
+    /** Transform pasted values; by default parses 24h format like `23:34:22` */
     pasteSplit?: TimePickerPasteSplit;
+    /** Styles API */
     classes?: Classes<'root' | 'input' | 'section' | 'field'>;
 }
 type __VLS_Props = TimePickerProps;