@nexdom/uimed-vue 2.0.0-beta.2 → 2.0.0-beta.4

package/AGENTS.md

@@ -72,6 +72,18 @@ import { Root } from "@nexdom/uimed-vue/components";
 
 Never write CSS, classes or any kind of styling. Always use component props.
 
+The library doesn't export prop types. Derive them with `ComponentProps` from `vue-component-type-helpers`:
+
+```ts
+import type { ComponentProps } from "vue-component-type-helpers";
+import { UMain, USection } from "@nexdom/uimed-vue/components";
+
+type MainProps = ComponentProps<typeof UMain>;
+type AppBar = NonNullable<MainProps["appBar"]>;
+type NavigationMenu = NonNullable<MainProps["navigationMenu"]>;
+type SectionAction = NonNullable<ComponentProps<typeof USection>["actions"]>[number];
+```
+
 Available entry points: `@nexdom/uimed-vue` (root), `@nexdom/uimed-vue/components`, `@nexdom/uimed-vue/composables`, `@nexdom/uimed-vue/plugins`, `@nexdom/uimed-vue/unit-test` (test helpers, e.g. `vueTestUtilsPluginUimed()` for mounting components with Vuetify in Vitest).
 
 Full component/composable reference lives in the [docs](https://nexdom-healthtech.github.io/uimed-vue/).

package/README.md

@@ -50,7 +50,7 @@ plugins: [vue(), vitePluginUimed()];
 // ...
 ```
 
-Use Uimed inside the Vue app:
+Use UIMed inside the Vue app:
 
 ```ts
 // main.js or main.ts

package/dist/components.d.ts

@@ -171,8 +171,8 @@ type MainProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/main | Main Guide}
  */
-declare const _default$4: typeof __VLS_export$9;
-declare const __VLS_export$9: __VLS_WithSlots$7<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<MainProps & {
+declare const _default$5: typeof __VLS_export$10;
+declare const __VLS_export$10: __VLS_WithSlots$7<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<MainProps & {
   notificationsOpen?: boolean;
 }, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {
   "update:notificationsOpen": (value: boolean) => any;
@@ -248,8 +248,8 @@ type ButtonProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/button | Button Guide}
  */
-declare const _default: typeof __VLS_export$8;
-declare const __VLS_export$8: __VLS_WithSlots$6<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<ButtonProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {} & {
+declare const _default: typeof __VLS_export$9;
+declare const __VLS_export$9: __VLS_WithSlots$6<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<ButtonProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {} & {
   click: (event: MouseEvent) => any;
 }, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<ButtonProps> & Readonly<{
   onClick?: ((event: MouseEvent) => any) | undefined;
@@ -339,8 +339,8 @@ type TextFieldProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/text-field | TextField Guide}
  */
-declare const _default$9: typeof __VLS_export$7;
-declare const __VLS_export$7: import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<TextFieldProps & {
+declare const _default$10: typeof __VLS_export$8;
+declare const __VLS_export$8: import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<TextFieldProps & {
   modelValue?: string;
 }, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {
   "update:modelValue": (value: string) => any;
@@ -354,6 +354,72 @@ declare const __VLS_export$7: import("vue", { with: { "resolution-mode": "import
   clearable: boolean;
 }, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, false, {}, any>;
 //#endregion
+//#region src/components/inputs/checkbox/types.d.ts
+/**
+ * Props exposed by the {@link Checkbox} component.
+ */
+type CheckboxProps<T = boolean> = {
+  /**
+   * Field label.
+   */
+  label?: string;
+  /**
+   * Removes the ability to click or target the checkbox.
+   * @default false
+   */
+  disabled?: boolean;
+  /**
+   * Prevent value changes.
+   * @default false
+   */
+  readonly?: boolean;
+  /**
+   * Value applied to the model when the checkbox is checked.
+   * @default true
+   */
+  trueValue?: T;
+  /**
+   * Value applied to the model when the checkbox is unchecked.
+   * @default false
+   */
+  falseValue?: T;
+  /**
+   * Component id to use on automated tests.
+   */
+  dataTestid?: string;
+};
+//#endregion
+//#region src/components/inputs/checkbox/checkbox.vue.d.ts
+/**
+ * Checkbox component to be used throughout the application.
+ *
+ * @example
+ * ```vue
+ * <template>
+ *  <u-checkbox label="Aceito os termos" />
+ * </template>
+ * ```
+ *
+ * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/checkbox | Checkbox Guide}
+ */
+declare const _default$1: typeof __VLS_export$7;
+declare const __VLS_export$7: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+  props: import("vue").PublicProps & __VLS_PrettifyLocal<(CheckboxProps<boolean | T> & {
+    modelValue?: T;
+  }) & {
+    "onUpdate:modelValue"?: ((value: T) => any) | undefined;
+  }> & (typeof globalThis extends {
+    __VLS_PROPS_FALLBACK: infer P;
+  } ? P : {});
+  expose: (exposed: {}) => void;
+  attrs: any;
+  slots: {};
+  emit: (event: "update:modelValue", value: T) => void;
+}>) => import("vue").VNode & {
+  __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
+};
+type __VLS_PrettifyLocal<T> = (T extends any ? { [K in keyof T]: T[K]; } : { [K in keyof T as K]: T[K]; }) & {};
+//#endregion
 //#region src/components/grid/container/types.d.ts
 /**
  * Props exposed by the {@link Container} component.
@@ -380,7 +446,7 @@ type ContainerProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/layout | Container Guide}
  */
-declare const _default$2: typeof __VLS_export$6;
+declare const _default$3: typeof __VLS_export$6;
 declare const __VLS_export$6: __VLS_WithSlots$5<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<ContainerProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<ContainerProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, false, {}, any>, {
   default?: (props: {}) => any;
 }>;
@@ -418,7 +484,7 @@ type RowProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/layout | Row Guide}
  */
-declare const _default$5: typeof __VLS_export$5;
+declare const _default$6: typeof __VLS_export$5;
 declare const __VLS_export$5: __VLS_WithSlots$4<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<RowProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<RowProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, false, {}, any>, {
   default?: (props: {}) => any;
 }>;
@@ -467,7 +533,7 @@ type Cols = "auto" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10"
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/layout | Column Guide}
  */
-declare const _default$1: typeof __VLS_export$4;
+declare const _default$2: typeof __VLS_export$4;
 declare const __VLS_export$4: __VLS_WithSlots$3<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<ColumnProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<ColumnProps> & Readonly<{}>, {
   cols: "12" | "auto" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11";
 }, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, false, {}, any>, {
@@ -510,7 +576,7 @@ type FormProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/form | Form Guide}
  */
-declare const _default$3: typeof __VLS_export$3;
+declare const _default$4: typeof __VLS_export$3;
 declare const __VLS_export$3: __VLS_WithSlots$2<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<FormProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {} & {
   submit: (event: SubmitEvent) => any;
 }, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<FormProps> & Readonly<{
@@ -540,7 +606,7 @@ type __VLS_WithSlots$2<T, S> = T & {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/section | Section Guide}
  */
-declare const _default$7: typeof __VLS_export$2;
+declare const _default$8: typeof __VLS_export$2;
 declare const __VLS_export$2: __VLS_WithSlots$1<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<{}, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, true, {}, any>, {
   default?: (props: {}) => any;
 }>;
@@ -626,7 +692,7 @@ interface SectionAction extends ButtonProps {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/section | Section Guide}
  */
-declare const _default$6: typeof __VLS_export$1;
+declare const _default$7: typeof __VLS_export$1;
 declare const __VLS_export$1: __VLS_WithSlots<import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<SectionProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<SectionProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, false, {}, any>, {
   default?: (props: {}) => any;
 }>;
@@ -701,7 +767,7 @@ type TableProps = {
  *
  * @see {@link https://nexdom-healthtech.github.io/uimed-vue/guide/components/table | Table Guide}
  */
-declare const _default$8: typeof __VLS_export;
+declare const _default$9: typeof __VLS_export;
 declare const __VLS_export: import("vue", { with: { "resolution-mode": "import" } }).DefineComponent<TableProps, {}, {}, {}, {}, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, import("vue", { with: { "resolution-mode": "import" } }).ComponentOptionsMixin, {}, string, import("vue", { with: { "resolution-mode": "import" } }).PublicProps, Readonly<TableProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue", { with: { "resolution-mode": "import" } }).ComponentProvideOptions, false, {}, any>;
 //#endregion
-export { type AppBarProps as AppBarConfig, type AppBarUserProps as AppBarUserConfig, type NavigationMenuProps as NavigationMenuConfig, type SectionAction, type TableProps, _default as UButton, _default$1 as UColumn, _default$2 as UContainer, _default$3 as UForm, _default$4 as UMain, _default$5 as URow, _default$6 as USection, _default$7 as USectionContent, _default$8 as UTable, _default$9 as UTextField };
+export { _default as UButton, _default$1 as UCheckbox, _default$2 as UColumn, _default$3 as UContainer, _default$4 as UForm, _default$5 as UMain, _default$6 as URow, _default$7 as USection, _default$8 as USectionContent, _default$9 as UTable, _default$10 as UTextField };

package/dist/components.js

@@ -1,6 +1,6 @@
 import { r as useVuetifyColor, t as messages } from "./use-toast-CACuYhK_.js";
 import { Fragment, computed, createBlock, createCommentVNode, createElementBlock, createElementVNode, createSlots, createTextVNode, createVNode, defineComponent, isRef, mergeModels, mergeProps, openBlock, ref, renderList, renderSlot, toDisplayString, toValue, unref, useModel, withCtx, withModifiers } from "vue";
-import { VApp, VAppBar, VAppBarNavIcon, VAppBarTitle, VAvatar, VBadge, VBtn, VCard, VCardActions, VCardText, VCol, VContainer, VDivider, VForm, VIcon, VIconBtn, VImg, VList, VListGroup, VListItem, VListItemAction, VListSubheader, VMain, VMenu, VNavigationDrawer, VRow, VSkeletonLoader, VSnackbarQueue, VTable, VTextField } from "vuetify/components";
+import { VApp, VAppBar, VAppBarNavIcon, VAppBarTitle, VAvatar, VBadge, VBtn, VCard, VCardActions, VCardText, VCheckboxBtn, VCol, VContainer, VDivider, VForm, VIcon, VIconBtn, VImg, VList, VListGroup, VListItem, VListItemAction, VListSubheader, VMain, VMenu, VNavigationDrawer, VRow, VSkeletonLoader, VSnackbarQueue, VTable, VTextField } from "vuetify/components";
 import { formatDateTime, isEmail, isEmpty, isPhone, isUrl, toPeriodInterval } from "@nexdom/shared/utils";
 //#region src/composables/navigation/use-route-props.ts
 function useRouteProps(route) {
@@ -700,6 +700,75 @@ var button_default = /* @__PURE__ */ defineComponent({
 	}
 });
 //#endregion
+//#region src/components/inputs/checkbox/checkbox.vue
+var checkbox_default = /* @__PURE__ */ defineComponent({
+	inheritAttrs: false,
+	__name: "checkbox",
+	props: /*@__PURE__*/ mergeModels({
+		label: {
+			type: String,
+			required: false
+		},
+		disabled: {
+			type: Boolean,
+			required: false
+		},
+		readonly: {
+			type: Boolean,
+			required: false
+		},
+		trueValue: {
+			type: Boolean,
+			required: false,
+			skipCheck: true,
+			default: true
+		},
+		falseValue: {
+			type: Boolean,
+			required: false,
+			skipCheck: true,
+			default: false
+		},
+		dataTestid: {
+			type: String,
+			required: false
+		}
+	}, {
+		"modelValue": {
+			type: null,
+			default: (props) => props.falseValue
+		},
+		"modelModifiers": {}
+	}),
+	emits: ["update:modelValue"],
+	setup(__props) {
+		const props = __props;
+		const modelValue = useModel(__props, "modelValue");
+		return (_ctx, _cache) => {
+			return openBlock(), createBlock(unref(VCheckboxBtn), {
+				modelValue: modelValue.value,
+				"onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => modelValue.value = $event),
+				"true-value": props.trueValue,
+				"false-value": props.falseValue,
+				"data-testid": props.dataTestid,
+				disabled: props.disabled,
+				readonly: props.readonly,
+				label: props.label,
+				class: "flex-0-1",
+				"hide-details": ""
+			}, null, 8, [
+				"modelValue",
+				"true-value",
+				"false-value",
+				"data-testid",
+				"disabled",
+				"readonly",
+				"label"
+			]);
+		};
+	}
+});
+//#endregion
 //#region src/components/grid/row/row.vue
 var row_default = /* @__PURE__ */ defineComponent({
 	inheritAttrs: false,
@@ -987,4 +1056,4 @@ var table_default = /* @__PURE__ */ defineComponent({
 	}
 });
 //#endregion
-export { button_default as UButton, column_default as UColumn, container_default as UContainer, form_default as UForm, main_default as UMain, row_default as URow, section_default as USection, section_content_default as USectionContent, table_default as UTable, text_field_default as UTextField };
+export { button_default as UButton, checkbox_default as UCheckbox, column_default as UColumn, container_default as UContainer, form_default as UForm, main_default as UMain, row_default as URow, section_default as USection, section_content_default as USectionContent, table_default as UTable, text_field_default as UTextField };

package/dist/plugins.d.ts

@@ -2,11 +2,11 @@ import vitePluginVuetify from "vite-plugin-vuetify";
 import { UserConfig } from "vite-plus";
 //#region src/plugins.d.ts
 /**
- * Vite plugin for Uimed.
+ * Vite plugin for UIMed.
  */
 declare function vitePluginUimed(): ReturnType<typeof vitePluginVuetify>;
 /**
- * Vitest Server plugin for Uimed.
+ * Vitest Server plugin for UIMed.
  */
 declare function vitestServerPluginUimed(): NonNullable<NonNullable<UserConfig["test"]>["server"]>;
 //#endregion

package/dist/plugins.js

@@ -1,13 +1,13 @@
 import vitePluginVuetify from "vite-plugin-vuetify";
 //#region src/plugins.ts
 /**
-* Vite plugin for Uimed.
+* Vite plugin for UIMed.
 */
 function vitePluginUimed() {
 	return vitePluginVuetify({ autoImport: false });
 }
 /**
-* Vitest Server plugin for Uimed.
+* Vitest Server plugin for UIMed.
 */
 function vitestServerPluginUimed() {
 	return { deps: { inline: ["vuetify"] } };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexdom/uimed-vue",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.4",
   "description": "A ui framework for NEXDOM applications.",
   "keywords": [
     "lib",
@@ -81,6 +81,7 @@
     "vitepress": "2.0.0-alpha.19",
     "vitepress-plugin-group-icons": "^1.7.6",
     "vue": "^3.5.40",
+    "vue-component-type-helpers": "^3.3.11",
     "vue-router": "^5.3.1",
     "vue-tsc": "^3.3.9",
     "vuetify": "^4.2.0"
@@ -93,6 +94,7 @@
     "vite-plugin-vuetify": "^2.1.3",
     "vite-plus": "^0.2.7",
     "vue": "^3.5.40",
+    "vue-component-type-helpers": "^3.3.11",
     "vue-router": "^5.3.1",
     "vuetify": "^4.2.0"
   },