Skip to content

Commit

Permalink
polish
Browse files Browse the repository at this point in the history
  • Loading branch information
brillout committed Nov 19, 2024
1 parent 053f38f commit 77196fc
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 18 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
Monorepo of [Vike React extensions](https://vike.dev/extensions#react)

> [!NOTE]
> The source code is [small, simple, and highly polished](https://vike.dev/vike-react#under-the-hood). Contributing is easy and welcome, see [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
Source code of following Vike React extensions: [Vike Docs > Extensions > React](https://vike.dev/extensions#react).
See [packages/](packages/).
14 changes: 9 additions & 5 deletions packages/vike-react-apollo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,22 @@

# `vike-react-apollo`

Enables your React components to fetch data using [Apollo GraphQL](https://www.apollographql.com/docs/react/).
Enables your React components to fetch data using [Apollo GraphQL](https://www.apollographql.com). Powered by [HTML streaming](https://github.com/brillout/react-streaming#readme).

> [!NOTE]
> You also get [progressive rendering](https://vike.dev/streaming#progressive-rendering), fallback upon loading and/or error, and [caching](https://www.apollographql.com/docs/react/caching/cache-configuration).
> Includes:
> - [Progressive rendering](https://vike.dev/streaming#progressive-rendering)
> - [SSR benefits](https://github.com/brillout/react-streaming#ssr)
> - Fallback upon loading and/or error
> - [Caching](https://www.apollographql.com/docs/react/caching/cache-configuration).
[Installation](#installation)
[Basic usage](#basic-usage)
[`withFallback()`](#withfallback)
[`<head>` tags](#head-tags)
[Error Handling](#error-handling)
[How it works](#how-it-works)
[Version history](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-apollo/CHANGELOG.md)
[See also](#see-also)

<br/>
Expand Down Expand Up @@ -271,10 +276,9 @@ Upon page navigation (and rendering the first page if [SSR is disabled](https://

## See also

- Docs: [vike.dev/apollo-graphql](https://vike.dev/apollo-graphql)
- Version history: [CHANGELOG.md](CHANGELOG.md)
- [Example](https://github.com/vikejs/vike-react/tree/main/examples/apollo)
- [Vike > Data Fetching](https://vike.dev/data-fetching)
- [Vike Docs > Apollo GraphQL](https://vike.dev/apollo-graphql)
- [Vike Docs > Data Fetching](https://vike.dev/data-fetching)
- [Apollo GraphQL > useSuspenseQuery](https://www.apollographql.com/docs/react/api/react/hooks/#usesuspensequery)
- [Apollo GraphQL > Suspense](https://www.apollographql.com/docs/react/data/suspense/)
- [React > `<Suspense>`](https://react.dev/reference/react/Suspense)
4 changes: 2 additions & 2 deletions packages/vike-react-chakra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[Installation](#installation)
[Settings](#settings)
[Version history](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-chakra/CHANGELOG.md)
[See Also](#see-also)

<br/>
Expand Down Expand Up @@ -81,5 +82,4 @@ export const chakra = null

## See also

- Docs: [vike.dev/chakra](https://vike.dev/chakra)
- Version history: [CHANGELOG.md](CHANGELOG.md)
- [Vike Docs > Chakra UI](https://vike.dev/chakra)
10 changes: 5 additions & 5 deletions packages/vike-react-query/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@

# `vike-react-query`

Enables your React components to fetch data using [TanStack Query](https://tanstack.com/query/latest).
Enables your React components to fetch data using [TanStack Query](https://tanstack.com/query/latest). Powered by [HTML streaming](https://github.com/brillout/react-streaming#readme).

> [!NOTE]
> Including:
> Includes:
> - [Progressive rendering](https://vike.dev/streaming#progressive-rendering)
> - [SSR benefits](https://github.com/brillout/react-streaming#ssr)
> - Fallback upon loading and/or error
Expand All @@ -22,6 +22,7 @@ Enables your React components to fetch data using [TanStack Query](https://tanst
[Settings](#settings)
[Usage with Telefunc](#usage-with-telefunc)
[How it works](#how-it-works)
[Version history](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-query/CHANGELOG.md)
[See also](#see-also)

<br/>
Expand Down Expand Up @@ -436,8 +437,7 @@ Upon page navigation (and rendering the first page if [SSR is disabled](https://

## See also

- Docs: [vike.dev/tanstack-query](https://vike.dev/tanstack-query)
- Version history: [CHANGELOG.md](CHANGELOG.md)
- [Example](https://github.com/vikejs/vike-react/tree/main/examples/react-query)
- [Vike Docs > TanStack Query](https://vike.dev/tanstack-query)
- [TanStack Query > useSuspenseQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseQuery)
- [Vike > Data Fetching](https://vike.dev/data-fetching)
- [Vike Docs > Data Fetching](https://vike.dev/data-fetching)
3 changes: 1 addition & 2 deletions packages/vike-react/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
Docs: [vike.dev/vike-react](https://vike.dev/vike-react)
Source code: [GitHub > vikejs/vike-react](https://github.com/vikejs/vike-react)
See [Vike Docs > vike-react](https://vike.dev/vike-react).

0 comments on commit 77196fc

Please sign in to comment.