@destyler/checkbox 0.0.3 → 0.0.4

package/dist/component.d.mts

@@ -1,4 +1,346 @@
-export { DestylerCheckboxIndicator, DestylerCheckboxIndicatorProps, DestylerCheckboxRoot, DestylerCheckboxRootProps } from './index.mjs';
-import 'vue';
-import '@destyler/primitive';
-import '@destyler/shared';
+import * as vue from 'vue';
+import { PropType, Ref } from 'vue';
+import * as _destyler_primitive from '@destyler/primitive';
+import { ExtractPublicPropTypes } from '@destyler/shared';
+
+type CheckedState = boolean | 'indeterminate';
+
+declare const checkboxRootProps: {
+    /**
+     * @default button
+     */
+    readonly as: {
+        readonly default: "button";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The checked state of the checkbox when it is initially rendered.
+     * Use when you do not need to control its checked state.
+     */
+    readonly defaultChecked: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The controlled checked state of the checkbox. Can be binded with `v-model`.
+     *
+     * @default undefined
+     */
+    readonly checked: {
+        readonly type: PropType<boolean | "indeterminate">;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     *
+     * @default false
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     *
+     * @default on
+     */
+    readonly value: {
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly default: "on";
+    };
+    /**
+     * Id of the element
+     */
+    readonly id: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+};
+type CheckboxRootProps = ExtractPublicPropTypes<typeof checkboxRootProps>;
+declare const checkboxRootEmits: {
+    /**
+     * Event handler called when the checked state of the checkbox changes.
+     */
+    'update:checked': (_checked: boolean) => boolean;
+};
+interface CheckboxRootContext {
+    disabled: Ref<boolean>;
+    state: Ref<CheckedState>;
+}
+declare const CheckboxRoot: vue.DefineComponent<{
+    /**
+     * @default button
+     */
+    readonly as: {
+        readonly default: "button";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The checked state of the checkbox when it is initially rendered.
+     * Use when you do not need to control its checked state.
+     */
+    readonly defaultChecked: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The controlled checked state of the checkbox. Can be binded with `v-model`.
+     *
+     * @default undefined
+     */
+    readonly checked: {
+        readonly type: PropType<boolean | "indeterminate">;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     *
+     * @default false
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     *
+     * @default on
+     */
+    readonly value: {
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly default: "on";
+    };
+    /**
+     * Id of the element
+     */
+    readonly id: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}, {
+    disabled: Ref<false> | Ref<true>;
+    checked: Ref<CheckedState>;
+    forwardRef: (ref: Element | vue.ComponentPublicInstance | null) => void;
+    isFormControl: vue.ComputedRef<boolean>;
+    ariaLabel: vue.ComputedRef<string | null | undefined>;
+}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    /**
+     * Event handler called when the checked state of the checkbox changes.
+     */
+    'update:checked': (_checked: boolean) => boolean;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /**
+     * @default button
+     */
+    readonly as: {
+        readonly default: "button";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The checked state of the checkbox when it is initially rendered.
+     * Use when you do not need to control its checked state.
+     */
+    readonly defaultChecked: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The controlled checked state of the checkbox. Can be binded with `v-model`.
+     *
+     * @default undefined
+     */
+    readonly checked: {
+        readonly type: PropType<boolean | "indeterminate">;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     *
+     * @default false
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     *
+     * @default on
+     */
+    readonly value: {
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly default: "on";
+    };
+    /**
+     * Id of the element
+     */
+    readonly id: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}>> & {
+    "onUpdate:checked"?: ((_checked: boolean) => any) | undefined;
+}, {
+    readonly checked: boolean | "indeterminate";
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly disabled: boolean;
+    readonly value: string;
+    readonly asChild: boolean;
+}, {}>;
+
+declare const checkboxIndicatorProps: {
+    /**
+     * @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 animation libraries.
+     *
+     * @default false
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+};
+type CheckboxIndicatorProps = ExtractPublicPropTypes<typeof checkboxIndicatorProps>;
+declare const CheckboxIndicator: 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 animation libraries.
+     *
+     * @default false
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}, {
+    rootContext: CheckboxRootContext;
+    forwardRef: (ref: Element | vue.ComponentPublicInstance | null) => void;
+}, 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 animation libraries.
+     *
+     * @default false
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}>>, {
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly asChild: boolean;
+    readonly forceMount: boolean;
+}, {}>;
+
+export { CheckboxIndicator, type CheckboxIndicatorProps, CheckboxRoot, type CheckboxRootProps, checkboxIndicatorProps, checkboxRootEmits, checkboxRootProps };

package/dist/component.d.ts

@@ -1,4 +1,346 @@
-export { DestylerCheckboxIndicator, DestylerCheckboxIndicatorProps, DestylerCheckboxRoot, DestylerCheckboxRootProps } from './index.js';
-import 'vue';
-import '@destyler/primitive';
-import '@destyler/shared';
+import * as vue from 'vue';
+import { PropType, Ref } from 'vue';
+import * as _destyler_primitive from '@destyler/primitive';
+import { ExtractPublicPropTypes } from '@destyler/shared';
+
+type CheckedState = boolean | 'indeterminate';
+
+declare const checkboxRootProps: {
+    /**
+     * @default button
+     */
+    readonly as: {
+        readonly default: "button";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The checked state of the checkbox when it is initially rendered.
+     * Use when you do not need to control its checked state.
+     */
+    readonly defaultChecked: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The controlled checked state of the checkbox. Can be binded with `v-model`.
+     *
+     * @default undefined
+     */
+    readonly checked: {
+        readonly type: PropType<boolean | "indeterminate">;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     *
+     * @default false
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     *
+     * @default on
+     */
+    readonly value: {
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly default: "on";
+    };
+    /**
+     * Id of the element
+     */
+    readonly id: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+};
+type CheckboxRootProps = ExtractPublicPropTypes<typeof checkboxRootProps>;
+declare const checkboxRootEmits: {
+    /**
+     * Event handler called when the checked state of the checkbox changes.
+     */
+    'update:checked': (_checked: boolean) => boolean;
+};
+interface CheckboxRootContext {
+    disabled: Ref<boolean>;
+    state: Ref<CheckedState>;
+}
+declare const CheckboxRoot: vue.DefineComponent<{
+    /**
+     * @default button
+     */
+    readonly as: {
+        readonly default: "button";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The checked state of the checkbox when it is initially rendered.
+     * Use when you do not need to control its checked state.
+     */
+    readonly defaultChecked: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The controlled checked state of the checkbox. Can be binded with `v-model`.
+     *
+     * @default undefined
+     */
+    readonly checked: {
+        readonly type: PropType<boolean | "indeterminate">;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     *
+     * @default false
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     *
+     * @default on
+     */
+    readonly value: {
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly default: "on";
+    };
+    /**
+     * Id of the element
+     */
+    readonly id: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}, {
+    disabled: Ref<false> | Ref<true>;
+    checked: Ref<CheckedState>;
+    forwardRef: (ref: Element | vue.ComponentPublicInstance | null) => void;
+    isFormControl: vue.ComputedRef<boolean>;
+    ariaLabel: vue.ComputedRef<string | null | undefined>;
+}, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    /**
+     * Event handler called when the checked state of the checkbox changes.
+     */
+    'update:checked': (_checked: boolean) => boolean;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /**
+     * @default button
+     */
+    readonly as: {
+        readonly default: "button";
+        readonly type: PropType<_destyler_primitive.AsTag | vue.Component>;
+        readonly required: false;
+    };
+    /**
+     * The checked state of the checkbox when it is initially rendered.
+     * Use when you do not need to control its checked state.
+     */
+    readonly defaultChecked: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The controlled checked state of the checkbox. Can be binded with `v-model`.
+     *
+     * @default undefined
+     */
+    readonly checked: {
+        readonly type: PropType<boolean | "indeterminate">;
+        readonly required: false;
+        readonly default: undefined;
+    };
+    /**
+     * When `true`, prevents the user from interacting with the checkbox.
+     *
+     * @default false
+     */
+    readonly disabled: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    /**
+     * When `true`, indicates that the user must check the checkbox before the owning form can be submitted.
+     */
+    readonly required: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+    };
+    /**
+     * The name of the checkbox. Submitted with its owning form as part of a name/value pair.
+     */
+    readonly name: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    /**
+     * The value given as data when submitted with a `name`.
+     *
+     * @default on
+     */
+    readonly value: {
+        readonly type: PropType<string>;
+        readonly required: false;
+        readonly default: "on";
+    };
+    /**
+     * Id of the element
+     */
+    readonly id: {
+        readonly type: PropType<string>;
+        readonly required: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}>> & {
+    "onUpdate:checked"?: ((_checked: boolean) => any) | undefined;
+}, {
+    readonly checked: boolean | "indeterminate";
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly disabled: boolean;
+    readonly value: string;
+    readonly asChild: boolean;
+}, {}>;
+
+declare const checkboxIndicatorProps: {
+    /**
+     * @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 animation libraries.
+     *
+     * @default false
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+};
+type CheckboxIndicatorProps = ExtractPublicPropTypes<typeof checkboxIndicatorProps>;
+declare const CheckboxIndicator: 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 animation libraries.
+     *
+     * @default false
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}, {
+    rootContext: CheckboxRootContext;
+    forwardRef: (ref: Element | vue.ComponentPublicInstance | null) => void;
+}, 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 animation libraries.
+     *
+     * @default false
+     */
+    readonly forceMount: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+    readonly asChild: {
+        readonly type: PropType<boolean>;
+        readonly required: false;
+        readonly default: false;
+    };
+}>>, {
+    readonly as: _destyler_primitive.AsTag | vue.Component;
+    readonly asChild: boolean;
+    readonly forceMount: boolean;
+}, {}>;
+
+export { CheckboxIndicator, type CheckboxIndicatorProps, CheckboxRoot, type CheckboxRootProps, checkboxIndicatorProps, checkboxRootEmits, checkboxRootProps };