React Query
Hooks React Query para integração com React. Os hooks não fazem requisições próprias: eles consomem o Core via MeapleSDKProvider — por exemplo, useEvents chama sdk.events.find(), useCreateOrder chama sdk.orders.create().
💡 Configuração inicial necessária: Veja o Guia rápido para instalar e configurar o
MeapleSDKProvider.
Pré-requisitos
- Ter o pacote
@meaple-com/coreinstalado no projeto. - Criar uma instância do
MeapleSDK(ex.:const sdk = new MeapleSDK({...})) e passá-la para oMeapleSDKProvider. - Ter o React Query configurado com um
QueryClientProvider.
Sem o Core e uma instância válida do MeapleSDK, os hooks de @meaple-com/react-query não conseguem fazer chamadas para a API.
ℹ️ Identificação do canal
O canal é identificado automaticamente pelo headerX-Channel-Idconfigurado no SDK. Não é necessário passarchannelSlugouchannelIdnos hooks.
Módulos
Cada grupo de hooks está documentado em uma página própria:
| Módulo | Descrição |
|---|---|
| Events | useEvents, useEvent, useEventTickets, useEventProducts, useUserEventTickets |
| Orders | useCreateOrder, useOrder, useUserOrders |
| Users | useUserEvents, useRefundUserOrder |
| Categories | useCategories |
| Coupon | useCheckCoupon |
| Payment | usePlatformFee |
| Tickets | useEditUserTicket, useTransferTicket, useCreateTicketFile |
Os hooks retornam dados tipados usando os mesmos modelos do Core (EventProps, TicketProps, OrderProps, UserProps, etc). Consulte Types (Modelos de Dados) para os campos completos.
Os hooks de query (ex.: useEvents, useUserEvents) aceitam um segundo argumento options com as opções do React Query (UseQueryOptions), exceto queryKey e queryFn. Use para customizar staleTime, enabled, refetchOnWindowFocus, etc.
Próximos passos
- Headless Components — Componentes com render props
- Core SDK — SDK principal (recursos e métodos)