@vuu-ui/vuu-layout 3.3.9 → 3.3.11

package/types/src/use-persistent-state.d.ts

@@ -0,0 +1,8 @@
+export declare const getPersistentState: (id: string) => any;
+export declare const hasPersistentState: (id: string) => boolean;
+export declare const setPersistentState: (id: string, value: any) => Map<string, any>;
+export declare const usePersistentState: () => {
+    loadState: (id: string, key?: string) => any;
+    saveState: (id: string, key: string | undefined, data: unknown) => void;
+    purgeState: (id: string, key?: string) => void;
+};

package/types/src/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./pathUtils";
+export * from "./propUtils";
+export * from "./refUtils";
+export * from "./styleUtils";
+export * from "./typeOf";

package/types/src/utils/pathUtils.d.ts

@@ -0,0 +1,31 @@
+import { LayoutJSON, LayoutModel } from "@vuu-ui/vuu-utils";
+import React, { ReactElement } from "react";
+/**
+ * This is a very specific function at the moment. It resolves a path of the form
+ * '#{componentid}.ACTIVE_CHILD'
+ * It allows a templated path to be resolved to a concrete path at runtime.
+ * The above pattern is used to identify a layout drop target. Further patterns
+ * will be added if needed.
+ */
+export declare const resolvePath: (source: ReactElement, path?: string) => string;
+/**
+ * Similar to resolvePath but operates on a JSON
+ * layout structure and returns the matching JSON node.
+ */
+export declare const resolveJSONPath: (source: LayoutJSON, path?: string) => LayoutJSON | undefined;
+export declare function followPathToParent(source: ReactElement, path: string): ReactElement | null;
+export declare function findTarget(source: LayoutModel | undefined, test: (props: any) => boolean): LayoutModel | undefined;
+export declare function containerOf(source: LayoutModel, target: LayoutModel): LayoutModel | null;
+export declare const getChild: (children: ReactElement[], idx: number) => ReactElement | undefined;
+export declare function followPathToComponent(component: ReactElement, path: string): ReactElement<unknown, string | React.JSXElementConstructor<any>> | undefined;
+export declare function followPath(source: LayoutModel, path: string): LayoutModel | undefined;
+export declare function followPath(source: ReactElement, path: string, throwIfNotFound: true): ReactElement;
+export declare function nextLeaf(root: ReactElement, path: string): any;
+export declare function previousLeaf(root: ReactElement, path: string): any;
+type NextStepResult = {
+    idx: number;
+    finalStep: boolean;
+};
+export declare function nextStep(pathSoFar: string, targetPath: string, followPathToEnd?: boolean): NextStepResult;
+export declare function resetPath(model: ReactElement, path: string, additionalProps?: any): ReactElement;
+export {};

package/types/src/utils/propUtils.d.ts

@@ -0,0 +1,5 @@
+import { ReactElement } from "react";
+import { LayoutModel } from "@vuu-ui/vuu-utils";
+export declare const getProp: (component: LayoutModel | undefined, propName: string) => any;
+export declare const getProps: (component?: LayoutModel) => any;
+export declare const getChildProp: (container: LayoutModel) => ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | undefined;

package/types/src/utils/refUtils.d.ts

@@ -0,0 +1,2 @@
+import { MutableRefObject } from "react";
+export declare function setRef<T>(ref: MutableRefObject<T | null> | ((instance: T | null) => void) | null | undefined, value: T | null): void;

package/types/src/utils/styleUtils.d.ts

@@ -0,0 +1,3 @@
+import { CSSProperties } from 'react';
+export type CSSFlexProperties = Pick<CSSProperties, 'flexBasis' | 'flexGrow' | 'flexShrink'>;
+export declare const expandFlex: (flex: number | CSSFlexProperties) => CSSFlexProperties;

package/types/src/utils/typeOf.d.ts

@@ -0,0 +1,5 @@
+import { LayoutJSON, LayoutModel, WithType } from "@vuu-ui/vuu-utils";
+import { ReactElement } from "react";
+export declare function typeOf(element?: LayoutModel | WithType): string | undefined;
+export declare const isTypeOf: (element: ReactElement, type: string) => boolean;
+export declare const isLayoutJSON: (layout: LayoutJSON) => layout is LayoutJSON;