@formkit/pro 0.117.7 → 0.118.0

package/index.d.ts

@@ -877,6 +877,38 @@ export declare interface FormKitTaglistSlots<Props extends FormKitInputs<Props>>
     }>;
 }
 
+/**
+ * Togglebuttons slots.
+ *
+ * @public
+ */
+export declare interface FormKitTogglebuttonsSlots<Props extends FormKitInputs<Props>> {
+    wrapper: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    options: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    option: FormKitSlotData<Props, TogglebuttonsSlotData<Props> & {
+        option: FormKitOptionsItem;
+        index: number;
+    }>;
+    singleToggle: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    multiToggle: FormKitSlotData<Props, TogglebuttonsSlotData<Props> & {
+        option: FormKitOptionsItem;
+        index: number;
+    }>;
+    inputInner: FormKitSlotData<Props, TogglebuttonsSlotData<Props> & {
+        option: FormKitOptionsItem;
+        index: number;
+    }>;
+    on: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    off: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    prefix: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    suffix: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    help: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    messages: FormKitSlotData<Props, TogglebuttonsSlotData<Props>>;
+    message: FormKitSlotData<Props, TogglebuttonsSlotData<Props> & {
+        message: FormKitMessage;
+    }>;
+}
+
 /**
  * Toggle slots.
  *
@@ -929,7 +961,8 @@ declare namespace inputs {
         mask,
         transferlist,
         slider,
-        colorpicker
+        colorpicker,
+        togglebuttons
     }
 }
 export { inputs }
@@ -1166,6 +1199,33 @@ declare type TimeFormatStyle = 'long' | 'medium' | 'short';
  */
 export declare const toggle: FormKitProInput;
 
+/**
+ * Input definition for a toggle group input.
+ * @public
+ */
+export declare const togglebuttons: FormKitProInput;
+
+/**
+ * Slot data for togglebuttons
+ */
+export declare interface TogglebuttonsSlotData<Props extends FormKitInputs<Props>> {
+    onValue?: any;
+    offValue?: any;
+    offLabel?: string;
+    onLabel?: string;
+    options: FormKitOptionsItem[];
+    option?: FormKitOptionsItem;
+    multiple?: Bool;
+    enforced?: Bool;
+    vertical?: Bool;
+    fns: FormKitFrameworkContext['fns'] & {
+        isChecked: (option: FormKitOptionsItem) => boolean;
+    };
+    handlers: FormKitFrameworkContext['handlers'] & {
+        toggleValue: (option: FormKitOptionsItem) => (e: MouseEvent) => void;
+    };
+}
+
 /**
  * Slot data for toggles
  */
@@ -1520,6 +1580,23 @@ declare module '@formkit/inputs' {
       trackColorOn?: string
     }
 
+    togglebuttons: {
+      type: 'togglebuttons'
+      onValue?: any
+      offValue?: any
+      value?:
+        | (Props['onValue'] extends AllReals ? Props['onValue'] : true)
+        | (Props['offValue'] extends AllReals ? Props['offValue'] : false)
+      options?: FormKitProOptionsProp
+      label?: string
+      enforced?: Bool
+      multiple?: Bool
+      vertical?: Bool
+      disabled?: Bool
+      prefixIcon?: string
+      suffixIcon?: string
+    }
+
     transferlist: {
       type: 'transferlist'
       value?: OptionsProValue<Props['options']>[]
@@ -1552,6 +1629,7 @@ declare module '@formkit/inputs' {
         : {})
     taglist: FormKitTaglistSlots<Props>
     toggle: FormKitToggleSlots<Props>
+    togglebuttons: FormKitTogglebuttonsSlots<Props>
     transferlist: TransferlistSlots<Props>
   }
 }