@coinbase/cdp-react 0.0.98 → 0.0.99

package/dist/icons/IconCoinbaseWordmark.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Coinbase Wordmark icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Coinbase Wordmark icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconCoinbaseWordmark />
+ *   Coinbase
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconCoinbaseWordmark aria-label="Coinbase" />
+ * </p>
+ * ```
+ */
 export declare const IconCoinbaseWordmark: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconCopy.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Copy icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The copy icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx
+ * // Icon is correctly hidden from screen readers
+ * <button type="button" onClick={handleClick}>
+ *   <IconCopy />
+ *   Copy address
+ * </button>
+ *
+ * // Icon with screen-reader accessible label only
+ * <button type="button" onClick={handleClick}>
+ *   <IconCopy aria-label="Copy address" />
+ * </button>
+ * ```
+ */
 export declare const IconCopy: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconCreditCard.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Credit card icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The credit card icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconCreditCard />
+ *   Pay with Debit Card
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconCreditCard aria-label="Pay with Debit Card" />
+ * </p>
+ * ```
+ */
 export declare const IconCreditCard: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconCurrencies.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Currencies icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The currencies icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconCurrencies />
+ *   Waiting for payment
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconCurrencies aria-label="Waiting for payment" />
+ * </p>
+ * ```
+ */
 export declare const IconCurrencies: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconEnvelope.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Envelope icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Envelope icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconEnvelope />
+ *   Email me a code
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconEnvelope aria-label="Email me a code" />
+ * </p>
+ * ```
+ */
 export declare const IconEnvelope: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconExclamationCircle.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Exclamation Circle icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Exclamation Circle icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconExclamationCircle />
+ *   Warning!
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconExclamationCircle aria-label="Warning" />
+ * </p>
+ * ```
+ */
 export declare const IconExclamationCircle: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconExclamationTriangle.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Exclamation Triangle icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Exclamation Triangle icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconExclamationTriangle />
+ *   Warning!
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconExclamationTriangle aria-label="Warning" />
+ * </p>
+ * ```
+ */
 export declare const IconExclamationTriangle: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconGoogleColorLogo.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Colored Google logo icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Google logo icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconGoogleColorLogo />
+ *   Google
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconGoogleColorLogo aria-label="Google" />
+ * </p>
+ * ```
+ */
 export declare const IconGoogleColorLogo: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconGoogleLogo.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Google logo icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Google logo icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconGoogleLogo />
+ *   Google
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconGoogleLogo aria-label="Google" />
+ * </p>
+ * ```
+ */
 export declare const IconGoogleLogo: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconLock.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Lock icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Lock icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconLock />
+ *   Locked
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconLock aria-label="locked" />
+ * </p>
+ * ```
+ */
 export declare const IconLock: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconMinus.d.ts

@@ -1,2 +1,23 @@
 import { SVGProps } from 'react';
+/**
+ * Minus icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Minus icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconMinus />
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconMinus aria-label="Minus" />
+ * </p>
+ * ```
+ */
 export declare const IconMinus: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconPhone.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Phone icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The chat bubble icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconPhone />
+ *   Text me a code
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconPhone aria-label="Text me a code" />
+ * </p>
+ * ```
+ */
 export declare const IconPhone: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconPinCode.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Pin code icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The chat bubble icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconPinCode />
+ *   Enter code from your authenticator app
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconPinCode aria-label="Enter code from your authenticator app" />
+ * </p>
+ * ```
+ */
 export declare const IconPinCode: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconPlus.d.ts

@@ -1,2 +1,23 @@
 import { SVGProps } from 'react';
+/**
+ * Plus icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Plus icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconPlus />
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconPlus aria-label="Plus" />
+ * </p>
+ * ```
+ */
 export declare const IconPlus: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconShield.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Shield icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The chat bubble icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconShield />
+ *   Secure your account
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconShield aria-label="Secure your account" />
+ * </p>
+ * ```
+ */
 export declare const IconShield: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconSmartPhone.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Smart phone icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The chat bubble icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconSmartPhone />
+ *   Enter code from your authenticator app
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconSmartPhone aria-label="Enter code from your authenticator app" />
+ * </p>
+ * ```
+ */
 export declare const IconSmartPhone: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconTelegramLogo.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Telegram logo icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Telegram logo icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconTelegramLogo />
+ *   Telegram
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconTelegramLogo aria-label="Telegram" />
+ * </p>
+ * ```
+ */
 export declare const IconTelegramLogo: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconXLogo.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * X logo icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The X logo icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly hidden from screen readers
+ * <p>
+ *   <IconXLogo />
+ *   X
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconXLogo aria-label="X" />
+ * </p>
+ * ```
+ */
 export declare const IconXLogo: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/IconXMark.d.ts

@@ -1,2 +1,24 @@
 import { SVGProps } from 'react';
+/**
+ * Close icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} The Close icon.
+ *
+ * @group Components
+ *
+ * @example
+ * ```tsx lines
+ * // Icon is correctly from screen readers
+ * <p>
+ *   <IconXMark />
+ *   Close
+ * </p>
+ *
+ * // Icon with screen-reader accessible label only
+ * <p>
+ *   <IconXMark aria-label="Close" />
+ * </p>
+ * ```
+ */
 export declare const IconXMark: (props: Omit<SVGProps<SVGSVGElement>, "viewBox">) => import("react/jsx-runtime").JSX.Element;

package/dist/icons/SvgIcon.d.ts

@@ -1,4 +1,10 @@
 import { ReactNode, SVGProps } from 'react';
+/**
+ * Base SVG icon component.
+ *
+ * @param {SVGProps<SVGSVGElement>} props - The props for the icon.
+ * @returns {JSX.Element} An svg icon component.
+ */
 export declare const SvgIcon: ({ children, ...props }: SVGProps<SVGSVGElement> & {
     children: ReactNode;
 }) => import("react/jsx-runtime").JSX.Element;

package/dist/theme/cssVariables.d.ts

@@ -1,4 +1,14 @@
+/**
+ * The CSS variables for the theme.
+ *
+ * This is the theme object with a namespace added to the keys (`--cdp-web-`).
+ *
+ * @see {@link theme} for the theme object
+ */
 export declare const cssVariables: import('./utils').CDPWebCSSVariables;
+/**
+ * This is exported for the "stylelint-value-no-unknown-custom-properties" plugin
+ */
 declare const _default: {
     customProperties: import('./utils').CDPWebCSSVariables;
 };