@rockrms/obsidian-framework 17.5.2 → 18.1.0

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

@@ -0,0 +1,147 @@
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    disableLabel: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    help: {
+        type: PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    enhanceForLongLists: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    lazyMode: {
+        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
+        default: "onDemand";
+    };
+    multiple: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    showBlankItem: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    blankValue: {
+        type: PropType<string>;
+        default: "";
+    };
+    displayStyle: {
+        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
+        default: "auto";
+    };
+    columnCount: {
+        type: PropType<number>;
+        default: 0;
+    };
+    modelValue: {
+        type: PropType<ListItemBag | ListItemBag[] | null>;
+        required: false;
+    };
+    learningClassGuid: {
+        type: PropType<string | null>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: ListItemBag | ListItemBag[] | null) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    disableLabel: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    help: {
+        type: PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    enhanceForLongLists: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    lazyMode: {
+        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
+        default: "onDemand";
+    };
+    multiple: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    showBlankItem: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    blankValue: {
+        type: PropType<string>;
+        default: "";
+    };
+    displayStyle: {
+        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
+        default: "auto";
+    };
+    columnCount: {
+        type: PropType<number>;
+        default: 0;
+    };
+    modelValue: {
+        type: PropType<ListItemBag | ListItemBag[] | null>;
+        required: false;
+    };
+    learningClassGuid: {
+        type: PropType<string | null>;
+        required: true;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: ListItemBag | ListItemBag[] | null) => any) | undefined;
+}, {
+    label: string;
+    help: string;
+    disableLabel: boolean;
+    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
+    formGroupClasses: string;
+    validationTitle: string;
+    isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
+    enhanceForLongLists: boolean;
+    showBlankItem: boolean;
+    blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
+    displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,147 @@
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    disableLabel: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    help: {
+        type: PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    enhanceForLongLists: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    lazyMode: {
+        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
+        default: "onDemand";
+    };
+    multiple: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    showBlankItem: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    blankValue: {
+        type: PropType<string>;
+        default: "";
+    };
+    displayStyle: {
+        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
+        default: "auto";
+    };
+    columnCount: {
+        type: PropType<number>;
+        default: 0;
+    };
+    modelValue: {
+        type: PropType<ListItemBag | ListItemBag[] | null>;
+        required: false;
+    };
+    learningCourseGuid: {
+        type: PropType<string | null>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: ListItemBag | ListItemBag[] | null) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    disableLabel: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    help: {
+        type: PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    enhanceForLongLists: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    lazyMode: {
+        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
+        default: "onDemand";
+    };
+    multiple: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    showBlankItem: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    blankValue: {
+        type: PropType<string>;
+        default: "";
+    };
+    displayStyle: {
+        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
+        default: "auto";
+    };
+    columnCount: {
+        type: PropType<number>;
+        default: 0;
+    };
+    modelValue: {
+        type: PropType<ListItemBag | ListItemBag[] | null>;
+        required: false;
+    };
+    learningCourseGuid: {
+        type: PropType<string | null>;
+        required: true;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: ListItemBag | ListItemBag[] | null) => any) | undefined;
+}, {
+    label: string;
+    help: string;
+    disableLabel: boolean;
+    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
+    formGroupClasses: string;
+    validationTitle: string;
+    isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
+    enhanceForLongLists: boolean;
+    showBlankItem: boolean;
+    blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
+    displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
+}, {}>;
+export default _default;

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: {