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 Payments. Pasa props y callbacks mediante las opciones de creación o las props de React.
Se monta dentro de un ámbito WhopPayments. Recopila el correo electrónico del comprador, que todo token de confirmación requiere, y el controlador lo lee para emitir el token tanto si lo vinculas como si no.
Móntalo dentro de <Payments>, que gestiona el cobro y el token de confirmación. <Payments> se monta a su vez dentro de <WhopElements>. Recopila el correo electrónico del comprador y lo publica en el provider, por lo que createConfirmationToken lo envía sin que tengas que pasarle nada.

Datos de ejemplo. Abre el Playground.

Props

boolean
Muestra la etiqueta localizada. Establécelo en false cuando proporciones la tuya. El campo conserva un aria-label localizado. El valor predeterminado es true.
string
Texto de marcador de posición del campo de correo electrónico. Vacío (predeterminado) muestra you@example.com. Con etiquetas flotantes, el texto de la etiqueta actúa como marcador de posición. El valor predeterminado es "".
"above" | "floating"
above (predeterminado) muestra la etiqueta encima del campo. floating usa el texto de la etiqueta como marcador de posición y luego muestra una pequeña etiqueta encima del texto escrito una vez que el campo tiene un valor. Se ignora cuando label es false. El valor predeterminado es "above". Desde v1.5.0.
string
Valor inicial que se aplica una vez al montar. El valor predeterminado es "".

Eventos

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

onChange

Se dispara cuando cambia el correo electrónico. complete es true cuando es plausible. El inicio de sesión lo dispara con el correo electrónico de la sesión iniciada, que también alimenta createConfirmationToken().
object

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<EmailElementProps>
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 <Payments>. Establécelo globalmente con WhopElements({ appearance }).

Parámetros

Binding<String>?
Devuelve el valor. El controlador lo recopila en cualquier caso.
Bool
Establécelo en false cuando proporciones tu propia etiqueta; el campo conserva su etiqueta de accesibilidad. El valor predeterminado es true.
String?
Vacío muestra you@example.com.

Estados

Se renderiza inmediatamente. Una dirección no plausible muestra su error cuando el campo pierde el foco y, a partir de ahí, en vivo.

Información útil

  • Sin él, pasa tú mismo billingDetails.email a createConfirmationToken. La emisión rechaza un token sin correo electrónico.
  • Un billingDetails.email explícito en el momento de la emisión prevalece sobre lo que recopiló este elemento.
  • Una dirección plausible se comprueba contra el directorio de cuentas, con debounce y de nuevo al perder el foco. Si se reconoce, se ofrece un inicio de sesión y el propio elemento presenta la hoja del código de seis dígitos.
  • Un inicio de sesión verificado desbloquea los métodos de pago guardados del comprador en WhopPaymentElement. Lee payments.buyer para saber quién es, y usa payments.signOut() para olvidarlo.
  • El token con alcance limitado dura una hora y no se renueva. Cuando caduca, la sección de métodos guardados vuelve vacía y el comprador paga con un método nuevo, el mismo camino que sigue un invitado.

Instalación

Móntalo dentro de un ámbito WhopPayments(accountID:charge:), que crea el controlador y se lo pasa a su contenido. payments.buyer es el comprador con sesión iniciada una vez que un inicio de sesión por correo electrónico lo ha verificado. WhopBrandingElement también tiene que estar en pantalla, porque Whop es el comerciante registrado en estas ventas y createConfirmationToken se rechaza sin él. Aplica estilo con .whopElementsAppearance(_:). El módulo es Elements, no WhopElements del SDK de wallet. Consulta Primeros pasos y Appearance.

Props

string
Valor inicial que se aplica una vez al montar.
boolean
Muestra la etiqueta localizada. El valor predeterminado es true.
string
Vacío muestra you@example.com.
(payload: EmailChangePayload) => void
Se dispara en cada edición.
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 es interactivo. <Payments> los agrupa, 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.

EmailChangePayload

Lo que devuelve onChange:
  • email: string: el valor actual
  • complete: boolean: la dirección se puede analizar

Estados

Se renderiza inmediatamente. onChange informa de complete una vez que la dirección se puede analizar, y el elemento muestra su propio mensaje de validación al perder el foco.

Información útil

  • El correo electrónico publicado es el que el token de confirmación lleva como billing_details.email. Pasar billingDetails.email a createConfirmationToken lo sobrescribe.
  • Establece label={false} cuando tu formulario proporcione su propia etiqueta. El campo conserva su etiqueta de accesibilidad en cualquier caso.
Envuelve tu app en <WhopElements getToken={…}> una vez y luego monta <Payments> alrededor de los elementos. Consulta Primeros pasos y Appearance.