@openreceive/react 0.3.1 → 0.3.3

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { CheckoutComponentProps, CheckoutState, QrEncoder, BrowserLoggerOption, CheckoutStatusRefresh, Status, SwapRefundStaging, CheckoutSnapshot, AssetUrlResolver, BrowserLogContext, CheckoutInvoiceSnapshot, ThemePreference, ResolvedTheme, ThemeModel, CheckoutPhase, CheckoutStatusModel, UnixSeconds, BrowserLogger, TransactionDetailsSource } from '@openreceive/browser/headless';
+import { CheckoutComponentProps, CheckoutState, QrEncoder, BrowserLoggerOption, CheckoutStatusRefresh, Status, SwapRefundStaging, CheckoutSnapshot, AssetUrlResolver, ThemePreference, BrowserLogContext, CheckoutInvoiceSnapshot, ResolvedTheme, ThemeModel, CheckoutPhase, CheckoutStatusModel, UnixSeconds, BrowserLogger, TransactionDetailsSource } from '@openreceive/browser/headless';
 export { TransactionDetailsSource, resolveTransactionDetailRows } from '@openreceive/browser/headless';
 
 interface CheckoutData {
@@ -164,11 +164,23 @@ interface CheckoutProps extends CheckoutComponentProps, CheckoutEventHandlers, O
     readonly children?: CheckoutChildren;
     /** Passed through to the payment wizard. See {@link PaymentWizardProps.resolveAssetUrl}. */
     readonly resolveAssetUrl?: AssetUrlResolver;
+    /**
+     * Lock the checkout to one theme. Wins over the stored preference and any
+     * ancestor ThemeScope, and hides the toggle: a host embedding the checkout in
+     * a page that is already dark passes `theme="dark"` and is done. `"system"`
+     * locks to `prefers-color-scheme`, ignoring the stored preference. Unset (the
+     * default), the payer's stored choice applies, falling back to
+     * `defaultTheme`, falling back to the system scheme. The custom element's
+     * `theme` attribute is the same lock.
+     */
+    readonly theme?: ThemePreference;
 }
 interface UseThemeOptions {
     readonly defaultTheme?: ThemePreference;
     readonly storageKey?: string;
     readonly storage?: Storage;
+    /** Lock: this preference wins over storage and scope, and `setTheme` becomes a no-op. */
+    readonly theme?: ThemePreference;
 }
 interface UseThemeResult {
     readonly theme: ThemePreference;
@@ -195,6 +207,8 @@ interface ThemeScopeProps extends Omit<React.HTMLAttributes<HTMLElement>, "child
     readonly defaultTheme?: ThemePreference;
     readonly storageKey?: string;
     readonly storage?: Storage;
+    /** Lock: this preference wins over storage, and the toggle is not rendered. */
+    readonly theme?: ThemePreference;
     readonly themeToggle?: boolean;
     readonly topbarClassName?: string;
     readonly themeToggleClassName?: string;