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 las props y los callbacks a través de las opciones de creación o de las props de React.
Se monta dentro de un ámbito WhopPayments. Un selector del tipo de registro junto a su campo de valor, preseleccionado a partir del país del comprador.
Móntalo dentro de <Payments>, que es dueño del cobro y del token de confirmación. <Payments> se monta a su vez dentro de <WhopElements>. Un selector del tipo de registro junto a un campo de valor, para que un comprador que introduce un número de VAT o de CUIT elija primero el tipo correcto.

Datos de ejemplo. Abre el Playground.

Props

boolean
Deshabilita ambos campos mientras el host guarda el último registro confirmado. Por defecto es false.
string
País del comprador en ISO 3166-1 alfa-2 que se usa para preseleccionar el tipo. AR selecciona ar_cuit y LI selecciona li_uid. Los valores de la UE, los no asignados o los vacíos seleccionan eu_vat. Los demás países asignados seleccionan su propio primer tipo. Una selección manual se conserva aunque cambie el país. Por defecto es "".
object
type y value iniciales de una sesión reanudada. Un type no compatible recurre al valor predeterminado del país.
string
Error de validación de la API que se muestra debajo del campo de valor. Vacío (por defecto) no muestra nada. Por defecto es "".

Eventos

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

onChange

Se dispara al perder el foco o al pulsar Enter cuando el valor no está vacío, o cuando cambia el tipo con un valor presente. Los valores consecutivos idénticos se disparan una sola vez. Borrar el valor no lo dispara. El host debe borrar los registros almacenados.
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<TaxIdElementProps>
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<WhopTaxID?>?
Recibe cada registro confirmado.
String?
País del comprador en ISO 3166-1 alfa-2, que se usa para preseleccionar el tipo.
WhopTaxID?
Un par inicial de una sesión reanudada. Un tipo no compatible recurre al valor alternativo.
Bool
Deshabilita ambos campos mientras guardas el último registro confirmado. Por defecto es false.
String?
Un error de validación de la API, que se muestra debajo del campo de valor.

WhopTaxID

Lo que devuelve una selección:
  • type: WhopTaxIDType: el tipo de registro, eu_vat, ar_cuit, …
  • value: String: el propio registro

Estados

Se renderiza inmediatamente. Un valor que no coincide con el formato del tipo seleccionado muestra su error. error renderiza un fallo de validación de la API debajo del campo de valor.

Información útil

  • AR preselecciona ar_cuit; los miembros de la UE y cualquier valor no asignado preseleccionan eu_vat. Una selección manual se conserva aunque cambie el país.
  • Pasa el país desde el elemento de dirección para que ambos estén sincronizados.
  • El binding se dispara con cada registro confirmado, no con cada pulsación de tecla.

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
País del comprador en ISO 3166-1 alfa-2, que se usa para preseleccionar el tipo. AR selecciona ar_cuit; los valores de la UE y los no asignados seleccionan eu_vat.
{ type: string; value: string }
Par inicial de una sesión reanudada. Un tipo no compatible recurre al valor alternativo.
boolean
Deshabilita ambos campos mientras guardas el último registro confirmado.
string
Un mensaje de validación de tu API, que se muestra debajo del campo de valor.
(payload: TaxIdChangePayload) => void
Se dispara con cada cambio de tipo o de valor.
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.

TaxIdChangePayload

Lo que devuelve onChange:
  • taxId: { type: TaxIdType; value: string }: el tipo de registro seleccionado y lo que escribió el comprador

Estados

Se renderiza inmediatamente. El tipo se preselecciona a partir de country y el campo de valor se valida según el formato de ese tipo. onChange se dispara con el par actual.

Información útil

  • country solo preselecciona. Un comprador que elige un tipo manualmente lo conserva aunque cambie el país.
  • Pasa error para mostrar un mensaje de la validación de tu propia API debajo del campo de valor.
  • El elemento informa del par. Enviarlo te corresponde a ti: adjúntalo a tu propio pedido o registro de cliente.
Envuelve tu app en <WhopElements getToken={…}> una vez y luego monta <Payments> alrededor de los elementos. Consulta Primeros pasos y Appearance.