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 validate() y getValues().Uno por
mode. Monta un <AddressElement /> por cada valor de mode en un mismo handle de Payments. Un segundo montaje con el mismo mode se rechaza. El mode de un elemento se establece al crearlo; para cambiarlo, destruye el elemento y crea uno nuevo.Datos de ejemplo. Abre el Playground.
Props
Qué dirección recopila:
billing (por defecto) o shipping. También establece el propósito de autocompletado del navegador. Puedes montar uno de cada en un mismo handle. Los datos de facturación provienen del elemento de facturación o, si no hay ningún elemento de facturación montado, del elemento de envío. Por defecto es "billing".La fila del nombre: un campo de nombre completo (por defecto), campos separados de nombre y apellido, o ninguno. Por defecto es
"combined".Línea 2 de la dirección: siempre visible (por defecto), mostrada mediante un botón de texto (
toggle) o nunca recopilada. Por defecto es "always".Valores iniciales aplicados una vez antes del primer pintado (
address.country es un código de país ISO 3166-1 alfa-2). Tienen prioridad sobre la detección del país por IP.full (por defecto) apila campos con etiqueta. compact agrupa campos etiquetados con placeholder dentro de un solo borde. wrap mantiene los campos separados de full y además coloca ciudad, estado y código postal lado a lado. Estos y los pares que full ya coloca lado a lado (nombre y apellido, organización) caben tantos por fila como permita el ancho y pasan a la siguiente línea a medida que se estrecha. Por defecto es "full".above (por defecto) mantiene cada etiqueta fuera de su campo: encima de él en el diseño full, como su placeholder en compact. floating usa cada etiqueta como placeholder de su campo, en cualquiera de los diseños, y luego muestra una pequeña etiqueta encima del texto escrito una vez que el campo tiene un valor. Por defecto es "above". Desde v1.5.0.full (por defecto) sigue el formato de dirección completo del país seleccionado. minimal recopila solo el país y el código postal. name añade de forma independiente los campos de nombre obligatorios. Establece name en none para omitirlos. Este elemento no añade los campos que requiere un método de pago. La confirmación con tarjeta requiere un nombre, un país y un código postal, así que mantén name habilitado o pasa billingDetails.name. Por defecto es "full".Campos de organización: ninguno (por defecto), solo el nombre, o el nombre con un selector de empresa/particular. Por defecto es
"none".Toma el país por defecto de la IP del comprador (resuelto antes del primer pintado). Si no, recurre al
countryHint del controlador y luego a US. Por defecto es true.Códigos de país ISO 3166-1 alfa-2 permitidos. Con un solo código, el selector sigue visible pero solo ofrece ese país.
Habilita las sugerencias de Google Places para la dirección de la calle. Si no aparece ninguna coincidencia o Places está bloqueado, la lista indica que no hay coincidencias y permite a los compradores introducir la dirección manualmente. En un teléfono, las sugerencias se abren a pantalla completa desde un botón de búsqueda en el campo de la calle en lugar de debajo de él, donde el teclado las taparía. Establécelo en
false para un campo simple. Por defecto es true.Muestra todos los campos de dirección desde el principio. Por defecto (
false), el formulario se abre con la dirección de la calle y muestra el resto una vez que el comprador elige una sugerencia, escribe una dirección o decide introducirla manualmente. Por defecto es false. Desde v1.6.0.Campos adicionales que se renderizan con el formulario de dirección. Los valores se validan y se emiten en el mapa
custom independiente.País alternativo después de
defaultValues y de la detección por IP. Usa un código ISO 3166-1 alfa-2. Un valor vacío recurre a US. Por defecto es "".Eventos
Pasa los callbacks en las opciones de creación o como props de React.onChange
Se dispara cuando cambia la dirección. complete es true cuando todos los campos específicos del país y los campos personalizados obligatorios son válidos. address sigue los nombres de billing_details del token de confirmación, incluido postal_code. country es un código ISO 3166-1 alfa-2. Los valores personalizados están en custom.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.validate
Valida el formulario, muestra todos los errores en línea y nunca lanza excepciones. Devuelve complete, address y errors. errors está vacío exactamente cuando complete es true. Las claves usan nombres del contrato como postal_code y line1, custom:<key> para los campos personalizados, y form de forma transitoria mientras carga.Devuelve Promise<object>getValues
Devuelve address y custom sin validar ni mostrar errores.Devuelve Promise<object>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 }).
