@rockrms/obsidian-framework 17.6.1 → 18.2.4

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

@@ -0,0 +1,47 @@
+import { PropType } from "vue";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /**
+     * Determines the visibility of the sidebar. If not provided, it will
+     * default to automatically showing the sidebar if there are multiple
+     * sections.
+     */
+    sidebar: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * The position of the sidebar. This can be either "left" or "right".
+     */
+    sidebarPosition: {
+        type: PropType<"left" | "right">;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Determines the visibility of the sidebar. If not provided, it will
+     * default to automatically showing the sidebar if there are multiple
+     * sections.
+     */
+    sidebar: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    /**
+     * The position of the sidebar. This can be either "left" or "right".
+     */
+    sidebarPosition: {
+        type: PropType<"left" | "right">;
+        default: string;
+    };
+}>>, {
+    sidebar: boolean | undefined;
+    sidebarPosition: "left" | "right";
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,63 @@
+import { PropType } from "vue";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /**
+     * The title of the stack. This should be a brief, descriptive label
+     * about the contents of the stack.
+     */
+    title: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * The description of the stack. This should provide more context
+     * about the contents of the stack.
+     */
+    description: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * The position of the sidebar. This can be either "left", "right" or "top".
+     */
+    headerLocation: {
+        type: PropType<"left" | "top" | "right">;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The title of the stack. This should be a brief, descriptive label
+     * about the contents of the stack.
+     */
+    title: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * The description of the stack. This should provide more context
+     * about the contents of the stack.
+     */
+    description: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * The position of the sidebar. This can be either "left", "right" or "top".
+     */
+    headerLocation: {
+        type: PropType<"left" | "top" | "right">;
+        default: string;
+    };
+}>>, {
+    title: string;
+    description: string;
+    headerLocation: "left" | "top" | "right";
+}, {}>, {
+    header?(_: {}): any;
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,66 @@
+import { PropType } from "vue";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /** The title to display in the slicer bar. */
+    title: {
+        type: PropType<string>;
+        required: true;
+    };
+    /** Whether to show the campus context picker. */
+    showCampus: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Campus type defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusTypeFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+    /**
+     * Campus status defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusStatusFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The title to display in the slicer bar. */
+    title: {
+        type: PropType<string>;
+        required: true;
+    };
+    /** Whether to show the campus context picker. */
+    showCampus: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Campus type defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusTypeFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+    /**
+     * Campus status defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusStatusFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+}>>, {
+    showCampus: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -1,5 +1,6 @@
 import { PropType } from "vue";
-declare const _default: import("vue").DefineComponent<{
+import { BtnSize } from "@Obsidian/Enums/Controls/btnSize";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     value: {
         type: PropType<string>;
         required: true;
@@ -17,6 +18,12 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"auto" | "left" | "top" | "right" | "bottom">;
         default: string;
     };
+    isSquare: {
+        type: PropType<boolean | null | undefined>;
+    };
+    btnSize: {
+        type: PropType<BtnSize | undefined>;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     value: {
         type: PropType<string>;
@@ -35,8 +42,21 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"auto" | "left" | "top" | "right" | "bottom">;
         default: string;
     };
+    isSquare: {
+        type: PropType<boolean | null | undefined>;
+    };
+    btnSize: {
+        type: PropType<BtnSize | undefined>;
+    };
 }>>, {
     tooltip: string;
     tooltipPlacement: "auto" | "left" | "top" | "right" | "bottom";
-}, {}>;
+}, {}>, {
+    default?(_: {}): any;
+}>;
 export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -10,6 +10,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     help: {
         type: PropType<string>;
+        /** Whether to parse the entered value and reformat it to match the set format. NOT Reactive */
         default: "";
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
@@ -97,6 +98,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     help: {
         type: PropType<string>;
+        /** Whether to parse the entered value and reformat it to match the set format. NOT Reactive */
         default: "";
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;

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

@@ -0,0 +1,127 @@
+import { PropType } from "vue";
+import { MenuAction } from "@Obsidian/Types/Controls/dropDownMenu";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    aside: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    asideIconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    badgeText: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconLabelType: {
+        type: PropType<string | Omit<"default" | "type" | "primary" | "danger" | "warning" | "success" | "info" | "campus" | "custom", "custom">>;
+        default: "info";
+    };
+    iconTitleAndDescMinWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "150px";
+    };
+    description: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    minWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "440px";
+    };
+    primaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    secondaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    title: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /**
+     * Optional click handler that will be called when the main item
+     * is clicked.
+     */
+    onClick: {
+        type: PropType<() => void>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    aside: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    asideIconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    badgeText: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconLabelType: {
+        type: PropType<string | Omit<"default" | "type" | "primary" | "danger" | "warning" | "success" | "info" | "campus" | "custom", "custom">>;
+        default: "info";
+    };
+    iconTitleAndDescMinWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "150px";
+    };
+    description: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    minWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "440px";
+    };
+    primaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    secondaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    title: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /**
+     * Optional click handler that will be called when the main item
+     * is clicked.
+     */
+    onClick: {
+        type: PropType<() => void>;
+        required: false;
+    };
+}>>, {
+    iconLabelType: string | Omit<"default" | "type" | "primary" | "danger" | "warning" | "success" | "info" | "campus" | "custom", "custom">;
+    iconTitleAndDescMinWidth: string;
+    minWidth: string;
+}, {}>, {
+    prepend?(_: {}): any;
+    description?(_: {}): any;
+    actions?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,24 @@
+import { PropType } from "vue";
+import { MenuAction } from "@Obsidian/Types/Controls/dropDownMenu";
+declare const _default: import("vue").DefineComponent<{
+    actions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    addText: {
+        type: PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    actions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    addText: {
+        type: PropType<string>;
+        default: string;
+    };
+}>>, {
+    addText: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,23 @@
+import { PropType, VNodeTypes } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    tippableConnectorTargets: {
+        type: PropType<VNodeTypes[] | null | undefined>;
+        required: false;
+    };
+    hasConnectors: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    tippableConnectorTargets: {
+        type: PropType<VNodeTypes[] | null | undefined>;
+        required: false;
+    };
+    hasConnectors: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    hasConnectors: boolean;
+}, {}>;
+export default _default;