Skip to main content
Esta página documenta @whop/elements@1.10.0 y @whop/elements-react@1.10.0.
Desde v1.0.0.
Se monta dentro de Checkout. Pasa las props y los callbacks a través de las opciones de creación o de las props de React.
Exclusivo. ExpressCheckoutElement es una alternativa a CheckoutElement en este handle de Checkout. Monta uno a la vez. Destrúyelo antes de montar otro.
Móntalo dentro de <Checkout>, que abre la sesión de checkout a partir de tu plan, items o checkoutConfiguration y guarda su credencial para sí. <Checkout> se monta a su vez dentro de <WhopElements>. Una pulsación en el botón es toda la compra: no hay ningún token de confirmación que pasar a tu servidor.

Datos de ejemplo. Abre el Playground.

Props

object | ("apple_pay" | "google_pay" | "paypal_express")[]
wallets como array está obsoleto y se eliminará en la próxima versión mayor. Pasa { applePay, googlePay, payPal } con "auto" o "never" en su lugar.
Qué monederos pueden renderizarse. Establece applePay, googlePay o payPal en 'never' para omitir ese botón; cada clave tiene 'auto' por defecto, un filtro sobre lo que realmente ofrecen el dispositivo del comprador y el vendedor. El elemento nunca muestra un monedero que el dispositivo, la matriz servida o la configuración de métodos de pago del checkout no puedan respaldar, y el orden de renderizado sigue siendo primero el mejor nativo, con PayPal al final. Una lista de tipos de monedero (['apple_pay', 'google_pay']) todavía se acepta como lista de permitidos, pero está obsoleta y se eliminará en la próxima versión mayor; una lista vacía no renderiza nada (con un aviso en las compilaciones de desarrollo). Todos los monederos necesitan Apple Pay listo en el dominio de la página mediante la API de Domains: las páginas propias de whop.com están aprobadas previamente; en cualquier otro sitio, añade Apple Pay al dominio o los botones permanecerán ocultos. Ofrecer Google Pay en tu propio sitio está sujeto a los Términos de servicio de la API de Google Pay. Por defecto es {}.
"auto" | "horizontal" | "vertical"
Cómo se apilan los botones. auto sigue el propio contenedor del elemento: apilados en contenedores estrechos, lado a lado en los anchos; horizontal y vertical fuerzan una disposición. Por defecto es "auto".

Eventos

Pasa los callbacks en las opciones de creación o como props de React.

onLoaderStart

Se ejecuta después de que el esqueleto de carga se pinta por primera vez y antes de onReady.

onReady

Se ejecuta después del primer pintado completo del elemento.

onError

Se ejecuta cuando el elemento no se carga o falla. El contenido de respaldo permanece visible. Usa code para el manejo programático. sourceKey identifica una fuente de estado del host que falló.
object

Métodos

Llámalos en el handle que devuelve create, o a través de una ref de React.

mount

Monta el elemento en target y comienza a cargarlo. Los componentes de React se montan solos.Parámetros
string | HTMLElement
requerido

destroy

Elimina el elemento y libera su frame y sus suscripciones. Puedes llamarlo más de una vez. React elimina el elemento automáticamente.

update

Combina nuevas props en el elemento montado. En React, cambia las props del componente en su lugar.Parámetros
Partial<ExpressCheckoutElementProps>
requerido

Estilos

Aplica estilo a estas partes mediante appearance.classes. Usa camel case o kebab case para los nombres de las propiedades e incluye las unidades. Las hojas de estilo de la página no pueden llegar al frame del elemento. El framework valida cada declaración antes de inyectarla.
En React, pasa appearance a <Checkout>. Establécelo globalmente con WhopElements({ appearance }).

Props

('apple_pay' | 'google_pay')[]
Qué monederos pueden renderizarse, como filtro sobre lo que ofrece el dispositivo. El elemento nunca muestra un monedero que el dispositivo, la cuenta o la configuración de métodos de pago del checkout no puedan respaldar. Una lista vacía no renderiza nada. Por defecto, ambos.
StyleProp<ViewStyle>
Se aplica al View exterior del elemento. Para la personalización del tema, es preferible appearance.parts en el provider, que cubre todos los elementos de esta superficie. Ten en cuenta que, por ahora, los nombres de las partes de React Native son un conjunto propio, no los nombres de clase whop-* de la web, por lo que un objeto de appearance de la web no se puede trasladar sin cambios.
ReactNode
Se renderiza en lugar del esqueleto integrado mientras el elemento se carga.
() => void
Se dispara una vez que el elemento se ha estabilizado: el botón está visible, o el elemento sabe que no renderiza nada. <Checkout> lo espera, así que normalmente lo que quieres es su propio onLoadingChange.
(error: { message: string; code?: string }) => void
Un fallo de carga o de configuración de este elemento. En cualquier caso, el elemento renderiza su propia vista de error.

Estados

Una píldora de esqueleto mientras se abre la sesión y se pregunta al dispositivo si puede pagar; después, el propio botón de Apple Pay o Google Pay de la plataforma encima del aviso Powered by Whop. Un dispositivo sin monedero, un monedero que la configuración de métodos de pago del checkout deshabilita o un plan agotado o archivado no renderizan nada. Un checkout que una hoja no puede finalizar de forma fiable (una configuración, unirse a una lista de espera, una transferencia, una pregunta de formulario que solo una página puede hacer) renderiza una vista explicativa e informa de EXPRESS_CHECKOUT_UNAVAILABLE mediante onError. Después de la compra, el elemento muestra su resultado: completado, en proceso, o una pulsación de Finish payment o Try again cuando el pago todavía necesita al comprador.

Información útil

  • Un dispositivo ofrece un monedero: Apple Pay en iOS, Google Pay en Android. Por eso aquí no hay prop layout: nunca hay un segundo botón que organizar.
  • La hoja recopila lo que la sesión todavía necesita: el correo electrónico cuando la sesión no tiene ninguno, un número de teléfono cuando el vendedor lo pide y una dirección de envío para productos físicos. Un vendedor que verifica los números de teléfono obtiene un paso de código en un modal nativo después de que se cierre la hoja.
  • En iOS, la hoja recalcula el precio cuando el comprador cambia de tarjeta, de modo que los impuestos siguen la dirección de facturación, y ofrece un campo de código promocional cuando el vendedor permite códigos. La hoja de Google en Android muestra el total del checkout y no tiene campo de código.
  • Tu app nunca navega. onComplete en <Checkout> se dispara una vez cuando la compra es definitiva, con sessionId y receiptId, y es donde llevas al comprador al siguiente paso. Realiza el cumplimiento a partir de webhooks, no a partir de este callback.
  • 3D Secure y otros pasos externos abren ASWebAuthenticationSession en iOS y Custom Tabs en Android, y el elemento consulta el pago hasta que se resuelve. returnUrl en <Checkout> debe ser una URL https que alojes tú.
  • Todas las opciones de <Checkout> se establecen en la creación. Cambiar una después del montaje informa de CHECKOUT_OPTIONS_FROZEN y mantiene el pedido original; dale a <Checkout> una nueva key para vender otra cosa.
Envuelve tu app en <WhopElements getToken={…}> una vez y luego monta <Checkout> alrededor del elemento. <Checkout> acepta plan, items, checkoutConfiguration, quantity, promoCode, affiliateCode, attribution, metadata y returnUrl, además de onComplete, onError, onLoadingChange y fallback. Consulta Primeros pasos y Appearance.