@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/Controls/doughnutChart.obs.d.ts

@@ -0,0 +1,376 @@
+import { PropType } from "vue";
+import { DoughnutSeries, LabelDateFormat, LegendAlign, LegendPosition, LineStyle, TitleAlign, TooltipCallback } from "@Obsidian/Core/Controls/chart";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The category axis label.
+     */
+    categoryLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the category axis.
+     */
+    categoryMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * Whether to show the category axis grid lines. Hidden by default.
+     */
+    categoryShowGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The CSS style string to set the height of the doughnut chart component.
+     * - Accepts any valid CSS height value (e.g., "400px", "50vh") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    height: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+    /**
+     * Whether the legend is hidden.
+     */
+    hideLegend: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The format to use for the date labels.
+     *
+     * When set, `labels` is treated as an array of ISO date strings.
+     */
+    labelDateFormat: {
+        type: PropType<LabelDateFormat | undefined>;
+    };
+    /**
+     * When supplying date strings, they MUST be in ISO format and you MUST set `labelDateFormat`.
+     */
+    labels: {
+        type: PropType<string[]>;
+        required: true;
+    };
+    /**
+     * The alignment of the legend in the chart.
+     */
+    legendAlign: {
+        type: PropType<LegendAlign | null | undefined>;
+    };
+    /**
+     * The position of the legend in the chart.
+     */
+    legendPosition: {
+        type: PropType<LegendPosition | undefined>;
+    };
+    /**
+     * Whether the chart has linear connections between data points.
+     *
+     * The per series property, `props.data[n].isLinear`, overrides this setting.
+     */
+    linear: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The line style to use for the chart.
+     *
+     * The per series property, `props.data[n].lineStyle`, overrides this setting.
+     */
+    lineStyle: {
+        type: PropType<LineStyle | undefined>;
+    };
+    /**
+     * The series data to display in the chart.
+     */
+    series: {
+        type: PropType<DoughnutSeries[]>;
+        required: true;
+    };
+    /**
+     * Whether the chart has stacked lines.
+     */
+    stack: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The title of the chart.
+     */
+    title: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The alignment of the chart title.
+     */
+    titleAlign: {
+        type: PropType<TitleAlign | undefined>;
+    };
+    /**
+     * The tooltip formatter function.
+     */
+    tooltip: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The tooltip title formatter function.
+     */
+    tooltipTitle: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The type of data represented in the chart.
+     *
+     * For "percent", the data MUST be in decimal form (e.g., 0.1 for 10%).
+     */
+    type: {
+        type: PropType<"number" | "percent">;
+        default: string;
+    };
+    /**
+     * Whether the chart has unfilled areas.
+     *
+     * The per series property, `props.data[n].isUnfilled`, overrides this setting.
+     */
+    unfilled: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * Whether to hide the value axis grid lines. Shown by default.
+     */
+    valueHideGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The value axis label.
+     */
+    valueLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the value axis.
+     */
+    valueMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The minimum value to display in the value axis if there is nothing lower.
+     *
+     * This is useful for controlling the starting point of the value axis.
+     * The actual minimum value will be used if there is a lower value present.
+     */
+    valueSuggestedMin: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The maximum value to display in the value axis if there is nothing higher.
+     *
+     * This is useful for controlling the ending point of the value axis.
+     * The actual maximum value will be used if there is a higher value present.
+     */
+    valueSuggestedMax: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The number of ticks to show on the value axis.
+     *
+     * This overrides `valueMaxTickCount`.
+     */
+    valueTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The CSS style string to set the width of the doughnut chart component.
+     * - Accepts any valid CSS width value (e.g., "600px", "100%") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    width: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The category axis label.
+     */
+    categoryLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the category axis.
+     */
+    categoryMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * Whether to show the category axis grid lines. Hidden by default.
+     */
+    categoryShowGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The CSS style string to set the height of the doughnut chart component.
+     * - Accepts any valid CSS height value (e.g., "400px", "50vh") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    height: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+    /**
+     * Whether the legend is hidden.
+     */
+    hideLegend: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The format to use for the date labels.
+     *
+     * When set, `labels` is treated as an array of ISO date strings.
+     */
+    labelDateFormat: {
+        type: PropType<LabelDateFormat | undefined>;
+    };
+    /**
+     * When supplying date strings, they MUST be in ISO format and you MUST set `labelDateFormat`.
+     */
+    labels: {
+        type: PropType<string[]>;
+        required: true;
+    };
+    /**
+     * The alignment of the legend in the chart.
+     */
+    legendAlign: {
+        type: PropType<LegendAlign | null | undefined>;
+    };
+    /**
+     * The position of the legend in the chart.
+     */
+    legendPosition: {
+        type: PropType<LegendPosition | undefined>;
+    };
+    /**
+     * Whether the chart has linear connections between data points.
+     *
+     * The per series property, `props.data[n].isLinear`, overrides this setting.
+     */
+    linear: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The line style to use for the chart.
+     *
+     * The per series property, `props.data[n].lineStyle`, overrides this setting.
+     */
+    lineStyle: {
+        type: PropType<LineStyle | undefined>;
+    };
+    /**
+     * The series data to display in the chart.
+     */
+    series: {
+        type: PropType<DoughnutSeries[]>;
+        required: true;
+    };
+    /**
+     * Whether the chart has stacked lines.
+     */
+    stack: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The title of the chart.
+     */
+    title: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The alignment of the chart title.
+     */
+    titleAlign: {
+        type: PropType<TitleAlign | undefined>;
+    };
+    /**
+     * The tooltip formatter function.
+     */
+    tooltip: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The tooltip title formatter function.
+     */
+    tooltipTitle: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The type of data represented in the chart.
+     *
+     * For "percent", the data MUST be in decimal form (e.g., 0.1 for 10%).
+     */
+    type: {
+        type: PropType<"number" | "percent">;
+        default: string;
+    };
+    /**
+     * Whether the chart has unfilled areas.
+     *
+     * The per series property, `props.data[n].isUnfilled`, overrides this setting.
+     */
+    unfilled: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * Whether to hide the value axis grid lines. Shown by default.
+     */
+    valueHideGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The value axis label.
+     */
+    valueLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the value axis.
+     */
+    valueMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The minimum value to display in the value axis if there is nothing lower.
+     *
+     * This is useful for controlling the starting point of the value axis.
+     * The actual minimum value will be used if there is a lower value present.
+     */
+    valueSuggestedMin: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The maximum value to display in the value axis if there is nothing higher.
+     *
+     * This is useful for controlling the ending point of the value axis.
+     * The actual maximum value will be used if there is a higher value present.
+     */
+    valueSuggestedMax: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The number of ticks to show on the value axis.
+     *
+     * This overrides `valueMaxTickCount`.
+     */
+    valueTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The CSS style string to set the width of the doughnut chart component.
+     * - Accepts any valid CSS width value (e.g., "600px", "100%") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    width: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+}>>, {
+    height: string | undefined;
+    width: string | undefined;
+    type: "number" | "percent";
+}, {}>;
+export default _default;

package/types/Controls/dropDownContent.obs.d.ts

@@ -1,5 +1,11 @@
 import { PropType } from "vue";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+declare var __VLS_1: {}, __VLS_3: {};
+type __VLS_Slots = {} & {
+    anchor?: (props: typeof __VLS_1) => any;
+} & {
+    default?: (props: typeof __VLS_3) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
     modelValue: {
         type: BooleanConstructor;
         default: boolean;
@@ -18,6 +24,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    enableFlip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (v: boolean) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -39,6 +49,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    enableFlip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((v: boolean) => any) | undefined;
 }, {
@@ -46,12 +60,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     showArrow: boolean;
     preventCloseOnClickSelectors: string[];
     preventOverflowClipping: boolean;
-}, {}>, {
-    anchor?(_: {}): any;
-    default?(_: {}): any;
-}>;
+    enableFlip: boolean;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };

package/types/Controls/dropDownList.obs.d.ts

@@ -1,7 +1,44 @@
 import { PropType } from "vue";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { defaultControlCompareValue } from "@Obsidian/Utility/stringUtils";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+declare var __VLS_5: {
+    isInputGroupSupported: boolean;
+}, __VLS_7: {
+    isInputGroupSupported: boolean;
+}, __VLS_17: {
+    label: string;
+    value: string;
+    disabled: boolean;
+    closable: boolean;
+}, __VLS_19: {
+    omittedValues: {
+        label: string;
+        value: string;
+        disabled: boolean;
+    }[];
+}, __VLS_21: {}, __VLS_23: {}, __VLS_29: {
+    isInputGroupSupported: boolean;
+}, __VLS_31: {
+    isInputGroupSupported: boolean;
+};
+type __VLS_Slots = {} & {
+    prepend?: (props: typeof __VLS_5) => any;
+} & {
+    inputGroupPrepend?: (props: typeof __VLS_7) => any;
+} & {
+    tagRender?: (props: typeof __VLS_17) => any;
+} & {
+    maxTagPlaceholder?: (props: typeof __VLS_19) => any;
+} & {
+    suffixIcon?: (props: typeof __VLS_21) => any;
+} & {
+    empty?: (props: typeof __VLS_23) => any;
+} & {
+    inputGroupAppend?: (props: typeof __VLS_29) => any;
+} & {
+    append?: (props: typeof __VLS_31) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
     label: {
         type: PropType<string>;
         default: "";
@@ -27,6 +64,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: PropType<string | string[]>;
         required: true;
@@ -73,7 +114,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: boolean;
     };
     compareValue: {
-        type: PropType<(value: string, itemValue: string) => boolean>;
+        type: PropType<((value: string, itemValue: string) => boolean)>;
         default: typeof defaultControlCompareValue;
     };
     /**
@@ -118,6 +159,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: PropType<string | string[]>;
         required: true;
@@ -164,7 +209,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: boolean;
     };
     compareValue: {
-        type: PropType<(value: string, itemValue: string) => boolean>;
+        type: PropType<((value: string, itemValue: string) => boolean)>;
         default: typeof defaultControlCompareValue;
     };
     /**
@@ -184,56 +229,30 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((value: string | string[]) => any) | undefined;
     onOpen?: (() => any) | undefined;
 }, {
+    items: ListItemBag[];
     label: string;
-    disabled: boolean;
+    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     loading: boolean;
+    disabled: boolean;
     help: string;
     disableLabel: boolean;
-    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    trailblazerField: boolean;
     inputClasses: string;
-    multiple: boolean;
-    items: ListItemBag[];
-    enhanceForLongLists: boolean;
-    compareValue: (value: string, itemValue: string) => boolean;
     showBlankItem: boolean;
     blankValue: string;
+    multiple: boolean;
     formControlClasses: string;
+    enhanceForLongLists: boolean;
     grouped: boolean;
+    compareValue: (value: string, itemValue: string) => boolean;
     maxTagCount: number | "responsive" | undefined;
-}, {}>, {
-    prepend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    inputGroupPrepend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    tagRender?(_: {
-        label: string;
-        value: string;
-        disabled: boolean;
-        closable: boolean;
-    }): any;
-    maxTagPlaceholder?(_: {
-        omittedValues: {
-            label: string;
-            value: string;
-            disabled: boolean;
-        }[];
-    }): any;
-    suffixIcon?(_: {}): any;
-    empty?(_: {}): any;
-    inputGroupAppend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    append?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };