@breadcoop/ui 1.0.23 → 1.0.28

package/dist/index.d.mts

@@ -1,11 +1,108 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React from 'react';
+import * as viem from 'viem';
+import { Address, Abi, Hex, Chain } from 'viem';
+import React$1, { AnchorHTMLAttributes, FC, ComponentType, ReactNode, ButtonHTMLAttributes } from 'react';
+import * as _tanstack_query_core from '@tanstack/query-core';
+import { UseEnsNameReturnType } from 'wagmi';
+import { GetEnsNameReturnType } from '@wagmi/core';
+import { Icon } from '@phosphor-icons/react';
+import { ClassValue } from 'clsx';
 
-declare function Footer({ className, topClassName, infoClassName }: {
+type App = "fund" | "stacks" | "net";
+
+type AuthProvider = "privy" | "general";
+type TokenConfig = {
+    BREAD: {
+        address: Address;
+        abi: Abi;
+    };
+};
+declare const BreadUIKitProvider: ({ chainId, tokenConfig, children, app, authProvider, }: {
+    chainId: number;
+    tokenConfig: TokenConfig;
+    app: App;
+    authProvider: AuthProvider;
+    children: React.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+type LinkProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
+    href: string;
+    children?: React$1.ReactNode;
+};
+declare const useLinkComponent: () => React$1.ComponentType<LinkProps>;
+declare const LinkProvider: FC<{
+    Link: ComponentType<LinkProps>;
+    children: ReactNode;
+}>;
+
+declare const useBreadBalance: ({ address }: {
+    address: Address;
+}) => {
+    BREAD: string;
+    refetchBalance: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, viem.ReadContractErrorType>>;
+    isLoading: boolean;
+};
+
+interface UseCopyToClipboardPayload {
+    textToCopy: string;
+}
+declare const useCopyToClipboard: ({ textToCopy, }: UseCopyToClipboardPayload) => {
+    copied: boolean;
+    copy: () => Promise<void>;
+};
+
+interface LoginButtonPrivyProps {
+    app: App;
+    status: "CONNECTED" | "LOADING" | "UNSUPPORTED_CHAIN" | "NOT_CONNECTED";
+    label?: string;
+    rightIcon?: ReactNode;
+}
+
+declare const LoginButton: ({ label, ...props }: LoginButtonPrivyProps) => react_jsx_runtime.JSX.Element;
+
+interface CopyButtonProps extends ButtonHTMLAttributes<HTMLButtonElement>, UseCopyToClipboardPayload {
+    checkedIconSize?: number;
+}
+declare const CopyButtonIcon: ({ children, textToCopy, checkedIconSize, ...buttonProps }: CopyButtonProps) => react_jsx_runtime.JSX.Element;
+
+interface ChipProps {
+    size?: "small" | "regular";
+    children: ReactNode;
+    icon?: boolean;
+    className?: string;
+}
+declare const Chip: ({ size, icon, className, children, }: ChipProps) => react_jsx_runtime.JSX.Element;
+
+type TUserLoading = {
+    status: "LOADING";
+};
+type TUserNotConnected = {
+    status: "NOT_CONNECTED";
+};
+type TUserConnected = {
+    status: "CONNECTED" | "UNSUPPORTED_CHAIN";
+    address: Hex;
+    chain: Chain;
+};
+type TConnectedUserState = TUserLoading | TUserNotConnected | TUserConnected;
+
+declare const useConnectedUser: () => {
+    user: TConnectedUserState;
+    isSafe: boolean;
+};
+
+interface IConnectedUserProviderProps {
+    children: ReactNode;
+}
+declare function ConnectedUserProvider({ children }: IConnectedUserProviderProps): react_jsx_runtime.JSX.Element;
+
+interface FooterProps {
     className?: string;
     topClassName?: string;
     infoClassName?: string;
-}): react_jsx_runtime.JSX.Element;
+    mode?: "colored" | "transparent";
+}
+declare function Footer({ className, topClassName, infoClassName, mode, }: FooterProps): react_jsx_runtime.JSX.Element;
 
 type LiftedButtonColors = {
     bg: string;
@@ -61,9 +158,9 @@ declare const LIFTED_BUTTON_PRESETS: {
 };
 
 type LiftedButtonProps = {
-    children: React.ReactNode;
-    leftIcon?: React.ReactNode;
-    rightIcon?: React.ReactNode;
+    children: React$1.ReactNode;
+    leftIcon?: React$1.ReactNode;
+    rightIcon?: React$1.ReactNode;
     disabled?: boolean;
     preset?: LiftedButtonPreset;
     colorOverrides?: Partial<LiftedButtonColors>;
@@ -72,7 +169,7 @@ type LiftedButtonProps = {
     className?: string;
     width?: "full" | "auto" | "mobile-full";
     scrollTo?: string;
-} & React.ComponentPropsWithoutRef<"button">;
+} & React$1.ComponentPropsWithoutRef<"button">;
 /**
  * LiftedButton — a square-edged button that floats up-left of a dark base layer.
  * - Preset: Choose "primary" (default), "secondary", "destructive", or "positive"
@@ -88,41 +185,53 @@ declare const fontVariables: {
     readonly breadDisplay: "--font-breadDisplay";
     readonly breadBody: "--font-breadBody";
 };
-declare const Typography: React.FC<{
+declare const Typography: React$1.FC<{
     variant: "h1" | "h2" | "h3" | "h4" | "h5" | "body" | "caption";
-    children: React.ReactNode;
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading1: React.FC<{
-    children: React.ReactNode;
+declare const Heading1: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading2: React.FC<{
-    children: React.ReactNode;
+declare const Heading2: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading3: React.FC<{
-    children: React.ReactNode;
+declare const Heading3: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading4: React.FC<{
-    children: React.ReactNode;
+declare const Heading4: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading5: React.FC<{
-    children: React.ReactNode;
+declare const Heading5: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Body: React.FC<{
-    children: React.ReactNode;
+declare const Body: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
     bold?: boolean;
 }>;
-declare const Caption: React.FC<{
-    children: React.ReactNode;
+declare const Caption: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
 
+interface FormattedDecimalNumberProps {
+    value: number | string;
+    className?: string;
+    integralPartClassName?: string;
+    decimalPartClassName?: string;
+    withBreadIcon?: boolean;
+    breadIconClassName?: string;
+    breadSize?: number;
+    unit?: string;
+}
+declare function FormattedDecimalNumber({ value, className, integralPartClassName, decimalPartClassName, withBreadIcon, breadIconClassName, breadSize, unit, }: FormattedDecimalNumberProps): react_jsx_runtime.JSX.Element;
+
 type LogoColor = "orange" | "blue" | "jade" | "white";
 type LogoVariant = "square" | "line";
 type LogoProps = {
@@ -136,7 +245,7 @@ type LogoProps = {
     variant?: LogoVariant;
     /** Optional text to display next to the logo */
     text?: string;
-} & React.ComponentPropsWithoutRef<"svg">;
+} & React$1.ComponentPropsWithoutRef<"svg">;
 /**
  * Logo component that renders the Bread UI Kit logo SVG.
  *
@@ -148,4 +257,48 @@ type LogoProps = {
  */
 declare function Logo({ size, className, color, variant, text, ...rest }: LogoProps): react_jsx_runtime.JSX.Element | undefined;
 
-export { Body, Caption, Footer, Heading1, Heading2, Heading3, Heading4, Heading5, LiftedButton, type LiftedButtonProps, Logo, type LogoColor, type LogoProps, type LogoVariant, Typography, fontVariables };
+interface NavSolidarityAppsProps {
+    current?: App;
+    className?: string;
+    showTitle?: boolean;
+    showSelected?: boolean;
+    rearranged?: boolean;
+}
+declare const NavSolidarityApps: ({ current, className, showTitle, showSelected, rearranged, }: NavSolidarityAppsProps) => react_jsx_runtime.JSX.Element;
+declare const NavSolidarityAppsDesktop: ({ label, app, }: {
+    app: App;
+    label: string;
+}) => react_jsx_runtime.JSX.Element;
+
+interface NavAccountDetailsProps {
+    userAddress: Address;
+    ensNameResult: UseEnsNameReturnType<GetEnsNameReturnType> | {
+        data: string | undefined;
+        isLoading: boolean;
+        isError: boolean;
+    };
+    className?: string;
+    app: App;
+    widgetItems?: ReactNode;
+    actionItems?: ReactNode;
+}
+
+interface NavbarProps extends Pick<NavAccountDetailsProps, "widgetItems" | "actionItems"> {
+    app: App;
+    children: ReactNode;
+    className?: string;
+}
+declare function Navbar({ app, children, className, widgetItems, actionItems }: NavbarProps): react_jsx_runtime.JSX.Element;
+
+declare const NavAccountWidgetItem: ({ I, label, children, appIconColor, }: {
+    I: Icon;
+    appIconColor: string;
+    label: string;
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+declare function cn(...inputs: ClassValue[]): string;
+
+declare function formatBalance(value: number, decimals?: number): string;
+
+export { Body, BreadUIKitProvider, Caption, Chip, ConnectedUserProvider, CopyButtonIcon, Footer, FormattedDecimalNumber, Heading1, Heading2, Heading3, Heading4, Heading5, LiftedButton, type LiftedButtonProps, type LinkProps, LinkProvider, LoginButton, Logo, type LogoColor, type LogoProps, type LogoVariant, NavAccountWidgetItem, NavSolidarityApps, NavSolidarityAppsDesktop, Navbar, type TConnectedUserState, type TUserConnected, type TUserLoading, type TUserNotConnected, Typography, cn, fontVariables, formatBalance, useBreadBalance, useConnectedUser, useCopyToClipboard, useLinkComponent };

package/dist/index.d.ts

@@ -1,11 +1,108 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React from 'react';
+import * as viem from 'viem';
+import { Address, Abi, Hex, Chain } from 'viem';
+import React$1, { AnchorHTMLAttributes, FC, ComponentType, ReactNode, ButtonHTMLAttributes } from 'react';
+import * as _tanstack_query_core from '@tanstack/query-core';
+import { UseEnsNameReturnType } from 'wagmi';
+import { GetEnsNameReturnType } from '@wagmi/core';
+import { Icon } from '@phosphor-icons/react';
+import { ClassValue } from 'clsx';
 
-declare function Footer({ className, topClassName, infoClassName }: {
+type App = "fund" | "stacks" | "net";
+
+type AuthProvider = "privy" | "general";
+type TokenConfig = {
+    BREAD: {
+        address: Address;
+        abi: Abi;
+    };
+};
+declare const BreadUIKitProvider: ({ chainId, tokenConfig, children, app, authProvider, }: {
+    chainId: number;
+    tokenConfig: TokenConfig;
+    app: App;
+    authProvider: AuthProvider;
+    children: React.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+type LinkProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
+    href: string;
+    children?: React$1.ReactNode;
+};
+declare const useLinkComponent: () => React$1.ComponentType<LinkProps>;
+declare const LinkProvider: FC<{
+    Link: ComponentType<LinkProps>;
+    children: ReactNode;
+}>;
+
+declare const useBreadBalance: ({ address }: {
+    address: Address;
+}) => {
+    BREAD: string;
+    refetchBalance: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<bigint, viem.ReadContractErrorType>>;
+    isLoading: boolean;
+};
+
+interface UseCopyToClipboardPayload {
+    textToCopy: string;
+}
+declare const useCopyToClipboard: ({ textToCopy, }: UseCopyToClipboardPayload) => {
+    copied: boolean;
+    copy: () => Promise<void>;
+};
+
+interface LoginButtonPrivyProps {
+    app: App;
+    status: "CONNECTED" | "LOADING" | "UNSUPPORTED_CHAIN" | "NOT_CONNECTED";
+    label?: string;
+    rightIcon?: ReactNode;
+}
+
+declare const LoginButton: ({ label, ...props }: LoginButtonPrivyProps) => react_jsx_runtime.JSX.Element;
+
+interface CopyButtonProps extends ButtonHTMLAttributes<HTMLButtonElement>, UseCopyToClipboardPayload {
+    checkedIconSize?: number;
+}
+declare const CopyButtonIcon: ({ children, textToCopy, checkedIconSize, ...buttonProps }: CopyButtonProps) => react_jsx_runtime.JSX.Element;
+
+interface ChipProps {
+    size?: "small" | "regular";
+    children: ReactNode;
+    icon?: boolean;
+    className?: string;
+}
+declare const Chip: ({ size, icon, className, children, }: ChipProps) => react_jsx_runtime.JSX.Element;
+
+type TUserLoading = {
+    status: "LOADING";
+};
+type TUserNotConnected = {
+    status: "NOT_CONNECTED";
+};
+type TUserConnected = {
+    status: "CONNECTED" | "UNSUPPORTED_CHAIN";
+    address: Hex;
+    chain: Chain;
+};
+type TConnectedUserState = TUserLoading | TUserNotConnected | TUserConnected;
+
+declare const useConnectedUser: () => {
+    user: TConnectedUserState;
+    isSafe: boolean;
+};
+
+interface IConnectedUserProviderProps {
+    children: ReactNode;
+}
+declare function ConnectedUserProvider({ children }: IConnectedUserProviderProps): react_jsx_runtime.JSX.Element;
+
+interface FooterProps {
     className?: string;
     topClassName?: string;
     infoClassName?: string;
-}): react_jsx_runtime.JSX.Element;
+    mode?: "colored" | "transparent";
+}
+declare function Footer({ className, topClassName, infoClassName, mode, }: FooterProps): react_jsx_runtime.JSX.Element;
 
 type LiftedButtonColors = {
     bg: string;
@@ -61,9 +158,9 @@ declare const LIFTED_BUTTON_PRESETS: {
 };
 
 type LiftedButtonProps = {
-    children: React.ReactNode;
-    leftIcon?: React.ReactNode;
-    rightIcon?: React.ReactNode;
+    children: React$1.ReactNode;
+    leftIcon?: React$1.ReactNode;
+    rightIcon?: React$1.ReactNode;
     disabled?: boolean;
     preset?: LiftedButtonPreset;
     colorOverrides?: Partial<LiftedButtonColors>;
@@ -72,7 +169,7 @@ type LiftedButtonProps = {
     className?: string;
     width?: "full" | "auto" | "mobile-full";
     scrollTo?: string;
-} & React.ComponentPropsWithoutRef<"button">;
+} & React$1.ComponentPropsWithoutRef<"button">;
 /**
  * LiftedButton — a square-edged button that floats up-left of a dark base layer.
  * - Preset: Choose "primary" (default), "secondary", "destructive", or "positive"
@@ -88,41 +185,53 @@ declare const fontVariables: {
     readonly breadDisplay: "--font-breadDisplay";
     readonly breadBody: "--font-breadBody";
 };
-declare const Typography: React.FC<{
+declare const Typography: React$1.FC<{
     variant: "h1" | "h2" | "h3" | "h4" | "h5" | "body" | "caption";
-    children: React.ReactNode;
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading1: React.FC<{
-    children: React.ReactNode;
+declare const Heading1: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading2: React.FC<{
-    children: React.ReactNode;
+declare const Heading2: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading3: React.FC<{
-    children: React.ReactNode;
+declare const Heading3: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading4: React.FC<{
-    children: React.ReactNode;
+declare const Heading4: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Heading5: React.FC<{
-    children: React.ReactNode;
+declare const Heading5: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
-declare const Body: React.FC<{
-    children: React.ReactNode;
+declare const Body: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
     bold?: boolean;
 }>;
-declare const Caption: React.FC<{
-    children: React.ReactNode;
+declare const Caption: React$1.FC<{
+    children: React$1.ReactNode;
     className?: string;
 }>;
 
+interface FormattedDecimalNumberProps {
+    value: number | string;
+    className?: string;
+    integralPartClassName?: string;
+    decimalPartClassName?: string;
+    withBreadIcon?: boolean;
+    breadIconClassName?: string;
+    breadSize?: number;
+    unit?: string;
+}
+declare function FormattedDecimalNumber({ value, className, integralPartClassName, decimalPartClassName, withBreadIcon, breadIconClassName, breadSize, unit, }: FormattedDecimalNumberProps): react_jsx_runtime.JSX.Element;
+
 type LogoColor = "orange" | "blue" | "jade" | "white";
 type LogoVariant = "square" | "line";
 type LogoProps = {
@@ -136,7 +245,7 @@ type LogoProps = {
     variant?: LogoVariant;
     /** Optional text to display next to the logo */
     text?: string;
-} & React.ComponentPropsWithoutRef<"svg">;
+} & React$1.ComponentPropsWithoutRef<"svg">;
 /**
  * Logo component that renders the Bread UI Kit logo SVG.
  *
@@ -148,4 +257,48 @@ type LogoProps = {
  */
 declare function Logo({ size, className, color, variant, text, ...rest }: LogoProps): react_jsx_runtime.JSX.Element | undefined;
 
-export { Body, Caption, Footer, Heading1, Heading2, Heading3, Heading4, Heading5, LiftedButton, type LiftedButtonProps, Logo, type LogoColor, type LogoProps, type LogoVariant, Typography, fontVariables };
+interface NavSolidarityAppsProps {
+    current?: App;
+    className?: string;
+    showTitle?: boolean;
+    showSelected?: boolean;
+    rearranged?: boolean;
+}
+declare const NavSolidarityApps: ({ current, className, showTitle, showSelected, rearranged, }: NavSolidarityAppsProps) => react_jsx_runtime.JSX.Element;
+declare const NavSolidarityAppsDesktop: ({ label, app, }: {
+    app: App;
+    label: string;
+}) => react_jsx_runtime.JSX.Element;
+
+interface NavAccountDetailsProps {
+    userAddress: Address;
+    ensNameResult: UseEnsNameReturnType<GetEnsNameReturnType> | {
+        data: string | undefined;
+        isLoading: boolean;
+        isError: boolean;
+    };
+    className?: string;
+    app: App;
+    widgetItems?: ReactNode;
+    actionItems?: ReactNode;
+}
+
+interface NavbarProps extends Pick<NavAccountDetailsProps, "widgetItems" | "actionItems"> {
+    app: App;
+    children: ReactNode;
+    className?: string;
+}
+declare function Navbar({ app, children, className, widgetItems, actionItems }: NavbarProps): react_jsx_runtime.JSX.Element;
+
+declare const NavAccountWidgetItem: ({ I, label, children, appIconColor, }: {
+    I: Icon;
+    appIconColor: string;
+    label: string;
+    children: ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+declare function cn(...inputs: ClassValue[]): string;
+
+declare function formatBalance(value: number, decimals?: number): string;
+
+export { Body, BreadUIKitProvider, Caption, Chip, ConnectedUserProvider, CopyButtonIcon, Footer, FormattedDecimalNumber, Heading1, Heading2, Heading3, Heading4, Heading5, LiftedButton, type LiftedButtonProps, type LinkProps, LinkProvider, LoginButton, Logo, type LogoColor, type LogoProps, type LogoVariant, NavAccountWidgetItem, NavSolidarityApps, NavSolidarityAppsDesktop, Navbar, type TConnectedUserState, type TUserConnected, type TUserLoading, type TUserNotConnected, Typography, cn, fontVariables, formatBalance, useBreadBalance, useConnectedUser, useCopyToClipboard, useLinkComponent };