Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added with-react-query example link #30626

Closed
wants to merge 12 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 34 additions & 0 deletions examples/with-react-query/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local

# vercel
.vercel
36 changes: 36 additions & 0 deletions examples/with-react-query/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
This example is taken from the official documentation [React Query](https://github.com/tannerlinsley/react-query/tree/master/examples/nextjs).

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
33 changes: 33 additions & 0 deletions examples/with-react-query/components/Header/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import React from 'react'
import { useRouter } from 'next/router'
import Link from 'next/link'

export const Header = () => {
const { pathname } = useRouter()

return (
<header>
<Link href="/">
<a className={pathname === '/' ? 'is-active' : ''}>Home</a>
</Link>
<Link href="/client-only">
<a className={pathname === '/client-only' ? 'is-active' : ''}>
Client-Only
</a>
</Link>
<style jsx>{`
header {
margin-bottom: 25px;
}
a {
font-size: 14px;
margin-right: 15px;
text-decoration: none;
}
.is-active {
text-decoration: underline;
}
`}</style>
</header>
)
}
19 changes: 19 additions & 0 deletions examples/with-react-query/components/InfoBox/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import React from 'react'

const InfoBox = ({ children }) => (
<div className="info">
<style jsx>{`
.info {
margin-top: 20px;
margin-bottom: 20px;
padding-top: 20px;
padding-bottom: 20px;
border-top: 1px solid #ececec;
border-bottom: 1px solid #ececec;
}
`}</style>
{children}
</div>
)

export { InfoBox }
49 changes: 49 additions & 0 deletions examples/with-react-query/components/Layout/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import React from 'react'

export const Layout = ({ children }) => {
return (
<main>
{children}
<style jsx global>{`
* {
font-family: Menlo, Monaco, 'Lucida Console', 'Liberation Mono',
'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Courier New',
monospace, serif;
}
body {
margin: 0;
padding: 25px 50px;
}
a {
color: #22bad9;
}
p {
font-size: 14px;
line-height: 24px;
}
article {
margin: 0 auto;
max-width: 650px;
}
button {
align-items: center;
background-color: #22bad9;
border: 0;
color: white;
display: flex;
padding: 5px 7px;
transition: background-color 0.3s;
}
button:active {
background-color: #1b9db7;
}
button:disabled {
background-color: #b5bebf;
}
button:focus {
outline: none;
}
`}</style>
</main>
)
}
70 changes: 70 additions & 0 deletions examples/with-react-query/components/PostList/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import React, { useState } from 'react'
import { usePosts } from '../../hooks/usePosts'

export const PostList = () => {
const [postCount, setPostCount] = useState(10)
const { data, isLoading, isFetching } = usePosts(postCount)

if (isLoading) return <div>Loading</div>

return (
<section>
<ul>
{data?.map((post, index) => (
<li key={post.id}>
<div>
<span>{index + 1}. </span>
<a href="#">{post.title}</a>
</div>
</li>
))}
</ul>
{postCount <= 90 && (
<button
onClick={() => setPostCount(postCount + 10)}
disabled={isFetching}
>
{isFetching ? 'Loading...' : 'Show More'}
</button>
)}
<style jsx>{`
section {
padding-bottom: 20px;
}
li {
display: block;
margin-bottom: 10px;
}
div {
align-items: center;
display: flex;
}
a {
font-size: 14px;
margin-right: 10px;
text-decoration: none;
padding-bottom: 0;
border: 0;
}
span {
font-size: 14px;
margin-right: 5px;
}
ul {
margin: 0;
padding: 0;
}
button:before {
align-self: center;
border-style: solid;
border-width: 6px 4px 0 4px;
border-color: #ffffff transparent transparent transparent;
content: '';
height: 0;
margin-right: 5px;
width: 0;
}
`}</style>
</section>
)
}
4 changes: 4 additions & 0 deletions examples/with-react-query/components/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export * from './Layout'
export * from './Header'
export * from './InfoBox'
export * from './PostList'
1 change: 1 addition & 0 deletions examples/with-react-query/hooks/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './usePosts'
14 changes: 14 additions & 0 deletions examples/with-react-query/hooks/usePosts/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import ky from 'ky-universal'
import { useQuery } from 'react-query'

const fetchPosts = async (limit = 10) => {
const parsed = await ky('https://jsonplaceholder.typicode.com/posts').json()
const result = parsed.filter(x => x.id <= limit)
return result
}

const usePosts = limit => {
return useQuery(['posts', limit], () => fetchPosts(limit))
}

export { usePosts, fetchPosts }
48 changes: 48 additions & 0 deletions examples/with-react-query/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
const Module = require('module')
const path = require('path')
const resolveFrom = require('resolve-from')

const node_modules = path.resolve(__dirname, 'node_modules')

const originalRequire = Module.prototype.require

// The following ensures that there is always only a single (and same)
// copy of React in an app at any given moment.
Module.prototype.require = function (modulePath) {
// Only redirect resolutions to non-relative and non-absolute modules
if (
['/react/', '/react-dom/', '/react-query/'].some(d => {
try {
return require.resolve(modulePath).includes(d)
} catch (err) {
return false
}
})
) {
try {
modulePath = resolveFrom(node_modules, modulePath)
} catch (err) {
//
}
}

return originalRequire.call(this, modulePath)
}

module.exports = {
webpack: config => {
config.resolve = {
...config.resolve,
alias: {
...config.resolve.alias,
react$: resolveFrom(path.resolve('node_modules'), 'react'),
'react-query$': resolveFrom(
path.resolve('node_modules'),
'react-query'
),
'react-dom$': resolveFrom(path.resolve('node_modules'), 'react-dom'),
},
}
return config
},
}
25 changes: 25 additions & 0 deletions examples/with-react-query/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "with-react-query",
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint"
},
"dependencies": {
"ky": "^0.23.0",
"ky-universal": "^0.8.2",
"next": "latest",
"react": "^16.13.1",
"react-dom": "^16.13.1",
"react-query": "^3.5.0",
"resolve-from": "^5.0.0",
"web-streams-polyfill": "^3.0.3"
},
"devDependencies": {
"eslint": "7",
"eslint-config-next": "12.0.3"
}
}

16 changes: 16 additions & 0 deletions examples/with-react-query/pages/_app.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import React from 'react'
import { Hydrate, QueryClient, QueryClientProvider } from 'react-query'
import { ReactQueryDevtools } from 'react-query/devtools'

export default function MyApp({ Component, pageProps }) {
const [queryClient] = React.useState(() => new QueryClient())

return (
<QueryClientProvider client={queryClient}>
<Hydrate state={pageProps.dehydratedState}>
<Component {...pageProps} />
</Hydrate>
<ReactQueryDevtools />
</QueryClientProvider>
)
}
14 changes: 14 additions & 0 deletions examples/with-react-query/pages/client-only.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import React from 'react'
import { Layout, Header, InfoBox, PostList } from '../components'

const ClientOnly = () => {
return (
<Layout>
<Header />
<InfoBox>ℹ️ This data is loaded on client and not prefetched</InfoBox>
<PostList />
</Layout>
)
}

export default ClientOnly