Hooks

The Prequel React SDK provides a comprehensive set of React Hooks to help you embed the functionality of Prequel into your React app.

Available Hooks

Hook	Shape	Usage
useDestination	`useDestination(): [Destination, SetDestinationFunction]`	Initialize a `Destination` object and a `setDestination` function to pass to `useDestinationForm` and collect data from your user.
useDestinationForm	`useDestinationForm(destination, orgIdInPrequel): Form`	Get a form object that you can render to collect connection information. The form changes based on fields set on the destination.
useModels	`useModels(fetchToken, origin): ModelConfig[]`	Get all Prequel models.
useCreateDestination	`useCreateDestination(fetchToken, origin): CreateDestinationFunction`	Generate a function you can use to submit a completed destination form and create the connection and begin syncing data.
useTestConnection	`useTestConnection(fetchToken, origin): TestConnectionFunction`	Generate a function you can use to embed a connection test (e.g., to test the destination setup before submitting the destination).
useUpdateDestination	`useUpdateDestination(fetchToken, origin): UpdateDestinationFunction`	Generate a function you can use to submit changes to an existing destination.
useDeleteDestination	`useDeleteDestination(fetchToken, origin)`	Generate a function you can use to delete existing destinations.
useGetTransfers	`useProducts(fetchToken, origin)`	Generate a function you can use to get transfers for an existing destination
useGetDestinationsForRecipient	`useGetDestinationsForRecipient(fetchToken, origin)`	Generate a function you can use to get destinations for the specified recipient.

Hooks vs. Components

Prequel provides a comprehensive set of React Hooks to help you embed Prequel's functionality into your app, though there are no pre-built React Components at this time. We hope the provided Hooks can help you build your own React Components into your app that adhere perfectly to your branding and design guides.