@rockrms/obsidian-framework 17.6.1 → 18.2.4

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

@@ -0,0 +1,378 @@
+import { PropType } from "vue";
+import { LabelDateFormat, LegendAlign, LegendPosition, LineSeries, LineStyle, 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 line 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<LineSeries[]>;
+        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 number of decimal places to display for values.
+     * Applies to both axis tick labels and tooltips.
+     */
+    valuePrecision: {
+        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 line 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 line 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<LineSeries[]>;
+        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 number of decimal places to display for values.
+     * Applies to both axis tick labels and tooltips.
+     */
+    valuePrecision: {
+        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 line 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/locationAddressPicker.obs.d.ts

@@ -29,9 +29,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: "";
     };
     validationTitle: {
-        type: PropType<string>; /**
-         * V-Model of whether the popup area is opened.
-         */
+        type: PropType<string>;
         default: "";
     };
     isRequiredIndicatorHidden: {
@@ -70,9 +68,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: "";
     };
     validationTitle: {
-        type: PropType<string>; /**
-         * V-Model of whether the popup area is opened.
-         */
+        type: PropType<string>;
         default: "";
     };
     isRequiredIndicatorHidden: {

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

@@ -31,9 +31,9 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    /** Whether to hide the media folder dropdown portion */
     lazyMode: {
         type: PropType<ControlLazyMode>;
-        /** Whether to hide the media folder dropdown portion */
         default: "onDemand";
     };
     multiple: {
@@ -43,7 +43,7 @@ declare const _default: import("vue").DefineComponent<{
     showBlankItem: {
         type: PropType<boolean>;
         default: false;
-    }; /** True to hide the refresh buttons next to the folder and element dropdowns */
+    };
     blankValue: {
         type: PropType<string>;
         default: "";
@@ -135,9 +135,9 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    /** Whether to hide the media folder dropdown portion */
     lazyMode: {
         type: PropType<ControlLazyMode>;
-        /** Whether to hide the media folder dropdown portion */
         default: "onDemand";
     };
     multiple: {
@@ -147,7 +147,7 @@ declare const _default: import("vue").DefineComponent<{
     showBlankItem: {
         type: PropType<boolean>;
         default: false;
-    }; /** True to hide the refresh buttons next to the folder and element dropdowns */
+    };
     blankValue: {
         type: PropType<string>;
         default: "";

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

@@ -61,6 +61,22 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<() => void | PromiseLike<void>>;
         required: false;
     };
+    /**
+     * Automatically disables the Save button when it is in a loading state or
+     * the click handler is processing. This can prevent duplicate clicks.
+     */
+    saveAutoDisable: {
+        type: PropType<boolean | undefined>;
+        required: false;
+    };
+    saveAutoLoading: {
+        type: PropType<boolean | undefined>;
+        required: false;
+    };
+    saveLoadingText: {
+        type: PropType<string | undefined>;
+        required: false;
+    };
     /** True if the form should attempt to submit. */
     submit: {
         type: PropType<boolean>;
@@ -133,6 +149,22 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<() => void | PromiseLike<void>>;
         required: false;
     };
+    /**
+     * Automatically disables the Save button when it is in a loading state or
+     * the click handler is processing. This can prevent duplicate clicks.
+     */
+    saveAutoDisable: {
+        type: PropType<boolean | undefined>;
+        required: false;
+    };
+    saveAutoLoading: {
+        type: PropType<boolean | undefined>;
+        required: false;
+    };
+    saveLoadingText: {
+        type: PropType<string | undefined>;
+        required: false;
+    };
     /** True if the form should attempt to submit. */
     submit: {
         type: PropType<boolean>;
@@ -147,9 +179,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {
     title: string;
     submit: boolean;
+    subtitle: string;
     modalWrapperClasses: string;
     modalContentClasses: string;
-    subtitle: string;
     cancelText: string;
     saveText: string;
     saveThenAddText: string;

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

@@ -30,6 +30,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    /** The maximum number of characters allowed to be entered. */
+    maxLength: {
+        type: PropType<number | null>;
+        default: null;
+    };
     inputGroupClasses: {
         type: PropType<string>;
         default: string;
@@ -71,6 +76,11 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    /** The maximum number of characters allowed to be entered. */
+    maxLength: {
+        type: PropType<number | null>;
+        default: null;
+    };
     inputGroupClasses: {
         type: PropType<string>;
         default: string;
@@ -88,6 +98,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     rules: ValidationRule | ValidationRule[];
     validationTitle: string;
     modelModifiers: Record<string, boolean>;
+    maxLength: number | null;
     inputClasses: string;
     inputGroupClasses: string;
     decimalCount: number | null;

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

@@ -62,6 +62,34 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    /**
+     * The array of optional tabs that will be displayed. It is the
+     * responsibility of the parent component to provide the content for
+     * each tab as well as swap the content when the tab is selected. See
+     * the `selectedTab` prop and `update:selectedTab` event.
+     */
+    tabs: {
+        type: PropType<string[]>;
+        default: never[];
+    };
+    /**
+     * The currently selected tab. This is used in combination with the
+     * `tabs` prop to determine which tab is currently selected.
+     */
+    selectedTab: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Enables the worksurface mode which allows the panel to be used on
+     * a full worksurface layout. This will cause the body content to
+     * automatically scroll if it is too large to fit in the panel. All
+     * other panel elements will remain in static positions.
+     */
+    worksurfaceMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     /** A list of action items to be included in the ellipsis. */
     headerSecondaryActions: {
         type: PropType<PanelAction[]>;
@@ -72,12 +100,24 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
-    /** The CSS class to add to the panel-heading element. */
-    panelHeadingCssClass: {
+    /** The CSS class to add to the panel-header element. */
+    panelHeaderCssClass: {
         type: PropType<string>;
         default: string;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "update:isFullscreen" | "update:isDrawerOpen")[], "update:modelValue" | "update:isFullscreen" | "update:isDrawerOpen", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** Removes the borders of a panel. Only works with RockNextGen theme! */
+    isBorderlessPanel: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Removes the padding from the body of the panel.
+     */
+    hasNoBodyPadding: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "update:isFullscreen" | "update:isDrawerOpen" | "update:selectedTab")[], "update:modelValue" | "update:isFullscreen" | "update:isDrawerOpen" | "update:selectedTab", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /** True if the panel content is shown when hasCollapse is also true. */
     modelValue: {
         type: PropType<boolean>;
@@ -139,6 +179,34 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    /**
+     * The array of optional tabs that will be displayed. It is the
+     * responsibility of the parent component to provide the content for
+     * each tab as well as swap the content when the tab is selected. See
+     * the `selectedTab` prop and `update:selectedTab` event.
+     */
+    tabs: {
+        type: PropType<string[]>;
+        default: never[];
+    };
+    /**
+     * The currently selected tab. This is used in combination with the
+     * `tabs` prop to determine which tab is currently selected.
+     */
+    selectedTab: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Enables the worksurface mode which allows the panel to be used on
+     * a full worksurface layout. This will cause the body content to
+     * automatically scroll if it is too large to fit in the panel. All
+     * other panel elements will remain in static positions.
+     */
+    worksurfaceMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     /** A list of action items to be included in the ellipsis. */
     headerSecondaryActions: {
         type: PropType<PanelAction[]>;
@@ -149,20 +217,34 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
-    /** The CSS class to add to the panel-heading element. */
-    panelHeadingCssClass: {
+    /** The CSS class to add to the panel-header element. */
+    panelHeaderCssClass: {
         type: PropType<string>;
         default: string;
     };
+    /** Removes the borders of a panel. Only works with RockNextGen theme! */
+    isBorderlessPanel: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Removes the padding from the body of the panel.
+     */
+    hasNoBodyPadding: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
     "onUpdate:isFullscreen"?: ((...args: any[]) => any) | undefined;
     "onUpdate:isDrawerOpen"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:selectedTab"?: ((...args: any[]) => any) | undefined;
 }, {
     type: "default" | "primary" | "danger" | "warning" | "success" | "info" | "block" | "widget";
     title: string;
     modelValue: boolean;
     isFullscreen: boolean;
+    tabs: string[];
     isDrawerOpen: boolean;
     hasTitle: boolean;
     hasCollapse: boolean;
@@ -170,8 +252,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     hasFullscreen: boolean;
     isFullscreenPageOnly: boolean;
     titleIconCssClass: string;
+    selectedTab: string;
+    worksurfaceMode: boolean;
     panelBodyCssClass: string;
-    panelHeadingCssClass: string;
+    panelHeaderCssClass: string;
+    isBorderlessPanel: boolean;
+    hasNoBodyPadding: boolean;
 }, {}>, {
     sidebar?(_: {}): any;
     title?(_: {
@@ -183,10 +269,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     subheaderRight?(_: {}): any;
     helpContent?(_: {}): any;
     drawer?(_: {}): any;
+    drawerToggle?(_: {}): any;
     preBody?(_: {}): any;
     default?(_: {}): any;
     footerActions?(_: {}): any;
     footerSecondaryActions?(_: {}): any;
+    footerContent?(_: {}): any;
 }>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {