@destyler/radio 0.0.2 → 0.0.4

package/dist/shared/radio.54693474.d.ts

@@ -0,0 +1,519 @@
+import * as vue from 'vue';
+import { PropType, Ref, ComputedRef } from 'vue';
+import * as _destyler_primitive from '@destyler/primitive';
+import { DataOrientation, Direction, ExtractPublicPropTypes } from '@destyler/shared';
+
+declare const radioGroupRootProps: {
+    /**
+     * The controlled value of the radio item to check. Can be binded as `v-model`.
+     */
+    readonly modelValue: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value of the radio item that should be checked when initially rendered.
+     *
+     * Use when you do not need to control the state of the radio items.
+     */
+    readonly defaultValue: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, prevents the user from interacting with radio items.
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * The name of the group. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, indicates that the user must check a radio item before the owning form can be submitted.
+     *
+     * @default false
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * The orientation of the component.
+     *
+     * @default undefined
+     */
+    readonly orientation: {
+        readonly type: PropType<DataOrientation>;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * The reading direction of the radio when applicable.
+     */
+    readonly dir: {
+        readonly type: PropType<Direction>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, keyboard navigation will loop from last item to first, and vice versa.
+     *
+     * @default true
+     */
+    readonly loop: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: true;
+    };
+    readonly as: {
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+        readonly default: "div";
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+};
+type RadioGroupRootProps = ExtractPublicPropTypes<typeof radioGroupRootProps>;
+declare const radioGroupRootEmits: {
+    /**
+     * Event handler called when the radio group value changes
+     */
+    'update:modelValue': (_value: string) => boolean;
+};
+interface RadioGroupRootContext {
+    modelValue?: Readonly<Ref<string | undefined>>;
+    changeModelValue: (value?: string) => void;
+    disabled: Ref<boolean>;
+    loop: Ref<boolean>;
+    orientation: Ref<DataOrientation | undefined>;
+    name?: string;
+    required: Ref<boolean>;
+}
+declare const RadioGroupRoot: vue.DefineComponent<{
+    /**
+     * The controlled value of the radio item to check. Can be binded as `v-model`.
+     */
+    readonly modelValue: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value of the radio item that should be checked when initially rendered.
+     *
+     * Use when you do not need to control the state of the radio items.
+     */
+    readonly defaultValue: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, prevents the user from interacting with radio items.
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * The name of the group. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, indicates that the user must check a radio item before the owning form can be submitted.
+     *
+     * @default false
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * The orientation of the component.
+     *
+     * @default undefined
+     */
+    readonly orientation: {
+        readonly type: PropType<DataOrientation>;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * The reading direction of the radio when applicable.
+     */
+    readonly dir: {
+        readonly type: PropType<Direction>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, keyboard navigation will loop from last item to first, and vice versa.
+     *
+     * @default true
+     */
+    readonly loop: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: true;
+    };
+    readonly as: {
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+        readonly default: "div";
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}, {
+    orientation: Ref<DataOrientation | undefined>;
+    dir: vue.ComputedRef<Direction>;
+    loop: Ref<boolean>;
+    disabled: Ref<boolean>;
+    required: Ref<boolean>;
+    name: Ref<string | undefined>;
+}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    /**
+     * Event handler called when the radio group value changes
+     */
+    'update:modelValue': (_value: string) => boolean;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /**
+     * The controlled value of the radio item to check. Can be binded as `v-model`.
+     */
+    readonly modelValue: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value of the radio item that should be checked when initially rendered.
+     *
+     * Use when you do not need to control the state of the radio items.
+     */
+    readonly defaultValue: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, prevents the user from interacting with radio items.
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * The name of the group. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, indicates that the user must check a radio item before the owning form can be submitted.
+     *
+     * @default false
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * The orientation of the component.
+     *
+     * @default undefined
+     */
+    readonly orientation: {
+        readonly type: PropType<DataOrientation>;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * The reading direction of the radio when applicable.
+     */
+    readonly dir: {
+        readonly type: PropType<Direction>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, keyboard navigation will loop from last item to first, and vice versa.
+     *
+     * @default true
+     */
+    readonly loop: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: true;
+    };
+    readonly as: {
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+        readonly default: "div";
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((_value: string) => any) | undefined;
+}, {
+    readonly disabled: boolean;
+    readonly required: boolean;
+    readonly orientation: DataOrientation;
+    readonly loop: boolean;
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly asChild: boolean;
+}, {}>;
+
+declare const radioGroupItemProps: {
+    readonly asChild: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly as: {
+        readonly default: "button";
+        readonly type: vue.PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The name of the input fields in the radio (Useful for form submission).
+     */
+    readonly id: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     */
+    readonly value: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the radio item.
+     */
+    readonly disabled: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the radio item before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the input fields in the radio (Useful for form submission).
+     */
+    readonly name: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+};
+type RadioGroupItemProps = ExtractPublicPropTypes<typeof radioGroupItemProps>;
+interface RadioGroupItemContext {
+    disabled: ComputedRef<boolean>;
+    checked: ComputedRef<boolean>;
+}
+declare const RadioGroupItem: vue.DefineComponent<{
+    readonly asChild: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly as: {
+        readonly default: "button";
+        readonly type: vue.PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The name of the input fields in the radio (Useful for form submission).
+     */
+    readonly id: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     */
+    readonly value: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the radio item.
+     */
+    readonly disabled: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the radio item before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the input fields in the radio (Useful for form submission).
+     */
+    readonly name: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+}, {
+    checked: ComputedRef<boolean>;
+    disabled: ComputedRef<boolean>;
+    required: ComputedRef<boolean | undefined>;
+    forwardRef: (ref: Element | vue.ComponentPublicInstance | null) => void;
+    rootContext: RadioGroupRootContext;
+    handleFocus: () => void;
+}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    readonly asChild: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly as: {
+        readonly default: "button";
+        readonly type: vue.PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The name of the input fields in the radio (Useful for form submission).
+     */
+    readonly id: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     */
+    readonly value: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the radio item.
+     */
+    readonly disabled: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the radio item before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: vue.PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the input fields in the radio (Useful for form submission).
+     */
+    readonly name: {
+        readonly type: vue.PropType<string>;
+        readonly required: false;
+    };
+}>>, {
+    readonly disabled: boolean;
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly asChild: boolean;
+}, {}>;
+
+declare const radioGroupIndicatorProps: {
+    /**
+     * @default span
+     */
+    readonly as: {
+        readonly default: "span";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with Vue animation libraries.
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+};
+type RadioGroupIndicatorProps = ExtractPublicPropTypes<typeof radioGroupIndicatorProps>;
+declare const RadioGroupIndicator: vue.DefineComponent<{
+    /**
+     * @default span
+     */
+    readonly as: {
+        readonly default: "span";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with Vue animation libraries.
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}, {
+    forwardRef: (ref: Element | vue.ComponentPublicInstance | null) => void;
+    itemContext: RadioGroupItemContext;
+}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /**
+     * @default span
+     */
+    readonly as: {
+        readonly default: "span";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * Used to force mounting when more control is needed. Useful when
+     * controlling animation with Vue animation libraries.
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}>>, {
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly asChild: boolean;
+}, {}>;
+
+export { RadioGroupRoot as R, radioGroupRootEmits as a, type RadioGroupRootProps as b, RadioGroupItem as c, radioGroupItemProps as d, type RadioGroupItemProps as e, RadioGroupIndicator as f, radioGroupIndicatorProps as g, type RadioGroupIndicatorProps as h, radioGroupRootProps as r };

package/package.json

@@ -1,24 +1,22 @@
 {
   "name": "@destyler/radio",
-  "version": "0.0.2",
-  "description": "unstyled radio component for vue",
+  "type": "module",
+  "version": "0.0.4",
+  "description": "a set of checkable buttons—known as radio buttons—where no more than one of the buttons can be checked at a time.",
   "author": "Elone Hoo <elonehoo@gmail.com>",
   "license": "MIT",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     },
     "./resolver": {
-      "types": "./dist/resolver.d.ts",
-      "import": "./dist/resolver.mjs",
-      "require": "./dist/resolver.cjs"
+      "types": "./dist/resolver.d.mts",
+      "default": "./dist/resolver.mjs"
     },
     "./component": {
-      "types": "./dist/component.d.ts",
-      "import": "./dist/component.mjs",
-      "require": "./dist/component.cjs"
+      "types": "./dist/component.d.mts",
+      "default": "./dist/component.mjs"
     },
     "./*": "./*"
   },
@@ -30,18 +28,20 @@
     "dist"
   ],
   "peerDependencies": {
-    "vue": ">=3.3.4"
+    "vue": ">=3.4.21"
   },
   "dependencies": {
-    "@vueuse/core": "^10.7.2",
-    "@destyler/composition": "0.0.2",
-    "@destyler/roving-focus": "0.0.2",
-    "@destyler/primitive": "0.0.2",
-    "@destyler/shared": "0.0.2",
-    "@destyler/directives": "0.0.2"
+    "@vueuse/core": "^10.9.0",
+    "@destyler/composition": "0.0.4",
+    "@destyler/directives": "0.0.4",
+    "@destyler/primitive": "0.0.4",
+    "@destyler/shared": "0.0.4",
+    "@destyler/roving-focus": "0.0.4",
+    "@destyler/presence": "0.0.4"
   },
   "scripts": {
     "clear": "rimraf ./dist",
-    "build": "pnpm run clear && unbuild"
+    "build": "pnpm run clear && unbuild",
+    "stub": "unbuild --stub"
   }
 }