Esta página documenta
@whop/elements@1.10.0 y @whop/elements-react@1.10.0.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.import { WhopElements, Checkout, ExpressCheckoutElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";
function Example() {
return (
<WhopElements elements={loadWhop()}>
<Checkout /* options */>
<ExpressCheckoutElement />
</Checkout>
</WhopElements>
);
}
import { Checkout, ExpressCheckoutElement } from '@whop/elements-react-native';
export function BuyNow({ onPurchased }: { onPurchased: (receiptId: string) => void }) {
return (
<Checkout
plan="plan_xxxxxxxx"
returnUrl="https://example.com/checkout/return"
onComplete={({ receiptId }) => onPurchased(receiptId)}
>
<ExpressCheckoutElement onError={(e) => console.log(e.code, e.message)} />
</Checkout>
);
}
<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
const checkout = window.WhopElements().checkout.create({ /* options */ });
checkout.create('expressCheckout').mount('#checkout-expressCheckout');
</script>
Datos de ejemplo. Abre el Playground.
Props
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.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 {}.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ó.Métodos
Llámalos en el handle que devuelvecreate, 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ámetrosdestroy
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ámetrosEstilos
Aplica estilo a estas partes medianteappearance.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.| Clase | Aplica a |
|---|---|
.whop-Address | La raíz del formulario de dirección |
.whop-AddressErrorSummary | La línea de resumen que se muestra cuando la validación revela campos faltantes o no válidos |
.whop-AddressField | Una celda de campo en el formulario de dirección |
.whop-AddressFieldError | La línea de error de un campo de dirección: debajo del campo en el diseño completo, debajo del grupo como mensaje del compositor en el diseño compacto |
.whop-AddressFieldInput | Un campo de texto en el formulario de dirección |
.whop-AddressFieldInputInvalid | Se añade a un campo de dirección mientras no supera la validación |
.whop-AddressFieldInvalid | Se añade a una celda de campo compacta mientras no supera la validación |
.whop-AddressFieldLabel | Etiqueta de un campo de dirección: encima del campo, o dentro de él con etiquetas flotantes |
.whop-AddressFieldSelect | Un selector (país, estado, tipo de organización) en el formulario de dirección |
.whop-AddressGroup | El grupo con borde que contiene todos los campos en el diseño compacto |
.whop-AddressLine2Toggle | Interruptor contraído de la línea 2 de la dirección |
.whop-AddressManualEntry | El botón de texto “Enter address manually” debajo del formulario contraído: despliega el formato completo del país |
.whop-AddressSearchButton | El botón de búsqueda en el borde final del campo de calle en un teléfono |
.whop-AddressSearchCancel | El botón Cancel junto al campo de búsqueda de dirección |
.whop-AddressSearchInput | El campo de búsqueda en la parte superior de la búsqueda de dirección a pantalla completa |
.whop-AddressSuggestion | Una fila de sugerencia en la superposición de autocompletado |
.whop-AddressSuggestionActive | Se añade a la fila de sugerencia activa por teclado o puntero |
.whop-AddressSuggestionManual | La fila “Enter address manually” que cierra la lista de sugerencias |
.whop-AddressSuggestions | La superposición de sugerencias de autocompletado anclada al campo de la línea 1 de la dirección |
.whop-AddressSuggestionsEmpty | La línea discreta que se muestra cuando la consulta terminó sin direcciones coincidentes |
.whop-Card | Raíz del elemento de tarjeta |
.whop-CardError | Panel de error de configuración de la tarjeta |
.whop-CardField | Campo de número de tarjeta, vencimiento o código de seguridad |
.whop-CardFieldError | Mensaje de validación de la tarjeta |
.whop-CardFieldGroup | Los campos de tarjeta agrupados: el número arriba, el vencimiento y el código de seguridad debajo |
.whop-CardFieldInput | Contenedor de campo PCI con borde |
.whop-CardFieldInputFocused | Contenedor de campo PCI con foco |
.whop-CardFieldInputInvalid | Contenedor de campo PCI no válido o incompleto |
.whop-CardFieldRow | Fila compacta de número de tarjeta, vencimiento y código de seguridad |
.whop-CardLabel | Etiqueta de información de la tarjeta |
.whop-CheckoutExpress | La fila de checkout exprés: pagos con monedero de una sola pulsación encima del formulario |
.whop-CheckoutExpressApplePay | El botón exprés de Apple Pay |
.whop-CheckoutExpressButtons | La pila de botones de monedero: vertical en un contenedor estrecho, lado a lado en uno ancho |
.whop-CheckoutExpressComplete | La línea de resultado final del botón exprés independiente |
.whop-CheckoutExpressContinue | La pulsación para navegación bloqueada en la fila exprés: completa el viaje al paso externo del pago |
.whop-CheckoutExpressDivider | El divisor entre el checkout exprés y el formulario |
.whop-CheckoutExpressError | La línea de error reintentable debajo del botón exprés |
.whop-CheckoutExpressFinishPayment | La línea de finalizar pago que se muestra mientras el pago todavía necesita un paso que el comprador descartó |
.whop-CheckoutExpressFinishPaymentButton | El botón de reentrada que vuelve a ejecutar el paso pendiente del pago |
.whop-CheckoutExpressGooglePay | El botón exprés de Google Pay |
.whop-CheckoutExpressPayPal | El botón exprés de PayPal |
.whop-CheckoutExpressPhoneError | La línea de rechazo para un número de teléfono recopilado por el monedero al que el servidor no pudo enviar un SMS |
.whop-CheckoutExpressRetry | El botón del estado de fallo: vuelve a leer la sesión reabierta para que el comprador pueda pagar de nuevo |
.whop-CheckoutExpressUnavailable | La vista que se muestra cuando un botón exprés no puede atender este checkout |
.whop-CompletePayment | Raíz de la superficie de finalización |
.whop-CompletePaymentAmount | El importe que debe pagar el comprador |
.whop-CompletePaymentBarcode | La tarjeta con el código de barras escaneable |
.whop-CompletePaymentDocumentLink | El botón de instrucciones alojadas |
.whop-CompletePaymentError | Panel de error |
.whop-CompletePaymentFrame | Paso del PSP enmarcado |
.whop-CompletePaymentHint | Indicación de actualización automática |
.whop-CompletePaymentInstructions | Panel de instrucciones de pago |
.whop-CompletePaymentProviderMark | El logotipo de la red de vales |
.whop-CompletePaymentQr | La tarjeta con el código QR escaneable |
.whop-CompletePaymentReference | Un bloque de código copiable (referencia, clave de pago) |
.whop-CompletePaymentSettled | Panel de estado final que se muestra antes de cerrar |
.whop-CompletePaymentSettledFailed | Panel de estado final fallido que se muestra antes de cerrar |
.whop-CompletePaymentSpinner | Indicador de espera |
.whop-CompletePaymentTitle | Título del diálogo |
.whop-CompletePaymentTransferDetails | Las filas de detalles de la transferencia bancaria |
.whop-Email | Raíz del elemento de correo electrónico |
.whop-EmailChecking | El contorno animado mientras se comprueba el correo electrónico o se envía un código de inicio de sesión |
.whop-EmailCodeHint | La línea que pide el código de inicio de sesión |
.whop-EmailError | Mensaje de correo electrónico no válido |
.whop-EmailInput | El campo de correo electrónico |
.whop-EmailInputInvalid | Campo de correo electrónico con un valor inverosímil |
.whop-EmailLabel | Etiqueta del campo de correo electrónico |
.whop-EmailPasskey | El botón de inicio de sesión con passkey dentro del campo de correo electrónico |
.whop-EmailSignedIn | Fila del comprador con sesión iniciada |
.whop-EmailSignIn | Control de inicio de sesión de bienvenida |
.whop-EmailSignInError | Mensaje de error de inicio de sesión |
.whop-EmailSignOut | Control para elegir otro correo electrónico |
.whop-EmailWelcome | El saludo de la vista de bienvenida sobre el correo electrónico de la cuenta |
.whop-Payment | La raíz del elemento de pago |
.whop-PaymentBalance | Un monedero en el mosaico de saldo |
.whop-PaymentBalanceHint | El importe disponible del monedero en la moneda del cobro |
.whop-PaymentBalanceList | La lista desplazable de monederos del comprador en el mosaico de saldo |
.whop-PaymentBalanceMore | La fila centinela que carga más saldos al desplazarse hasta quedar visible |
.whop-PaymentBalanceRow | La fila de saldo en la que se puede hacer clic |
.whop-PaymentBalanceRowSelected | Fila de saldo seleccionada |
.whop-PaymentBalanceRowUnavailable | Un monedero que no puede pagar en este momento (bloqueado o vacío), atenuado y deshabilitado |
.whop-PaymentBillingBlock | El bloque interno de dirección de facturación del elemento de pago |
.whop-PaymentCardFields | El panel de campos de tarjeta en línea |
.whop-PaymentCompactBalance | El saldo seleccionado en un checkout directo compacto |
.whop-PaymentCompactSavedMethod | El método guardado seleccionado en un checkout directo compacto |
.whop-PaymentCurrencyFallback | El cambio a la moneda alternativa cuando no se ofrece nada |
.whop-PaymentDetailIcon | El icono de plantilla junto a la explicación de la región de detalle |
.whop-PaymentDetailRegion | La región de detalle desplegada de un método seleccionado: primero las superficies de recopilación (campos de tarjeta en línea, campos declarados) y luego la explicación y las líneas informativas como bloque inferior |
.whop-PaymentDetailSubtext | El subtexto de consentimiento debajo de la explicación en los métodos de monedero |
.whop-PaymentDetailText | La línea explicativa de la región de detalle |
.whop-PaymentError | Panel de error de métodos de pago no disponibles |
.whop-PaymentFieldError | El mensaje Invalid debajo de un campo declarado |
.whop-PaymentFieldInput | Un campo declarado del método en la región de detalle |
.whop-PaymentFieldInputInvalid | Se añade a un campo declarado mientras su valor no cumple el formato declarado |
.whop-PaymentFieldLabel | Etiqueta de un campo de pago declarado |
.whop-PaymentInstallmentDetail | El importe por cuota de una fila de opción de cuotas |
.whop-PaymentInstallmentLabel | La etiqueta de una fila de opción de cuotas |
.whop-PaymentInstallmentList | La lista de opciones del selector de cuotas |
.whop-PaymentInstallmentRadio | El indicador de opción en una fila de opción de cuotas |
.whop-PaymentInstallmentRow | Una fila de opción de cuotas |
.whop-PaymentInstallmentRowSelected | La fila de opción de cuotas seleccionada |
.whop-PaymentInstallments | El selector de cuotas del método de pago |
.whop-PaymentInstallmentsLabel | El encabezado del selector de cuotas |
.whop-PaymentInstallmentsNotice | El aviso sobre comisiones del emisor debajo de un nivel seleccionado sin comisión declarada |
.whop-PaymentMandateLink | El enlace a los términos del mandato dentro del aviso de mandato |
.whop-PaymentMandateNotice | El aviso de autorización de mandato en los métodos cuya configuración de matriz declara un mandato |
.whop-PaymentMethod | Un método de pago: la fila más su región de detalle desplegable |
.whop-PaymentMethodDetail | La región desplegable que muestra el detalle del método seleccionado: campos de tarjeta en línea, explicación o campos declarados |
.whop-PaymentMethodIcon | El icono del método en una fila |
.whop-PaymentMethodLabel | El nombre visible del método en una fila |
.whop-PaymentMethodMoreSelect | El selector nativo invisible extendido sobre el mosaico More |
.whop-PaymentMethodMoreTile | Mosaico de desbordamiento con iconos de métodos y un selector nativo |
.whop-PaymentMethodPanel | El panel de detalle del método seleccionado debajo de la fila de mosaicos (diseño horizontal) |
.whop-PaymentMethodRadio | El indicador de opción en una fila de método |
.whop-PaymentMethodRadioSelected | Indicador de opción del método de pago seleccionado |
.whop-PaymentMethodRow | La fila de método de pago en la que se puede hacer clic |
.whop-PaymentMethodRowSelected | Fila del método de pago seleccionado |
.whop-PaymentMethods | La lista de métodos de pago |
.whop-PaymentMethodSelected | Se añade al método de pago seleccionado: su fila más su región de detalle desplegada |
.whop-PaymentMethodSeparated | Se añade a un elemento de método, o a un desplegable de más métodos, mientras se muestra como su propia tarjeta separada |
.whop-PaymentMethodsSeparated | Lista de métodos en acordeón separado |
.whop-PaymentMethodTile | Un mosaico de método en la fila horizontal de mosaicos |
.whop-PaymentMethodTileRow | Fila horizontal de mosaicos de métodos con los métodos sobrantes en el mosaico final More |
.whop-PaymentMethodTileSelected | Mosaico del método de pago seleccionado |
.whop-PaymentMoreRow | La fila desplegable “N more payment methods” |
.whop-PaymentPayerDocument | Campos del documento de identidad del comprador específicos de la moneda |
.whop-PaymentPayerDocumentError | Error del documento de identidad del comprador |
.whop-PaymentPayerDocumentLabel | Etiqueta del documento de identidad del comprador |
.whop-PaymentPayerDocumentType | Selector del tipo de documento de identidad del comprador |
.whop-PaymentSavedMethod | Específicamente, un método de pago guardado: también lleva PaymentMethod |
.whop-PaymentSavedMethodHint | El detalle final del método guardado: el vencimiento de una tarjeta |
.whop-PaymentSavedMethodRow | Específicamente, la fila de método guardado en la que se puede hacer clic: también lleva PaymentMethodRow |
.whop-PaymentSavedMethodRowSelected | Fila del método de pago guardado seleccionado |
.whop-PaymentSavedMethods | Específicamente, la lista de métodos guardados: también lleva PaymentMethods, así que una sola regla aplica estilo a ambas listas |
.whop-PaymentSavedMethodSeparated | Específicamente, el marcador de separado en un método guardado |
.whop-PaymentSavedMore | El control que obtiene la siguiente página de métodos de pago guardados |
.whop-PaymentSavedMoreSpinner | El indicador de carga que se muestra mientras se carga la siguiente página de métodos de pago guardados |
.whop-PaymentSettlementNotice | La indicación del plazo de liquidación en los métodos cuya configuración de matriz declara uno |
.whop-TaxId | Raíz del registro fiscal |
.whop-TaxIdError | Error de validación de la API |
.whop-TaxIdInput | Campo del valor de registro |
.whop-TaxIdLabel | Etiqueta del valor de registro |
.whop-TaxIdTypeLabel | Etiqueta del tipo de registro |
.whop-TaxIdTypeSelect | Selector del tipo de registro |
.whop-Verification | Cuerpo del diálogo de código de verificación |
.whop-VerificationDismiss | Control para continuar como invitado cuando el inicio de sesión no está disponible |
.whop-VerificationError | El mensaje de error en el diálogo |
.whop-VerificationExpired | Panel de inicio de sesión caducado |
.whop-VerificationHeading | Encabezado y explicación del diálogo de código |
.whop-VerificationHint | Explicación del envío del código |
.whop-VerificationInput | El campo del código de un solo uso |
.whop-VerificationInputInvalid | Se añade al campo del código después de un intento fallido |
.whop-VerificationInputSlot | Una casilla de dígito del campo del código de un solo uso |
.whop-VerificationInputSlotActive | Se añade a la casilla del código en la que está escribiendo el comprador |
.whop-VerificationPasskey | Control para usar una passkey en su lugar |
.whop-VerificationPending | La línea de verificación… mientras un envío está en curso |
.whop-VerificationResend | Control para reenviar el código con cuenta atrás |
.whop-VerificationRestart | Control para empezar de nuevo en el panel caducado |
.whop-VerificationTitle | Logotipo textual del encabezado del diálogo |
const checkout = whop.checkout.create({
appearance: {
classes: {
'whop-Address': { borderRadius: '8px', fontWeight: '600' },
'whop-AddressErrorSummary': { borderRadius: '8px', fontWeight: '600' },
'whop-AddressField': { borderRadius: '8px', fontWeight: '600' }
}
}
});
// 159 classes use this shape
checkout.update({
appearance: { classes: { 'whop-Address': { fontWeight: '700' } } }
});
appearance a <Checkout>. Establécelo globalmente con WhopElements({ appearance }).Props
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.
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.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.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 deEXPRESS_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.
onCompleteen<Checkout>se dispara una vez cuando la compra es definitiva, consessionIdyreceiptId, 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
ASWebAuthenticationSessionen iOS y Custom Tabs en Android, y el elemento consulta el pago hasta que se resuelve.returnUrlen<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 deCHECKOUT_OPTIONS_FROZENy mantiene el pedido original; dale a<Checkout>una nuevakeypara 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.
