Skip to content

Packages to use React Suspense easily, containing @suspensive/react-query(one of @tanstack/react-query's community resources)

License

Notifications You must be signed in to change notification settings

codebutler/suspensive-react

 
 

Repository files navigation

MIT License PRs Welcome Commitizen friendly

codecov GitHub stars GitHub forks



npm version npm npm bundle size

All declarative components to use suspense on both CSR, SSR.

Features

  • Suspense (containing CSROnly mode)
  • ErrorBoundary
  • ErrorBoundaryGroup
  • AsyncBoundary (containing CSROnly mode)
  • Delay
  • SuspensiveProvider
  • HOC(Higher Order Component)s
  • useAwait, Await, awaitClient (Experimental)

Installation

npm install @suspensive/react
pnpm add @suspensive/react
yarn add @suspensive/react

Usage

import { Suspense, ErrorBoundary, ErrorBoundaryGroup } from '@suspensive/react'

const Example = (
  <ErrorBoundaryGroup>
    <ErrorBoundaryGroup.Reset trigger={(group) => <Button onClick={group.reset}>Reset All</Button>} />
    <ErrorBoundary fallback={(caught) => <Button onClick={caught.reset}>Reset {caught.error}</Button>}>
      <Suspense fallback={<Spinner />}>
        <SuspendedComponent />
      </Suspense>
    </ErrorBoundary>
    <ErrorBoundary fallback={(caught) => <Button onClick={caught.reset}>Reset {caught.error}</Button>}>
      <Suspense fallback={<Spinner />}>
        <SuspendedComponent />
      </Suspense>
    </ErrorBoundary>
  </ErrorBoundaryGroup>
)


npm version npm npm bundle size

Declarative apis to use @tanstack/react-query with suspense easily.

Features

  • useSuspenseQuery
  • useSuspenseQueries
  • useSuspenseInfiniteQuery
  • QueryErrorBoundary, QueryAsyncBoundary

Installation

npm install @suspensive/react-query
pnpm add @suspensive/react-query
yarn add @suspensive/react-query

Usage

import { Suspense } from '@suspensive/react'
import { QueryErrorBoundary, useSuspenseQuery } from '@suspensive/react-query'

const Example = () => (
  <QueryErrorBoundary fallback={(caught) => <Button onClick={caught.reset}>Reset {caught.error}</Button>}>
    <Suspense fallback={<Spinner />}>
      <SuspendedComponent />
    </Suspense>
  </QueryErrorBoundary>
)

const SuspendedComponent = () => {
  const query = useSuspenseQuery({
    queryKey,
    queryFn,
  })

  return <>{query.data}</>
}

Docs deployment

We provide Official Docs

See OFFICIAL DOCS


Visualization deployment

Concepts Visualization ready. You can see core concepts of Suspensive visually

See VISUALIZATION.


License

MIT © Suspensive. See LICENSE for details.

About

Packages to use React Suspense easily, containing @suspensive/react-query(one of @tanstack/react-query's community resources)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 73.2%
  • MDX 19.2%
  • JavaScript 5.2%
  • CSS 2.3%
  • Shell 0.1%