@updevs/sdk-react
v1.0.0
Published
React bindings (provider and hooks) for APIs built with the UpDevs .NET SDK. Works on web and Expo/React Native.
Readme
@updevs/sdk-react
React bindings for @updevs/sdk-client: a provider, auth hooks and
TanStack Query hooks for the SDK stores. Works on the web and on Expo/React Native.
npm install @updevs/sdk-react @updevs/sdk-client @tanstack/react-queryimport { QueryClientProvider } from '@tanstack/react-query';
import { createQueryClient, UpdProvider, useCreate, useSearch } from '@updevs/sdk-react';
const queryClient = createQueryClient(); // retries transient failures only
export function App() {
return (
<QueryClientProvider client={queryClient}>
<UpdProvider session={session}>
<Products />
</UpdProvider>
</QueryClientProvider>
);
}
function Products() {
const { data, isPending } = useSearch(products, { pageIndex: 0, pageSize: 20 });
const create = useCreate(products); // refreshes the cached searches on success
// create.error?.getFieldErrors() -> { name: ['Required'] } for 588 validation errors
}Hooks: useSearch, useInfiniteSearch, useList, useByIds, useEntity, useFilterableFields, useCreate,
useUpdate, useRemove, useRemoveMany, useExportCsv, useAuth, useSignIn, useHasClaim, plus Can and
RequireAuth. Requests are cancelled on unmount and the cache is cleared when the user signs out.
Peer dependencies: react, @tanstack/react-query and @updevs/sdk-client.
Full documentation: https://github.com/eestein/updevs-sdk-react#readme
