@xyo-network/react-shared 2.81.10 → 2.83.0

package/dist/browser/index.d.ts

@@ -1,7 +1,320 @@
-export * from './components/index.js';
-export * from './contexts/index.js';
-export * from './hooks/index.js';
-export * from './lib/index.js';
-export * from './models/index.js';
-export * from './SizeProp.js';
-//# sourceMappingURL=index.d.ts.map
+import { TypographyProps, BoxProps, TypographyTypeMap, StackProps, ListItemButtonProps, AlertProps, TableCellProps, AvatarProps, AvatarGroupProps, PaperProps, CardHeaderProps, SvgIconProps } from '@mui/material';
+export { useMediaQuery } from '@mui/material';
+import * as React from 'react';
+import React__default, { ReactElement, ReactNode, Component, ErrorInfo, PropsWithChildren, Context, Dispatch, SetStateAction, CSSProperties, ForwardedRef } from 'react';
+import * as _xylabs_react_flexbox from '@xylabs/react-flexbox';
+import { FlexBoxProps } from '@xylabs/react-flexbox';
+import { WithChildren } from '@xylabs/react-shared';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { To, NavigateOptions } from 'react-router-dom';
+import { Hash } from '@xylabs/hex';
+import * as _mui_styles from '@mui/styles';
+import { Payload } from '@xyo-network/payload-model';
+export { usePromise } from '@xylabs/react-promise';
+
+declare const Ampersand: React__default.FC<TypographyProps>;
+
+interface BasicHeroProps extends FlexBoxProps {
+    backgroundColor?: string;
+    backgroundImage?: string;
+    button1Href?: string;
+    button1Text?: string;
+    button1To?: string;
+    button2Href?: string;
+    button2Text?: string;
+    button2To?: string;
+    desc: string;
+    gradientTitle?: string;
+    heroImage?: string;
+    subLinkIcon?: ReactElement;
+    subLinkPath?: string;
+    subLinkText1?: string;
+    subLinkText2?: string;
+    sx?: Record<string, string>;
+    textColor?: string;
+    title: string;
+    title2?: string;
+}
+declare const BasicHero: React__default.FC<BasicHeroProps>;
+
+interface EllipsizeRootProps extends BoxProps {
+    beforeLineHeight?: string | number;
+}
+type TypographyWithComponentProps<D extends React__default.ElementType = TypographyTypeMap['defaultComponent'], P = {}> = TypographyProps<D, P> & {
+    ellipsisPosition?: 'start' | 'end';
+};
+interface EllipsizeBoxProps extends BoxProps {
+    disableSharedRef?: boolean;
+    ellipsisPosition?: 'start' | 'end';
+    typographyProps?: TypographyWithComponentProps;
+}
+declare const EllipsizeBox: React__default.ForwardRefExoticComponent<Omit<WithChildren<EllipsizeBoxProps>, "ref"> & React__default.RefAttributes<HTMLDivElement>>;
+
+interface ErrorBoundaryProps {
+    children: ReactNode;
+    fallback?: ReactNode;
+    fallbackWithError?: (error: Error) => ReactNode;
+    scope?: string;
+}
+interface ErrorBoundaryState {
+    error?: Error;
+}
+declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
+    constructor(props: ErrorBoundaryProps);
+    static getDerivedStateFromError(error: Error): {
+        error: Error;
+    };
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | boolean | react_jsx_runtime.JSX.Element | Iterable<React__default.ReactNode> | null | undefined;
+}
+
+interface LabeledTextFieldWrapperProps extends StackProps {
+    label: string;
+}
+declare const LabeledTextFieldWrapper: React__default.FC<LabeledTextFieldWrapperProps>;
+
+interface ListItemButtonExProps extends ListItemButtonProps {
+    target?: string;
+    to?: To;
+    toOptions?: NavigateOptions;
+}
+declare const ListItemButtonExTo: React__default.FC<ListItemButtonExProps>;
+declare const ListItemButtonEx: React__default.FC<ListItemButtonExProps>;
+
+interface LoadResultProps<T> {
+    apiError?: Error;
+    error?: boolean;
+    notFound: boolean;
+    searchResult: T | undefined;
+}
+declare function LoadResult<T>(props: PropsWithChildren<LoadResultProps<T>>): react_jsx_runtime.JSX.Element;
+
+declare const NotFound: React__default.FC<FlexBoxProps>;
+
+declare const Pipe: React__default.FC<TypographyProps>;
+
+interface PayloadDataMissingProps extends AlertProps {
+    alertBody?: string;
+}
+declare const PayloadDataMissing: React__default.FC<PayloadDataMissingProps>;
+
+declare const ScrollTableOnSm: React__default.FC<WithChildren>;
+
+declare const SectionSpacingRow: React__default.ForwardRefExoticComponent<_xylabs_react_flexbox.BusyBoxProps & React__default.RefAttributes<HTMLDivElement>>;
+
+interface EllipsisTableCellProps extends Omit<TableCellProps, 'ref'> {
+    href?: string;
+    link?: boolean;
+    to?: To;
+    value?: string;
+    width?: string | number;
+}
+declare const EllipsisTableCellWithRef: React__default.ForwardRefExoticComponent<EllipsisTableCellProps & React__default.RefAttributes<HTMLElement>>;
+declare const EllipsisTableCell: React__default.ForwardRefExoticComponent<EllipsisTableCellProps & React__default.RefAttributes<HTMLElement>>;
+
+interface AddressTableCellProps extends Omit<EllipsisTableCellProps, 'ref'> {
+    archive?: string;
+    exploreDomain?: string;
+    link?: boolean;
+}
+declare const AddressTableCell: React__default.ForwardRefExoticComponent<AddressTableCellProps & React__default.RefAttributes<HTMLElement>>;
+
+interface HashTableCellProps extends EllipsisTableCellProps {
+    archive?: string;
+    dataType?: 'block' | 'payload';
+    exploreDomain?: string;
+    network?: string;
+    onHashClick?: (value: Hash) => void;
+}
+declare const HashTableCell: React__default.FC<HashTableCellProps>;
+
+declare const ThemeTokenAvatar: React__default.FC<AvatarProps>;
+
+interface ThemeTokenAvatarGroupProps extends AvatarGroupProps {
+    images?: string[];
+}
+declare const ThemeTokenAvatarGroup: React__default.FC<ThemeTokenAvatarGroupProps>;
+
+interface TokenBarProps extends PaperProps {
+    text1?: ReactNode;
+    text1Props?: TypographyProps;
+    text1Suffix?: ReactNode;
+    text2?: ReactNode;
+    text2Props?: TypographyProps;
+    text2Suffix?: ReactNode;
+}
+declare const TokenBar: React__default.FC<TokenBarProps>;
+
+interface TokenData {
+    coinmarketcapLink: string;
+    etherscanLink: string;
+    icon: string;
+    readableName: string;
+    tokenSymbol: string;
+    uniqueTokenId: string;
+}
+declare const TokenData: TokenData[];
+
+declare const useGetTokenData: (symbols: (string | undefined)[]) => TokenData[];
+
+interface TokenSummaryProps extends CardHeaderProps {
+    icon?: string;
+    imgBgProps?: AvatarProps;
+    symbol?: string;
+    symbolElement?: ReactNode;
+}
+declare const TokenSummary: React__default.FC<TokenSummaryProps>;
+
+interface TypographyExProps extends TypographyProps {
+    gradient?: 'text';
+}
+declare const TypographyEx: React__default.FC<TypographyExProps>;
+
+type EmptyObject = {};
+type ContextExProviderProps<T extends EmptyObject = EmptyObject> = WithChildren<{
+    required?: boolean;
+} & T>;
+
+interface ContextExState {
+    provided: boolean;
+}
+
+declare const createContextEx: <T>() => React.Context<T & ContextExState>;
+
+declare const useContextEx: <T extends ContextExState>(context: Context<T>, contextName: string, required?: boolean) => Omit<T, "provided">;
+declare const useProvided: <T extends ContextExState>(context: Context<T>) => boolean;
+
+declare const ResolvedDivinerContext: <T>() => React.Context<T & ContextExState>;
+
+interface ResolvedDivinerState<T> extends ContextExState {
+    diviner?: T;
+    setDiviner?: Dispatch<SetStateAction<T | undefined>>;
+}
+
+interface DivinerProviderProps<D> extends ContextExProviderProps, WithChildren {
+    context: Context<ResolvedDivinerState<D>>;
+    diviner?: D;
+}
+declare const ResolvedDivinerProvider: <D>({ diviner: divinerProp, required, children, context }: DivinerProviderProps<D>) => react_jsx_runtime.JSX.Element;
+
+type ListMode = 'table' | 'grid' | 'default';
+
+interface ListModeContextState extends ContextExState {
+    listMode: ListMode;
+    setListMode?: Dispatch<ListMode>;
+}
+
+declare const ListModeContext: React.Context<ListModeContextState & ContextExState>;
+
+interface ListModeProviderProps {
+    defaultListMode?: ListMode;
+}
+declare const ListModeProvider: React__default.FC<WithChildren<ListModeProviderProps>>;
+
+declare const useListMode: (required?: boolean) => Omit<ListModeContextState & ContextExState, "provided">;
+
+interface GradientStyles {
+    background: CSSProperties;
+    border: CSSProperties;
+    heading: CSSProperties;
+}
+declare const colorfulGradientLightMode: () => {
+    background: {
+        backgroundImage: string;
+    };
+    border: {
+        borderImage: string;
+        borderImageSlice: number;
+        borderImageSource: string;
+        borderRadius: number;
+        borderStyle: string;
+        borderWidth: string;
+    };
+    heading: {
+        WebkitBackgroundClip: string;
+        WebkitTextFillColor: string;
+        background: string;
+        display: string;
+    };
+};
+declare const colorfulGradientDarkMode: () => {
+    background: {
+        backgroundImage: string;
+    };
+    border: {
+        borderImage: string;
+        borderImageSlice: number;
+        borderImageSource: string;
+        borderRadius: number;
+        borderStyle: string;
+        borderWidth: string;
+    };
+    heading: {
+        WebkitBackgroundClip: string;
+        WebkitTextFillColor: string;
+        background: string;
+        display: string;
+    };
+};
+declare const useGradientStyles: () => {
+    classes: (props?: any) => _mui_styles.ClassNameMap<"border" | "background" | "heading">;
+    styles: {
+        background: {
+            backgroundImage: string;
+        };
+        border: {
+            borderImage: string;
+            borderImageSlice: number;
+            borderImageSource: string;
+            borderRadius: number;
+            borderStyle: string;
+            borderWidth: string;
+        };
+        heading: {
+            WebkitBackgroundClip: string;
+            WebkitTextFillColor: string;
+            background: string;
+            display: string;
+        };
+    };
+};
+
+declare const useDataState: <T>(defaultValue: T | undefined) => [T | undefined, Dispatch<SetStateAction<T | undefined>>];
+
+declare const useIsMobile: () => boolean;
+declare const useIsSmall: () => boolean;
+
+declare const usePayloadHash: <TPayload extends Payload>(payload: TPayload | undefined | null) => Lowercase<string> | undefined;
+declare const usePayloadHashes: <TPayload extends Payload>(payloads: TPayload[] | undefined | null) => [TPayload, Lowercase<string>][] | undefined;
+
+declare const useShareForwardedRef: <T>(forwardedRef: ForwardedRef<T>, refresh?: number) => React.RefObject<T>;
+
+declare const assertDefinedEx: <T>(expr?: T | null, message?: string) => T;
+
+declare const parseMeausureString: (measure?: string, absolute?: number) => number | undefined;
+declare const parsePadding: (padding: string) => {
+    bottom: string;
+    left: string;
+    right: string;
+    top: string;
+} | {
+    bottom: string;
+    right: string;
+    top: string;
+    left?: undefined;
+} | undefined;
+declare const getActualPaddingX: (element: HTMLElement) => number;
+
+type NetworkComponentSlug = 'sentinel' | 'bridge' | 'archivist' | 'diviner' | 'node' | 'witness';
+interface NetworkComponentDetails {
+    icon: (props?: SvgIconProps) => ReactElement;
+    name: string;
+    slug: NetworkComponentSlug;
+}
+declare const networkComponents: NetworkComponentDetails[];
+declare const findNetworkComponentIndex: (slug: string) => number;
+declare const findNetworkComponent: (slug: string) => NetworkComponentDetails | undefined;
+
+type SizeProp = 'small' | 'medium' | 'large';
+
+export { AddressTableCell, type AddressTableCellProps, Ampersand, BasicHero, type BasicHeroProps, type ContextExProviderProps, type ContextExState, type DivinerProviderProps, EllipsisTableCell, type EllipsisTableCellProps, EllipsisTableCellWithRef, EllipsizeBox, type EllipsizeBoxProps, type EllipsizeRootProps, type EmptyObject, ErrorBoundary, type ErrorBoundaryProps, type ErrorBoundaryState, type GradientStyles, HashTableCell, type HashTableCellProps, LabeledTextFieldWrapper, type LabeledTextFieldWrapperProps, ListItemButtonEx, type ListItemButtonExProps, ListItemButtonExTo, type ListMode, ListModeContext, type ListModeContextState, ListModeProvider, type ListModeProviderProps, LoadResult, type LoadResultProps, type NetworkComponentDetails, type NetworkComponentSlug, NotFound, PayloadDataMissing, type PayloadDataMissingProps, Pipe, ResolvedDivinerContext, ResolvedDivinerProvider, type ResolvedDivinerState, ScrollTableOnSm, SectionSpacingRow, type SizeProp, ThemeTokenAvatar, ThemeTokenAvatarGroup, type ThemeTokenAvatarGroupProps, TokenBar, type TokenBarProps, TokenData, TokenSummary, type TokenSummaryProps, TypographyEx, type TypographyExProps, type TypographyWithComponentProps, assertDefinedEx, colorfulGradientDarkMode, colorfulGradientLightMode, createContextEx, findNetworkComponent, findNetworkComponentIndex, getActualPaddingX, networkComponents, parseMeausureString, parsePadding, useContextEx, useDataState, useGetTokenData, useGradientStyles, useIsMobile, useIsSmall, useListMode, usePayloadHash, usePayloadHashes, useProvided, useShareForwardedRef };