@speckle/ui-components 2.17.4 → 2.17.6

package/dist/components/form/Radio.vue.d.ts

@@ -0,0 +1,211 @@
+import type { RuleExpression } from 'vee-validate';
+import type { PropType, ConcreteComponent } from 'vue';
+import type { Optional } from '@speckle/shared';
+/**
+ * Troubleshooting:
+ * - If clicking on the radio doesn't do anything, check if any of its ancestor elements
+ * have a @click.prevent on them anywhere.
+ * - If you're not using the radio in a group, it's suggested that you set :value="true",
+ * so that a v-model attached to the radio will be either 'true' or 'undefined' depending on the
+ * checked state
+ */
+type ValueType = Optional<string | true> | string[];
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Input name/id. In a radio group, all radios must have the same name and different values.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether the input is disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set label text
+     */
+    label: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Help text
+     */
+    description: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Whether to inline the help description
+     */
+    inlineDescription: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Optional Icon
+     */
+    icon: {
+        type: PropType<ConcreteComponent>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation rules
+     */
+    rules: {
+        type: PropType<RuleExpression<ValueType>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to show the red "required" asterisk
+     */
+    showRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Radio group's value
+     */
+    modelValue: {
+        type: PropType<false | ValueType>;
+        default: undefined;
+    };
+    /**
+     * Radio's own value. If it is checked, modelValue will include this value (amongst any other checked values from the same group).
+     * If not set will default to 'name' value.
+     */
+    value: {
+        type: PropType<Optional<string | true>>;
+        default: boolean;
+    };
+    /**
+     * HTML ID to use, must be globally unique. If not specified, a random ID will be generated. One is necessary to properly associate the label and radio.
+     */
+    id: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    hideLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (val: ValueType) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Input name/id. In a radio group, all radios must have the same name and different values.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether the input is disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set label text
+     */
+    label: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Help text
+     */
+    description: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Whether to inline the help description
+     */
+    inlineDescription: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Optional Icon
+     */
+    icon: {
+        type: PropType<ConcreteComponent>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation rules
+     */
+    rules: {
+        type: PropType<RuleExpression<ValueType>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to show the red "required" asterisk
+     */
+    showRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Radio group's value
+     */
+    modelValue: {
+        type: PropType<false | ValueType>;
+        default: undefined;
+    };
+    /**
+     * Radio's own value. If it is checked, modelValue will include this value (amongst any other checked values from the same group).
+     * If not set will default to 'name' value.
+     */
+    value: {
+        type: PropType<Optional<string | true>>;
+        default: boolean;
+    };
+    /**
+     * HTML ID to use, must be globally unique. If not specified, a random ID will be generated. One is necessary to properly associate the label and radio.
+     */
+    id: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    hideLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((val: ValueType) => any) | undefined;
+}, {
+    disabled: boolean;
+    id: Optional<string>;
+    label: Optional<string>;
+    value: Optional<string | true>;
+    description: Optional<string>;
+    icon: ConcreteComponent;
+    modelValue: false | ValueType;
+    inlineDescription: boolean;
+    rules: RuleExpression<ValueType>;
+    validateOnMount: boolean;
+    showRequired: boolean;
+    hideLabel: boolean;
+}, {}>;
+export default _default;