Esta página documenta
@whop/elements@1.10.0 y @whop/elements-react@1.10.0.v1.0.0.
Se monta dentro de
Payments. Pasa las props y los callbacks a través de las opciones de creación o de las props de React. Conserva el handle creado, o la ref de React, para llamar a select().Exclusivo.
PaymentElement es una alternativa a CardElement o CardFields en este handle de Payments. Monta uno cada vez. Destrúyelo antes de montar otro.Espera a
BrandingElement. Este elemento permanece en su estado de carga hasta que se monta BrandingElement en el mismo handle de Payments.Datos de ejemplo. Abre el Playground.
Props
Controla el orden de visualización en cualquiera de los diseños. Los tipos de la lista aparecen primero, en orden. Los tipos que no están en la lista conservan su orden relativo. No afecta a la disponibilidad. Por defecto es
[].Controla qué wallets ofrece el elemento. Cada clave tiene por defecto
'auto', que ofrece la wallet allí donde la cuenta, el dispositivo del comprador y el cobro la admiten. 'never' elimina esa wallet de la lista de métodos. Úsalo cuando tu página dibuje sus propios botones de Apple Pay, Google Pay o PayPal con paymentRequest, para que los compradores vean cada wallet una sola vez. payPal: 'never' elimina el método PayPal. Los métodos de pago guardados no se ven afectados. Por defecto es {}. Desde v1.8.0.Controla la recopilación de los datos de facturación.
billingDetails: 'minimal' (por defecto) sigue la matriz de cada método. Los métodos recopilan el nombre y el formato de país completo por defecto. Una anulación puede recopilar solo el mínimo declarado o nada. Para las tarjetas, el mínimo es el nombre en la tarjeta, el país y el código postal. 'full' exige el nombre y el formato de país completo para todos los métodos nuevos. 'never' oculta el bloque. address: 'minimal' recopila solo el mínimo declarado de cada método más un país allí donde ese mínimo no lo incluya (y también el código postal cuando billingDetails: 'full' indica que el checkout está sujeto a impuestos), excepto para wallets, cripto, débitos bancarios, transferencias bancarias, pagos con tarjeta presente y compras dentro de la app, que no recopilan ninguna dirección, y excepto para un método cuyo proveedor exige la dirección de facturación completa (requires_full_billing_address), cuyo mosaico sigue las mismas reglas que un checkout sin esa marca; en los demás casos prevalece sobre billingDetails: 'full'; úsalo cuando el vendedor no recopile una dirección de facturación completa. phone: 'never' oculta solo el campo de teléfono de facturación cuando tu formulario ya lo recopila; pasa billingDetails.phone a createConfirmationToken para los métodos que lo requieran. En su lugar, pasa la dirección a createConfirmationToken. El selector de país incluye solo los países que admiten el método y la moneda del pago. Con un plan de pago a plazos seleccionado, se limita a los países que cubre el plan: el país de facturación es el país de la transacción con el que se procesa el cobro. Se bloquea cuando solo hay uno disponible. Por defecto es {"billingDetails":"minimal"}.Rellena previamente los datos de facturación cuando el bloque de facturación de cada método se renderiza por primera vez. El comprador puede editar todos los campos rellenados.
address.country es un código ISO 3166-1 alfa-2 y solo se aplica cuando el método seleccionado lo acepta. phone rellena el campo de teléfono de facturación de los métodos que lo recopilan, en formato E.164 como +14155552671; se ignora un número fuera de los países de teléfono admitidos por el método. Solo se rellenan y envían los campos que renderiza el bloque. Pasa cualquier otro dato a createConfirmationToken en billingDetails. Desde v1.1.0.Diseño del selector.
accordion (por defecto) apila los métodos y despliega los detalles en línea. horizontal muestra mosaicos del mismo ancho y sin desplazamiento, con los detalles del seleccionado debajo. A partir de cuatro métodos, un mosaico More abre un selector nativo. El método elegido allí ocupa el último mosaico hasta la siguiente selección. La selección y la confirmación se comportan igual. Por defecto es "accordion".Solo para
accordion. Añade espaciado y un estilo de tarjeta separado entre los métodos. Se ignora cuando layout es horizontal. Por defecto es false.Si se selecciona el primer método ofrecido tras la resolución. El valor por defecto
true respeta order y emite selected y change como una interacción del comprador. Se ejecuta una vez antes de la interacción del comprador y no hace nada cuando no se ofrece ningún método. Establécelo en false para montar sin selección. Independientemente de esto, si una actualización elimina el método seleccionado, la selección recurre al primer método ofrecido. Un elemento que ya no tiene selección se queda sin selección. Por defecto es true.Eventos
Pasa los callbacks en las opciones de creación o como props de React.onChange
Se dispara cuando cambia la selección. complete: true significa que el comprador seleccionó un método y completó sus campos de tarjeta o sus campos obligatorios. Úsalo para habilitar la confirmación. paymentMethod es el método de pago seleccionado, guardado o nuevo, o null mientras no hay nada seleccionado: displayName e icons nombran la elección tal como la muestra el elemento (con balance.imageUrl, la imagen del titular de un saldo), card incluye la red, los últimos cuatro dígitos y el tipo de financiación de una tarjeta, requiresBillingPhone indica si el método necesita un teléfono en los datos de facturación y countries enumera desde dónde puede pagar el método en la moneda del cobro. type, requiresBillingPhone y method en el nivel superior están obsoletos: léelos desde paymentMethod. supportsBuyerFee en el nivel superior también está obsoleto, sin reemplazo: Whop fija el precio de su tarifa de servicio al comprador por sí mismo.onAddressChange
Se dispara unos 300 ms después de que cambie la dirección de facturación interna. Úsalo para impuestos, envío u otras actualizaciones que dependen de la dirección. country es un código ISO 3166-1 alfa-2. El payload omite las demás claves de la dirección cuando están vacías o no se usan en ese país. complete: true significa que el bloque de facturación es válido y está completo. Este evento solo se dispara mientras el elemento de pago se encarga de recopilar la dirección. Con fields.billingDetails: 'never', usa tu propia fuente de dirección. Con un AddressElement montado, usa su evento change.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.select
Selecciona un método por la misma vía que una interacción del comprador. Por ejemplo, select('cashapp') despliega el mosaico y emite selected y change. Las tarjetas siguen en complete: false hasta que sus campos estén completos. Los métodos desconocidos, no disponibles o limitados por importe se rechazan con el código METHOD_NOT_OFFERED. select(null) borra la selección y emite change con complete: false. Úsalo con autoSelect={false} para tener control externo total.ParámetrosDevuelve Promise<void>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.appearance a <Payments>. Establécelo globalmente con WhopElements({ appearance }).
