@rockrms/obsidian-framework 1.16.3-rc.1

package/types/Controls/Grid/Columns/reorderColumn.partial.d.ts

@@ -0,0 +1,176 @@
+import { Component, PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    name: {
+        type: PropType<string>;
+        default: string;
+    };
+    formatComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}>;
+    };
+    headerClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    itemClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    width: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Called when the order of an item has changed. The first parameter
+     * is the row item that was moved. The second parameter is the row item
+     * it was dropped in front of or `null` if it was dropped at the end of
+     * the grid.
+     */
+    onOrderChanged: {
+        type: PropType<(item: Record<string, unknown>, beforeItem: Record<string, unknown> | null) => void | Promise<void> | boolean | Promise<boolean>>;
+        required: false;
+    };
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    field: {
+        type: PropType<string>;
+        required: false;
+    };
+    quickFilterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").QuickFilterValueFunction>;
+        required: false;
+    };
+    sortField: {
+        type: PropType<string>;
+        required: false;
+    };
+    sortValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        required: false;
+    };
+    filter: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
+        required: false;
+    };
+    filterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
+        required: false;
+    };
+    exportValue: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ExportValueFunction>;
+        required: false;
+    };
+    headerComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    skeletonComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    hideOnScreen: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    excludeFromExport: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    visiblePriority: {
+        type: PropType<"xs" | "sm" | "lg" | "xl" | "md">;
+        default: "xs";
+    };
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    name: {
+        type: PropType<string>;
+        default: string;
+    };
+    formatComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}>;
+    };
+    headerClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    itemClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    width: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * Called when the order of an item has changed. The first parameter
+     * is the row item that was moved. The second parameter is the row item
+     * it was dropped in front of or `null` if it was dropped at the end of
+     * the grid.
+     */
+    onOrderChanged: {
+        type: PropType<(item: Record<string, unknown>, beforeItem: Record<string, unknown> | null) => void | Promise<void> | boolean | Promise<boolean>>;
+        required: false;
+    };
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    field: {
+        type: PropType<string>;
+        required: false;
+    };
+    quickFilterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").QuickFilterValueFunction>;
+        required: false;
+    };
+    sortField: {
+        type: PropType<string>;
+        required: false;
+    };
+    sortValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        required: false;
+    };
+    filter: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
+        required: false;
+    };
+    filterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
+        required: false;
+    };
+    exportValue: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ExportValueFunction>;
+        required: false;
+    };
+    headerComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    skeletonComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    hideOnScreen: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    excludeFromExport: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    visiblePriority: {
+        type: PropType<"xs" | "sm" | "lg" | "xl" | "md">;
+        default: "xs";
+    };
+}>>, {
+    name: string;
+    width: string;
+    headerClass: string;
+    formatComponent: Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>;
+    itemClass: string;
+    visiblePriority: "xs" | "sm" | "lg" | "xl" | "md";
+}>;
+export default _default;

package/types/Controls/Grid/Columns/securityColumn.partial.d.ts

@@ -0,0 +1,196 @@
+import { Component, PropType } from "vue";
+import { IGridState } from "@Obsidian/Types/Controls/grid";
+declare const _default: import("vue").DefineComponent<{
+    name: {
+        type: PropType<string>;
+        default: string;
+    };
+    formatComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}>;
+    };
+    headerClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    itemClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    width: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * The row item title to use when opening the security dialog. If a
+     * plain string is provided it is the field name that contains the
+     * item name. Otherwise it is a function that will be called with the
+     * row and grid state and must return a string.
+     */
+    itemTitle: {
+        type: PropType<string | ((row: Record<string, unknown>, grid: IGridState) => string)>;
+        required: false;
+    };
+    /**
+     * The field to use to determine if the security button for a single
+     * row should be disabled. If the value of this field is `true` then
+     * the security button will be disabled.
+     */
+    disabledField: {
+        type: PropType<string>;
+        default: string;
+    };
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    field: {
+        type: PropType<string>;
+        required: false;
+    };
+    quickFilterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").QuickFilterValueFunction>;
+        required: false;
+    };
+    sortField: {
+        type: PropType<string>;
+        required: false;
+    };
+    sortValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        required: false;
+    };
+    filter: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
+        required: false;
+    };
+    filterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
+        required: false;
+    };
+    exportValue: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ExportValueFunction>;
+        required: false;
+    };
+    headerComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    skeletonComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    hideOnScreen: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    excludeFromExport: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    visiblePriority: {
+        type: PropType<"xs" | "sm" | "lg" | "xl" | "md">;
+        default: "xs";
+    };
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    name: {
+        type: PropType<string>;
+        default: string;
+    };
+    formatComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}>;
+    };
+    headerClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    itemClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    width: {
+        type: PropType<string>;
+        default: string;
+    };
+    /**
+     * The row item title to use when opening the security dialog. If a
+     * plain string is provided it is the field name that contains the
+     * item name. Otherwise it is a function that will be called with the
+     * row and grid state and must return a string.
+     */
+    itemTitle: {
+        type: PropType<string | ((row: Record<string, unknown>, grid: IGridState) => string)>;
+        required: false;
+    };
+    /**
+     * The field to use to determine if the security button for a single
+     * row should be disabled. If the value of this field is `true` then
+     * the security button will be disabled.
+     */
+    disabledField: {
+        type: PropType<string>;
+        default: string;
+    };
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    field: {
+        type: PropType<string>;
+        required: false;
+    };
+    quickFilterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").QuickFilterValueFunction>;
+        required: false;
+    };
+    sortField: {
+        type: PropType<string>;
+        required: false;
+    };
+    sortValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        required: false;
+    };
+    filter: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
+        required: false;
+    };
+    filterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
+        required: false;
+    };
+    exportValue: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ExportValueFunction>;
+        required: false;
+    };
+    headerComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    skeletonComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    hideOnScreen: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    excludeFromExport: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    visiblePriority: {
+        type: PropType<"xs" | "sm" | "lg" | "xl" | "md">;
+        default: "xs";
+    };
+}>>, {
+    name: string;
+    width: string;
+    headerClass: string;
+    disabledField: string;
+    formatComponent: Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>;
+    itemClass: string;
+    visiblePriority: "xs" | "sm" | "lg" | "xl" | "md";
+}>;
+export default _default;

package/types/Controls/Grid/Columns/selectColumn.partial.d.ts

@@ -0,0 +1,157 @@
+import { Component, PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    name: {
+        type: PropType<string>;
+        default: string;
+    };
+    formatComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}>;
+    };
+    headerComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardHeaderCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardHeaderCellProps>>, {}>;
+    };
+    headerClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    itemClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    width: {
+        type: PropType<string>;
+        default: string;
+    };
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    field: {
+        type: PropType<string>;
+        required: false;
+    };
+    quickFilterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").QuickFilterValueFunction>;
+        required: false;
+    };
+    sortField: {
+        type: PropType<string>;
+        required: false;
+    };
+    sortValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        required: false;
+    };
+    filter: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
+        required: false;
+    };
+    filterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
+        required: false;
+    };
+    exportValue: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ExportValueFunction>;
+        required: false;
+    };
+    skeletonComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    hideOnScreen: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    excludeFromExport: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    visiblePriority: {
+        type: PropType<"xs" | "sm" | "lg" | "xl" | "md">;
+        default: "xs";
+    };
+}, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    name: {
+        type: PropType<string>;
+        default: string;
+    };
+    formatComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardCellProps>>, {}>;
+    };
+    headerComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        default: import("vue").DefineComponent<import("@Obsidian/Types/Controls/grid").StandardHeaderCellProps, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<import("@Obsidian/Types/Controls/grid").StandardHeaderCellProps>>, {}>;
+    };
+    headerClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    itemClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    width: {
+        type: PropType<string>;
+        default: string;
+    };
+    title: {
+        type: PropType<string>;
+        required: false;
+    };
+    field: {
+        type: PropType<string>;
+        required: false;
+    };
+    quickFilterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").QuickFilterValueFunction>;
+        required: false;
+    };
+    sortField: {
+        type: PropType<string>;
+        required: false;
+    };
+    sortValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").SortValueFunction>;
+        required: false;
+    };
+    filter: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ColumnFilter>;
+        required: false;
+    };
+    filterValue: {
+        type: PropType<string | import("@Obsidian/Types/Controls/grid").FilterValueFunction>;
+        required: false;
+    };
+    exportValue: {
+        type: PropType<import("@Obsidian/Types/Controls/grid").ExportValueFunction>;
+        required: false;
+    };
+    skeletonComponent: {
+        type: PropType<Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>>;
+        required: false;
+    };
+    hideOnScreen: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    excludeFromExport: {
+        type: PropType<boolean>;
+        required: false;
+    };
+    visiblePriority: {
+        type: PropType<"xs" | "sm" | "lg" | "xl" | "md">;
+        default: "xs";
+    };
+}>>, {
+    name: string;
+    width: string;
+    headerClass: string;
+    formatComponent: Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>;
+    itemClass: string;
+    headerComponent: Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>;
+    visiblePriority: "xs" | "sm" | "lg" | "xl" | "md";
+}>;
+export default _default;