@rockrms/obsidian-framework 17.6.1 → 18.2.4

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

@@ -0,0 +1,364 @@
+import { PropType } from "vue";
+import { LabelDateFormat, LegendAlign, LegendPosition, LineStyle, DoughnutSeries, 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 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 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;
+    };
+}>>, {
+    type: "number" | "percent";
+    width: string | undefined;
+    height: string | undefined;
+}, {}>;
+export default _default;

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

@@ -14,6 +14,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string[]>;
         default: string[];
     };
+    preventOverflowClipping: {
+        type: PropType<boolean>;
+        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<{
@@ -31,12 +35,17 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string[]>;
         default: string[];
     };
+    preventOverflowClipping: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((v: boolean) => any) | undefined;
 }, {
     modelValue: boolean;
     showArrow: boolean;
     preventCloseOnClickSelectors: string[];
+    preventOverflowClipping: boolean;
 }, {}>, {
     anchor?(_: {}): any;
     default?(_: {}): any;

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

@@ -0,0 +1,70 @@
+import { PropType } from "vue";
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The value that will be edited by the dynamic component.
+     */
+    modelValue: {
+        type: PropType<Record<string, string>>;
+        required: false;
+    };
+    /**
+     * The dynamic component definition that will be used to load the
+     * component and pass the custom options to it.
+     */
+    definition: {
+        type: PropType<DynamicComponentDefinitionBag>;
+        required: true;
+    };
+    /**
+     * Additional properties that will be passed to the component.
+     */
+    properties: {
+        type: PropType<Record<string, unknown>>;
+        required: false;
+    };
+    /**
+     * The function that will be used to send any requests from the
+     * component to the server.
+     */
+    executeRequest: {
+        type: PropType<(request: Record<string, string>, securityGrantToken: string | null) => Promise<Record<string, string> | null>>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: unknown) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The value that will be edited by the dynamic component.
+     */
+    modelValue: {
+        type: PropType<Record<string, string>>;
+        required: false;
+    };
+    /**
+     * The dynamic component definition that will be used to load the
+     * component and pass the custom options to it.
+     */
+    definition: {
+        type: PropType<DynamicComponentDefinitionBag>;
+        required: true;
+    };
+    /**
+     * Additional properties that will be passed to the component.
+     */
+    properties: {
+        type: PropType<Record<string, unknown>>;
+        required: false;
+    };
+    /**
+     * The function that will be used to send any requests from the
+     * component to the server.
+     */
+    executeRequest: {
+        type: PropType<(request: Record<string, string>, securityGrantToken: string | null) => Promise<Record<string, string> | null>>;
+        required: false;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: unknown) => any) | undefined;
+}, {}, {}>;
+export default _default;

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

@@ -0,0 +1,117 @@
+import { PropType } from "vue";
+type ProgressBar = {
+    /**
+     * The percentage value of the progress bar.
+     *
+     * This should be a number between 0 and 100.
+     */
+    value: number;
+    /**
+     * The opacity of the progress bar (defaults to 100% opacity when nullish).
+     *
+     * This should be a string representing a CSS opacity value (e.g., "0.5", "1").
+     */
+    opacity?: string | null | undefined;
+    /**
+     * The text to display inside the progress bar.
+     */
+    text?: string | null | undefined;
+    /**
+     * The progress bar type, which determines the color and style of the bar (defaults to `props.progressType`).
+     */
+    type?: ProgressBarType;
+};
+type Indicator = {
+    /**
+     * The percentage value of the progress bar where the indicator should appear.
+     *
+     * This should be a number between 0 and 100.
+     */
+    value: number;
+    /**
+     * The indicator type, which determines the color and style of the indicator (defaults to `props.indicatorType`).
+     */
+    type?: ProgressBarType | null | undefined;
+};
+type ProgressBarType = "danger" | "success" | "critical" | "warning" | "info" | "default";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The progress to display in the progress bar.
+     *
+     * These should be percentages (0-100) that indicate the progress of the task.
+     */
+    modelValue: {
+        type: PropType<number | ProgressBar | ProgressBar[] | null | undefined>;
+        required: true;
+    };
+    /**
+     * Optional indicator marks to display along the progress bar.
+     *
+     * These should be percentages (0-100) that represent where the indicators should be placed.
+     */
+    indicators: {
+        type: PropType<(number | Indicator)[] | null | undefined>;
+    };
+    /**
+     * The type of indicator marks to display along the progress bar.
+     */
+    indicatorType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     * The color for the progress bar.
+     */
+    progressType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     *  The tooltip for the progress bar (supports HTML)
+     */
+    tooltip: {
+        type: PropType<string | null | undefined>;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The progress to display in the progress bar.
+     *
+     * These should be percentages (0-100) that indicate the progress of the task.
+     */
+    modelValue: {
+        type: PropType<number | ProgressBar | ProgressBar[] | null | undefined>;
+        required: true;
+    };
+    /**
+     * Optional indicator marks to display along the progress bar.
+     *
+     * These should be percentages (0-100) that represent where the indicators should be placed.
+     */
+    indicators: {
+        type: PropType<(number | Indicator)[] | null | undefined>;
+    };
+    /**
+     * The type of indicator marks to display along the progress bar.
+     */
+    indicatorType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     * The color for the progress bar.
+     */
+    progressType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     *  The tooltip for the progress bar (supports HTML)
+     */
+    tooltip: {
+        type: PropType<string | null | undefined>;
+    };
+}>>, {
+    indicatorType: ProgressBarType;
+    progressType: ProgressBarType;
+}, {}>;
+export default _default;

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

@@ -28,23 +28,8 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        /**
-         * Perform additional processing on the items based on our property
-         * settings.
-         *
-         * @param items The items to be processed.
-         *
-         * @returns A new array of items that have been processed.
-         */
         default: false;
-    }; /**
-     * Perform additional processing on the items based on our property
-     * settings.
-     *
-     * @param items The items to be processed.
-     *
-     * @returns A new array of items that have been processed.
-     */
+    };
     lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
@@ -60,9 +45,7 @@ declare const _default: import("vue").DefineComponent<{
     blankValue: {
         type: PropType<string>;
         default: "";
-    }; /**
-     * Loads the items from the server.
-     */
+    };
     displayStyle: {
         type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
         default: "auto";
@@ -113,23 +96,8 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        /**
-         * Perform additional processing on the items based on our property
-         * settings.
-         *
-         * @param items The items to be processed.
-         *
-         * @returns A new array of items that have been processed.
-         */
         default: false;
-    }; /**
-     * Perform additional processing on the items based on our property
-     * settings.
-     *
-     * @param items The items to be processed.
-     *
-     * @returns A new array of items that have been processed.
-     */
+    };
     lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
@@ -145,9 +113,7 @@ declare const _default: import("vue").DefineComponent<{
     blankValue: {
         type: PropType<string>;
         default: "";
-    }; /**
-     * Loads the items from the server.
-     */
+    };
     displayStyle: {
         type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
         default: "auto";

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

@@ -28,12 +28,11 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        default: false;
-    };
-    lazyMode: {
-        /**
+        default: false; /**
          * Loads the items from the server.
          */
+    };
+    lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
@@ -100,12 +99,11 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        default: false;
-    };
-    lazyMode: {
-        /**
+        default: false; /**
          * Loads the items from the server.
          */
+    };
+    lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };

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

@@ -23,6 +23,10 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     isRequiredIndicatorHidden: {
+        /**
+         * The actual items to make available to the picker. This allows us to do any
+         * post-processing, such as adding additional items, and still be lazy loaded as well.
+         */
         type: PropType<boolean>;
         default: false;
     };
@@ -84,6 +88,10 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     isRequiredIndicatorHidden: {
+        /**
+         * The actual items to make available to the picker. This allows us to do any
+         * post-processing, such as adding additional items, and still be lazy loaded as well.
+         */
         type: PropType<boolean>;
         default: false;
     };