@formkit/pro 0.129.0 → 0.129.2-next.773ca2

package/index.d.ts

@@ -211,6 +211,8 @@ export declare const currency: FormKitProInput;
 
 /**
  * Slot data for currency
+ *
+ * @public
  */
 export declare interface CurrencySlotData<Props extends FormKitInputs<Props>> {
     type: 'currency';
@@ -306,6 +308,7 @@ export declare interface DropdownSlotData {
     debounce?: number | string;
     multiple?: Bool;
     selectionAppearance?: 'truncate' | 'tags';
+    optionsAppearance?: 'checkbox';
     openOnClick?: Bool;
     filter?: (option: FormKitOptionsItem, search: string) => boolean;
     optionLoader?: OptionLoader;
@@ -362,6 +365,11 @@ declare type ExtendableSchema<IsRoot> = IsRoot extends true ? FormKitExtendableS
 
 export { FormatStyleObj }
 
+/**
+ * Autocomplete slots.
+ *
+ * @public
+ */
 export declare interface FormKitAutocompleteSlots<Props extends FormKitInputs<Props>> {
     outer: FormKitSlotData<Props, AutocompleteSlotData>;
     wrapper: FormKitSlotData<Props, AutocompleteSlotData>;
@@ -461,6 +469,11 @@ declare interface FormKitColorpickerSlotData {
     };
 }
 
+/**
+ * Colorpicker slots.
+ *
+ * @public
+ */
 export declare interface FormKitColorpickerSlots<Props extends FormKitInputs<Props>> {
     swatchPreview: FormKitSlotData<Props, FormKitColorpickerSlotData>;
     valueString: FormKitSlotData<Props, FormKitColorpickerSlotData>;
@@ -599,6 +612,11 @@ export declare interface FormKitDatePickerSlots<Props extends FormKitInputs<Prop
     yearsHeader: FormKitSlotData<Props, DatePickerSlotData>;
 }
 
+/**
+ * Dropdown slots.
+ *
+ * @public
+ */
 export declare interface FormKitDropdownSlots<Props extends FormKitInputs<Props>> {
     outer: FormKitSlotData<Props, DropdownSlotData>;
     wrapper: FormKitSlotData<Props, DropdownSlotData>;
@@ -666,6 +684,11 @@ export declare interface FormKitOptionsLoader {
     (...args: any[]): Promise<FormKitOptionsProp> | FormKitOptionsProp;
 }
 
+/**
+ * Overlay slots.
+ *
+ * @public
+ */
 export declare type FormKitOverlaySlots<Props extends FormKitInputs<Props>> = Props['overlay'] extends Yes ? {
     overlay: FormKitSlotData<Props, DatePickerSlotData>;
     overlayChar: FormKitSlotData<Props, DatePickerSlotData & {
@@ -726,6 +749,11 @@ declare interface FormKitProSection<IsRoot extends boolean = false> {
     (...children: Array<string | FormKitProExtendableSection>): FormKitProExtendableSection<IsRoot>;
 }
 
+/**
+ * Rating slots.
+ *
+ * @public
+ */
 export declare interface FormKitRatingSlots<Props extends FormKitInputs<Props>> {
     itemsWrapper: FormKitSlotData<Props, RatingSlotData>;
     onItem: FormKitSlotData<Props, RatingSlotData & {
@@ -893,6 +921,11 @@ export declare interface FormKitSliderSlots<Props extends FormKitInputs<Props>>
     messages: FormKitSlotData<Props, SliderSlotData>;
 }
 
+/**
+ * Taglist slots.
+ *
+ * @public
+ */
 export declare interface FormKitTaglistSlots<Props extends FormKitInputs<Props>> {
     outer: FormKitSlotData<Props, TaglistSlotData>;
     wrapper: FormKitSlotData<Props, TaglistSlotData>;
@@ -1087,6 +1120,11 @@ declare interface Meta {
     type: 'placeholder' | 'literal' | 'char' | 'enum';
 }
 
+/**
+ * Loads or resolves an option for option-based inputs.
+ *
+ * @public
+ */
 export declare interface OptionLoader {
     (value: any, cachedItem: FormKitOptionsItem<any>): FormKitOptionsItem<any> | string | void | Promise<FormKitOptionsItem<any> | string | void>;
 }
@@ -1107,6 +1145,8 @@ export declare type Panels = 'year' | 'month' | 'day' | 'time';
 
 /**
  * A map of the parts used
+ *
+ * @public
  */
 export declare type PartMap<T = MaskPart> = {
     [index: string]: T;
@@ -1186,11 +1226,21 @@ export declare interface SliderChartSlots<Props extends FormKitInputs<Props>> {
     chartBar: FormKitSlotData<Props, SliderSlotData>;
 }
 
+/**
+ * Intervals used by slider inputs.
+ *
+ * @public
+ */
 export declare type SliderIntervals = {
     value: number;
     step: number;
 }[];
 
+/**
+ * Scaling function used by slider inputs.
+ *
+ * @public
+ */
 export declare type SliderScalingFunction = {
     forward: (value: number, min?: number, max?: number) => number;
     reverse: (value: number, min?: number, max?: number) => number;
@@ -1242,9 +1292,15 @@ export declare interface SliderSlotData {
  */
 export declare const taglist: FormKitProInput;
 
+/**
+ * Data available to taglist slots.
+ *
+ * @public
+ */
 export declare interface TaglistSlotData {
     options: FormKitOptionsItem[];
     debounce?: number | string;
+    optionsAppearance?: 'checkbox';
     openOnClick?: Bool;
     filter?: (option: FormKitOptionsItem, search: string) => boolean;
     optionLoader?: OptionLoader;
@@ -1303,6 +1359,8 @@ export declare const togglebuttons: FormKitProInput;
 
 /**
  * Slot data for togglebuttons
+ *
+ * @public
  */
 export declare interface TogglebuttonsSlotData<Props extends FormKitInputs<Props>> {
     onValue?: any;
@@ -1324,6 +1382,8 @@ export declare interface TogglebuttonsSlotData<Props extends FormKitInputs<Props
 
 /**
  * Slot data for toggles
+ *
+ * @public
  */
 export declare interface ToggleSlotData<Props extends FormKitInputs<Props>> {
     onValue: Props['onValue'] extends AllReals ? Props['onValue'] : true;
@@ -1407,6 +1467,11 @@ export declare interface TransferlistSlotData {
     };
 }
 
+/**
+ * Transferlist slots.
+ *
+ * @public
+ */
 export declare interface TransferlistSlots<Props extends FormKitInputs<Props>> {
     outer: FormKitSlotData<Props, TransferlistSlotData>;
     fieldset: FormKitSlotData<Props, TransferlistSlotData>;
@@ -1466,10 +1531,17 @@ export declare interface TransferlistSlots<Props extends FormKitInputs<Props>> {
  */
 export declare const unit: FormKitProInput;
 
+/**
+ * Unit types supported by unit conversions.
+ *
+ * @public
+ */
 export declare type Units = DistanceUnits | TemperatureUnits | AreaUnits | WeightUnits | VolumenUnits | TimeUnits;
 
 /**
  * Slot data for unit
+ *
+ * @public
  */
 export declare interface UnitSlotData<Props extends FormKitInputs<Props>> {
     type: 'unit';
@@ -1512,6 +1584,11 @@ declare module '@formkit/core' {
 /* </declare> */
 /* <declare> */
 import type { FormKitBaseSlots } from '@formkit/inputs'
+/**
+ * Loads or resolves an option for option-based inputs.
+ *
+ * @public
+ */
 export interface OptionLoader {
   (value: any, cachedItem: FormKitOptionsItem<any>):
     | FormKitOptionsItem<any>
@@ -1636,6 +1713,7 @@ declare module '@formkit/inputs' {
       popover?: Bool
       options?: FormKitProOptionsProp
       selectionAppearance?: 'truncate' | 'tags'
+      optionsAppearance?: Props['multiple'] extends Yes ? 'checkbox' : undefined
       filter?: (option: FormKitOptionsItem, search: string) => boolean
       optionLoader?: OptionLoader
       emptyMessage?: string
@@ -1724,6 +1802,7 @@ declare module '@formkit/inputs' {
       debounce?: number | string
       options?: FormKitProOptionsProp
       selectionAppearance?: 'truncate' | 'tags'
+      optionsAppearance?: 'checkbox'
       popover?: Bool
       openOnClick?: Bool
       filter?: (option: FormKitOptionsItem, search: string) => boolean