nuance-ui 0.2.7 → 0.2.8

package/dist/runtime/components/combobox/types.d.ts

@@ -4,17 +4,25 @@ interface BaseComboboxFields {
     disabled?: boolean;
     icon?: string;
 }
+/** Extra fields allowed on a combobox item beyond the base fields */
 export type ComboboxItemExt = Omit<object, keyof BaseComboboxFields>;
+/** Single selectable option */
 export type ComboboxItem<Value extends string = string, Ext extends ComboboxItemExt = object> = BaseComboboxFields & {
     value: Value;
 } & Ext;
+/** Grouped set of combobox items */
 export interface ComboboxItemGroup<_Value extends string = string, Ext extends ComboboxItemExt = object> {
+    /** Group label */
     group: string;
+    /** Group icon */
     icon?: string;
     items: ComboboxItem<any, Ext>[];
 }
+/** A flat item or a group of items */
 export type ComboboxOption<Value extends string = string, Ext extends ComboboxItemExt = object> = ComboboxItem<Value, Ext> | ComboboxItemGroup<Value, Ext>;
+/** Full list of combobox options */
 export type ComboboxData<Value extends string = string, Ext extends ComboboxItemExt = object> = ComboboxOption<Value, Ext>[];
+/** Source that triggered a dropdown open/close event */
 export type ComboboxDropdownEventSource = 'keyboard' | 'mouse' | 'unknown';
 export interface ComboboxRootEmits {
     clear: [];
@@ -27,8 +35,11 @@ export interface ComboboxRootEmits {
     submit: [string, ComboboxItem];
 }
 export interface ComboboxItemProps {
+    /** Shows a check icon next to the selected option */
     withCheckIcon?: boolean;
+    /** Icon name for the check mark */
     checkIcon?: string;
+    /** Position of the check icon relative to the label */
     iconPosition?: 'left' | 'right';
 }
 export {};

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

@@ -1,7 +1,9 @@
 import type { NuanceSize } from '@nui/types';
 import type { BoxProps } from './box.vue.js';
 export interface ContainerProps extends BoxProps {
+    /** Component size */
     size?: NuanceSize | string | number;
+    /** Removes max-width constraint */
     fluid?: boolean;
 }
 declare var __VLS_8: {};

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

@@ -1,7 +1,9 @@
 import type { NuanceSize } from '@nui/types';
 import type { BoxProps } from './box.vue.js';
 export interface ContainerProps extends BoxProps {
+    /** Component size */
     size?: NuanceSize | string | number;
+    /** Removes max-width constraint */
     fluid?: boolean;
 }
 declare var __VLS_8: {};

package/dist/runtime/components/dialog/types.d.ts

@@ -5,5 +5,6 @@ export interface DialogEmits {
     close: [];
 }
 export interface DialogModel {
+    /** Controls open/closed state */
     open: boolean;
 }

package/dist/runtime/components/files/file-upload-button.d.vue.ts

@@ -5,20 +5,22 @@ export interface FileUploadButtonProps<M extends boolean> extends ButtonProps, U
     /** Icon passed to leftSection */
     icon?: string;
     /**
+     * Allows selecting multiple files
      * @default false
      */
     multiple?: MaybeRef<M>;
     /**
+     * Accepted file types
      * @default '*'
      */
     accept?: MaybeRef<string>;
     /**
-     * Reset when open file dialog.
+     * Resets selected files when the dialog opens
      * @default false
      */
     reset?: MaybeRef<boolean>;
     /**
-     * Select directories instead of files.
+     * Selects directories instead of files
      * @see [HTMLInputElement webkitdirectory](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory)
      * @default false
      */

package/dist/runtime/components/files/file-upload-button.vue

@@ -60,16 +60,16 @@ defineExpose({ files, reset });
 </script>
 
 <template>
-	<Button v-bind='props' @click='open'>
-		<template #leftSection>
-			<slot name='leftSection'>
-				<Icon :name='icon' />
-			</slot>
-		</template>
-		<template v-if='!!$slots.rightSection' #rightSection>
-			<slot name='rightSection' />
-		</template>
-
-		<slot>Загрузить файл</slot>
-	</Button>
+	<Button v-bind='props' @click='open'>
+		<template #leftSection>
+			<slot name='leftSection'>
+				<Icon :name='icon' />
+			</slot>
+		</template>
+		<template v-if='!!$slots.rightSection' #rightSection>
+			<slot name='rightSection' />
+		</template>
+
+		<slot>Загрузить файл</slot>
+	</Button>
 </template>

package/dist/runtime/components/files/file-upload-button.vue.d.ts

@@ -5,20 +5,22 @@ export interface FileUploadButtonProps<M extends boolean> extends ButtonProps, U
     /** Icon passed to leftSection */
     icon?: string;
     /**
+     * Allows selecting multiple files
      * @default false
      */
     multiple?: MaybeRef<M>;
     /**
+     * Accepted file types
      * @default '*'
      */
     accept?: MaybeRef<string>;
     /**
-     * Reset when open file dialog.
+     * Resets selected files when the dialog opens
      * @default false
      */
     reset?: MaybeRef<boolean>;
     /**
-     * Select directories instead of files.
+     * Selects directories instead of files
      * @see [HTMLInputElement webkitdirectory](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory)
      * @default false
      */

package/dist/runtime/components/files/file-upload-icon.d.vue.ts

@@ -3,20 +3,22 @@ import type { MaybeRef } from 'vue';
 import type { ActionIconProps } from '../action-icon/action-icon.vue.js';
 export interface FileUploadIconProps<M extends boolean> extends ActionIconProps, UseFileDialogOptions {
     /**
+     * Allows selecting multiple files
      * @default false
      */
     multiple?: MaybeRef<M>;
     /**
+     * Accepted file types
      * @default '*'
      */
     accept?: MaybeRef<string>;
     /**
-     * Reset when open file dialog.
+     * Resets selected files when the dialog opens
      * @default false
      */
     reset?: MaybeRef<boolean>;
     /**
-     * Select directories instead of files.
+     * Selects directories instead of files
      * @see [HTMLInputElement webkitdirectory](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory)
      * @default false
      */

package/dist/runtime/components/files/file-upload-icon.vue

@@ -55,5 +55,5 @@ defineExpose({ files, reset });
 </script>
 
 <template>
-	<ActionIcon :icon v-bind='props' @click='open' />
+	<ActionIcon :icon v-bind='props' @click='open' />
 </template>

package/dist/runtime/components/files/file-upload-icon.vue.d.ts

@@ -3,20 +3,22 @@ import type { MaybeRef } from 'vue';
 import type { ActionIconProps } from '../action-icon/action-icon.vue.js';
 export interface FileUploadIconProps<M extends boolean> extends ActionIconProps, UseFileDialogOptions {
     /**
+     * Allows selecting multiple files
      * @default false
      */
     multiple?: MaybeRef<M>;
     /**
+     * Accepted file types
      * @default '*'
      */
     accept?: MaybeRef<string>;
     /**
-     * Reset when open file dialog.
+     * Resets selected files when the dialog opens
      * @default false
      */
     reset?: MaybeRef<boolean>;
     /**
-     * Select directories instead of files.
+     * Selects directories instead of files
      * @see [HTMLInputElement webkitdirectory](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/webkitdirectory)
      * @default false
      */

package/dist/runtime/components/input/email-input.d.vue.ts

@@ -1,15 +1,15 @@
 import type { TextInputProps } from './index.js';
-declare var __VLS_9: {}, __VLS_17: {}, __VLS_20: {}, __VLS_23: {}, __VLS_26: {};
+declare var __VLS_9: {}, __VLS_12: {}, __VLS_15: {}, __VLS_18: {}, __VLS_21: {};
 type __VLS_Slots = {} & {
     leftSection?: (props: typeof __VLS_9) => any;
 } & {
-    rightSection?: (props: typeof __VLS_17) => any;
+    rightSection?: (props: typeof __VLS_12) => any;
 } & {
-    label?: (props: typeof __VLS_20) => any;
+    label?: (props: typeof __VLS_15) => any;
 } & {
-    error?: (props: typeof __VLS_23) => any;
+    error?: (props: typeof __VLS_18) => any;
 } & {
-    description?: (props: typeof __VLS_26) => any;
+    description?: (props: typeof __VLS_21) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<TextInputProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<TextInputProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/runtime/components/input/email-input.vue

@@ -1,9 +1,10 @@
 <script setup>
 import TextInput from "./text-input.vue";
-const props = defineProps({
+const { icon = "gravity-ui:at", ...rest } = defineProps({
   multiline: { type: Boolean, required: false },
   withAria: { type: Boolean, required: false },
   classes: { type: Object, required: false },
+  icon: { type: String, required: false },
   error: { type: String, required: false },
   description: { type: String, required: false },
   label: { type: String, required: false },
@@ -21,11 +22,9 @@ const props = defineProps({
 </script>
 
 <template>
-	<TextInput type='email' v-bind='props'>
-		<template #leftSection>
-			<slot name='leftSection'>
-				<Icon name='gravity-ui:at' />
-			</slot>
+	<TextInput type='email' :icon v-bind='rest'>
+		<template v-if='!!$slots.leftSection' #leftSection>
+			<slot name='leftSection' />
 		</template>
 
 		<template v-if='!!$slots.rightSection' #rightSection>

package/dist/runtime/components/input/email-input.vue.d.ts

@@ -1,15 +1,15 @@
 import type { TextInputProps } from './index.js';
-declare var __VLS_9: {}, __VLS_17: {}, __VLS_20: {}, __VLS_23: {}, __VLS_26: {};
+declare var __VLS_9: {}, __VLS_12: {}, __VLS_15: {}, __VLS_18: {}, __VLS_21: {};
 type __VLS_Slots = {} & {
     leftSection?: (props: typeof __VLS_9) => any;
 } & {
-    rightSection?: (props: typeof __VLS_17) => any;
+    rightSection?: (props: typeof __VLS_12) => any;
 } & {
-    label?: (props: typeof __VLS_20) => any;
+    label?: (props: typeof __VLS_15) => any;
 } & {
-    error?: (props: typeof __VLS_23) => any;
+    error?: (props: typeof __VLS_18) => any;
 } & {
-    description?: (props: typeof __VLS_26) => any;
+    description?: (props: typeof __VLS_21) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<TextInputProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<TextInputProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;

package/dist/runtime/components/input/lib/input-wrapper.context.d.ts

@@ -4,15 +4,21 @@ import type { InputVariant } from '../types.js';
 export interface WrapperContext {
     /** Id used to bind input and label, auto-generated if not provided */
     id?: string | null;
+    /** Marks the field as required */
     required?: boolean;
+    /** Border radius */
     radius?: NuanceSize | string;
+    /** Component size */
     size?: NuanceSize | string;
+    /** Visual variant */
     variant?: InputVariant;
+    /** Enables multiline (textarea) mode */
     multiline?: boolean;
+    /** CSS resize behavior for multiline inputs */
     resize?: CSSProperties['resize'];
-    /** section pointer-events */
+    /** `pointer-events` value for the left section */
     leftSectionPE?: CSSStyleDeclaration['pointerEvents'];
-    /** section pointer-events */
+    /** `pointer-events` value for the right section */
     rightSectionPE?: CSSStyleDeclaration['pointerEvents'];
 }
 export declare const useProvideInputWrapper: (init: any) => any;

package/dist/runtime/components/input/number-input.d.vue.ts

@@ -9,23 +9,25 @@ export interface NumberInputProps extends InputBaseProps, Omit<InputWrapperProps
     step?: number;
     /** Determines whether the up/down controls should be hidden, `false` by default */
     hideControls?: boolean;
+    /** Icon displayed in the left section */
+    icon?: string;
 }
 type __VLS_Props = NumberInputProps;
 type __VLS_ModelProps = {
     modelValue?: number;
 };
 type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
-declare var __VLS_15: {}, __VLS_19: {}, __VLS_48: {}, __VLS_51: {}, __VLS_54: {};
+declare var __VLS_15: {}, __VLS_24: {}, __VLS_53: {}, __VLS_56: {}, __VLS_59: {};
 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_48) => any;
+    label?: (props: typeof __VLS_53) => any;
 } & {
-    error?: (props: typeof __VLS_51) => any;
+    error?: (props: typeof __VLS_56) => any;
 } & {
-    description?: (props: typeof __VLS_54) => any;
+    description?: (props: typeof __VLS_59) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: number) => any;

package/dist/runtime/components/input/number-input.vue

@@ -9,6 +9,7 @@ const {
   max = Number.MAX_SAFE_INTEGER,
   step = 1,
   hideControls,
+  icon,
   rightSectionPE = "all",
   ...rest
 } = defineProps({
@@ -16,6 +17,7 @@ const {
   max: { type: Number, required: false },
   step: { type: Number, required: false },
   hideControls: { type: Boolean, required: false },
+  icon: { type: String, required: false },
   readonly: { type: Boolean, required: false },
   disabled: { type: Boolean, required: false },
   error: { type: String, required: false },
@@ -49,8 +51,10 @@ function handleBlur() {
 <template>
 	<InputWrapper v-bind='rest' :class='$style.root' :right-section-p-e>
 		<BaseInput>
-			<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/input/number-input.vue.d.ts

@@ -9,23 +9,25 @@ export interface NumberInputProps extends InputBaseProps, Omit<InputWrapperProps
     step?: number;
     /** Determines whether the up/down controls should be hidden, `false` by default */
     hideControls?: boolean;
+    /** Icon displayed in the left section */
+    icon?: string;
 }
 type __VLS_Props = NumberInputProps;
 type __VLS_ModelProps = {
     modelValue?: number;
 };
 type __VLS_PublicProps = __VLS_Props & __VLS_ModelProps;
-declare var __VLS_15: {}, __VLS_19: {}, __VLS_48: {}, __VLS_51: {}, __VLS_54: {};
+declare var __VLS_15: {}, __VLS_24: {}, __VLS_53: {}, __VLS_56: {}, __VLS_59: {};
 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_48) => any;
+    label?: (props: typeof __VLS_53) => any;
 } & {
-    error?: (props: typeof __VLS_51) => any;
+    error?: (props: typeof __VLS_56) => any;
 } & {
-    description?: (props: typeof __VLS_54) => any;
+    description?: (props: typeof __VLS_59) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: number) => any;

package/dist/runtime/components/input/password-input.vue

@@ -6,6 +6,7 @@ const props = defineProps({
   multiline: { type: Boolean, required: false },
   withAria: { type: Boolean, required: false },
   classes: { type: Object, required: false },
+  icon: { type: String, required: false },
   error: { type: String, required: false },
   description: { type: String, required: false },
   label: { type: String, required: false },

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

@@ -8,23 +8,25 @@ export interface TextInputProps extends InputWrapperProps, InputBaseProps {
     withAria?: boolean;
     /** Styles API */
     classes?: Classes<'wrapper' | 'input'>;
+    /** Icon displayed in the left section */
+    icon?: string;
 }
 type __VLS_Props = TextInputProps;
 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, {
     readonly $el: HTMLElement | null | undefined;

package/dist/runtime/components/input/text-input.vue

@@ -3,10 +3,11 @@ import { unrefElement } from "@vueuse/core";
 import { useTemplateRef } from "vue";
 import BaseInput from "./ui/input-base.vue";
 import InputWrapper from "./ui/input-wrapper.vue";
-const { classes, ...props } = defineProps({
+const { classes, icon, ...props } = defineProps({
   multiline: { type: Boolean, required: false },
   withAria: { type: Boolean, required: false },
   classes: { type: Object, required: false },
+  icon: { type: String, required: false },
   error: { type: String, required: false },
   description: { type: String, required: false },
   label: { type: String, required: false },
@@ -31,37 +32,39 @@ defineExpose({
 </script>
 
 <template>
-	<InputWrapper v-bind='props' :class='[$attrs.class, classes?.wrapper]'>
-		<BaseInput>
-			<template v-if='!!$slots.leftSection' #leftSection>
-				<slot name='leftSection' />
-			</template>
-
-			<template #default='{ id, css }'>
-				<input
-					v-bind='{ ...$attrs, class: css }'
-					:id
-					ref='input'
-					v-model='value'
-					:required
-					:disabled
-					:readonly
-				>
-			</template>
-
-			<template v-if='!!$slots.rightSection' #rightSection>
-				<slot name='rightSection' />
-			</template>
-		</BaseInput>
-
-		<template v-if='!!$slots.label' #label>
-			<slot name='label' />
-		</template>
-		<template v-if='!!$slots.error' #error>
-			<slot name='error' />
-		</template>
-		<template v-if='!!$slots.description' #description>
-			<slot name='description' />
-		</template>
-	</InputWrapper>
+	<InputWrapper v-bind='props' :class='[$attrs.class, classes?.wrapper]'>
+		<BaseInput>
+			<template v-if='!!$slots.leftSection || icon' #leftSection>
+				<slot name='leftSection'>
+					<Icon v-if='icon' :name='icon' />
+				</slot>
+			</template>
+
+			<template #default='{ id, css }'>
+				<input
+					v-bind='{ ...$attrs, class: css }'
+					:id
+					ref='input'
+					v-model='value'
+					:required
+					:disabled
+					:readonly
+				>
+			</template>
+
+			<template v-if='!!$slots.rightSection' #rightSection>
+				<slot name='rightSection' />
+			</template>
+		</BaseInput>
+
+		<template v-if='!!$slots.label' #label>
+			<slot name='label' />
+		</template>
+		<template v-if='!!$slots.error' #error>
+			<slot name='error' />
+		</template>
+		<template v-if='!!$slots.description' #description>
+			<slot name='description' />
+		</template>
+	</InputWrapper>
 </template>

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

@@ -8,23 +8,25 @@ export interface TextInputProps extends InputWrapperProps, InputBaseProps {
     withAria?: boolean;
     /** Styles API */
     classes?: Classes<'wrapper' | 'input'>;
+    /** Icon displayed in the left section */
+    icon?: string;
 }
 type __VLS_Props = TextInputProps;
 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, {
     readonly $el: HTMLElement | null | undefined;

package/dist/runtime/components/input/ui/input-inline.d.vue.ts

@@ -3,17 +3,21 @@ import type { BoxProps } from '../../box.vue.js';
 export interface InlineInputProps extends BoxProps {
     /** Input id */
     id: string;
+    /** Label text */
     label?: string;
+    /** Helper text displayed below the label */
     description?: string;
+    /** Error message displayed below the label */
     error?: string;
-    /** Disabled input prop */
+    /** Disables the component */
     disabled?: boolean | undefined;
     /** Component size */
     size?: NuanceSize | string;
+    /** Position of the label relative to the input control */
     labelPosition?: 'left' | 'right';
-    /** Body html element */
+    /** HTML element used for the body wrapper */
     bodyElement?: keyof HTMLElementTagNameMap;
-    /** Label html element */
+    /** HTML element used for the label */
     labelElement?: keyof HTMLElementTagNameMap;
 }
 declare var __VLS_14: {}, __VLS_22: {}, __VLS_30: {}, __VLS_38: {};