Skip to content

Commit 541da76

Browse files
kyletsangkyletsang
authored
Add React Router examples (#299)
* Add React Router examples * lint
1 parent d6fdcd6 commit 541da76

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+18986
-0
lines changed

Diff for: ‎ts-react-router-v5/.gitignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*

Diff for: ‎ts-react-router-v5/README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Getting Started with Create React App
2+
3+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
4+
5+
## Available Scripts
6+
7+
In the project directory, you can run:
8+
9+
### `npm start`
10+
11+
Runs the app in the development mode.\
12+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
13+
14+
The page will reload if you make edits.\
15+
You will also see any lint errors in the console.
16+
17+
### `npm test`
18+
19+
Launches the test runner in the interactive watch mode.\
20+
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21+
22+
### `npm run build`
23+
24+
Builds the app for production to the `build` folder.\
25+
It correctly bundles React in production mode and optimizes the build for the best performance.
26+
27+
The build is minified and the filenames include the hashes.\
28+
Your app is ready to be deployed!
29+
30+
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31+
32+
### `npm run eject`
33+
34+
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
35+
36+
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
37+
38+
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
39+
40+
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
41+
42+
## Learn More
43+
44+
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45+
46+
To learn React, check out the [React documentation](https://reactjs.org/).

Diff for: ‎ts-react-router-v5/package.json

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"name": "ts-react-router-v5",
3+
"version": "0.1.0",
4+
"private": true,
5+
"dependencies": {
6+
"@testing-library/jest-dom": "^5.16.4",
7+
"@testing-library/react": "^13.2.0",
8+
"@testing-library/user-event": "^13.5.0",
9+
"@types/jest": "^27.5.1",
10+
"@types/node": "^16.11.36",
11+
"@types/react": "^18.0.9",
12+
"@types/react-dom": "^18.0.4",
13+
"@types/react-router-dom": "^5.3.3",
14+
"bootstrap": "^5.1.3",
15+
"react": "^18.1.0",
16+
"react-bootstrap": "^2.4.0",
17+
"react-dom": "^18.1.0",
18+
"react-router-dom": "^5.3.3",
19+
"react-scripts": "5.0.1",
20+
"typescript": "^4.6.4",
21+
"web-vitals": "^2.1.4"
22+
},
23+
"scripts": {
24+
"start": "react-scripts start",
25+
"build": "react-scripts build",
26+
"test": "react-scripts test",
27+
"eject": "react-scripts eject"
28+
},
29+
"eslintConfig": {
30+
"extends": [
31+
"react-app",
32+
"react-app/jest"
33+
]
34+
},
35+
"browserslist": {
36+
"production": [
37+
">0.2%",
38+
"not dead",
39+
"not op_mini all"
40+
],
41+
"development": [
42+
"last 1 chrome version",
43+
"last 1 firefox version",
44+
"last 1 safari version"
45+
]
46+
}
47+
}

Diff for: ‎ts-react-router-v5/public/favicon.ico

3.78 KB
Binary file not shown.

Diff for: ‎ts-react-router-v5/public/index.html

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1" />
7+
<meta name="theme-color" content="#000000" />
8+
<meta
9+
name="description"
10+
content="Web site created using create-react-app"
11+
/>
12+
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
13+
<!--
14+
manifest.json provides metadata used when your web app is installed on a
15+
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
16+
-->
17+
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
18+
<!--
19+
Notice the use of %PUBLIC_URL% in the tags above.
20+
It will be replaced with the URL of the `public` folder during the build.
21+
Only files inside the `public` folder can be referenced from the HTML.
22+
23+
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
24+
work correctly both with client-side routing and a non-root public URL.
25+
Learn how to configure a non-root public URL by running `npm run build`.
26+
-->
27+
<title>React App</title>
28+
</head>
29+
<body>
30+
<noscript>You need to enable JavaScript to run this app.</noscript>
31+
<div id="root"></div>
32+
<!--
33+
This HTML file is a template.
34+
If you open it directly in the browser, you will see an empty page.
35+
36+
You can add webfonts, meta tags, or analytics to this file.
37+
The build step will place the bundled scripts into the <body> tag.
38+
39+
To begin the development, run `npm start` or `yarn start`.
40+
To create a production bundle, use `npm run build` or `yarn build`.
41+
-->
42+
</body>
43+
</html>

Diff for: ‎ts-react-router-v5/public/logo192.png

5.22 KB
Loading

Diff for: ‎ts-react-router-v5/public/logo512.png

9.44 KB
Loading

Diff for: ‎ts-react-router-v5/public/manifest.json

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"short_name": "React App",
3+
"name": "Create React App Sample",
4+
"icons": [
5+
{
6+
"src": "favicon.ico",
7+
"sizes": "64x64 32x32 24x24 16x16",
8+
"type": "image/x-icon"
9+
},
10+
{
11+
"src": "logo192.png",
12+
"type": "image/png",
13+
"sizes": "192x192"
14+
},
15+
{
16+
"src": "logo512.png",
17+
"type": "image/png",
18+
"sizes": "512x512"
19+
}
20+
],
21+
"start_url": ".",
22+
"display": "standalone",
23+
"theme_color": "#000000",
24+
"background_color": "#ffffff"
25+
}

Diff for: ‎ts-react-router-v5/public/robots.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# https://www.robotstxt.org/robotstxt.html
2+
User-agent: *
3+
Disallow:

Diff for: ‎ts-react-router-v5/src/App.css

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.App {
2+
text-align: center;
3+
}
4+
5+
.App-logo {
6+
height: 40vmin;
7+
pointer-events: none;
8+
}
9+
10+
@media (prefers-reduced-motion: no-preference) {
11+
.App-logo {
12+
animation: App-logo-spin infinite 20s linear;
13+
}
14+
}
15+
16+
.App-header {
17+
background-color: #282c34;
18+
min-height: 100vh;
19+
display: flex;
20+
flex-direction: column;
21+
align-items: center;
22+
justify-content: center;
23+
font-size: calc(10px + 2vmin);
24+
color: white;
25+
}
26+
27+
.App-link {
28+
color: #61dafb;
29+
}
30+
31+
@keyframes App-logo-spin {
32+
from {
33+
transform: rotate(0deg);
34+
}
35+
to {
36+
transform: rotate(360deg);
37+
}
38+
}

Diff for: ‎ts-react-router-v5/src/App.test.tsx

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import React from 'react';
2+
import { render, screen } from '@testing-library/react';
3+
import App from './App';
4+
5+
test('renders learn react link', () => {
6+
render(<App />);
7+
const linkElement = screen.getByText(/learn react/i);
8+
expect(linkElement).toBeInTheDocument();
9+
});

Diff for: ‎ts-react-router-v5/src/App.tsx

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { BrowserRouter, Switch, Route } from 'react-router-dom';
2+
import Page1 from './Page1';
3+
import Page2 from './Page2';
4+
import './App.css';
5+
6+
function App() {
7+
return (
8+
<BrowserRouter>
9+
<Switch>
10+
<Route path="/page2">
11+
<Page2 />
12+
</Route>
13+
<Route path="/">
14+
<Page1 />
15+
</Route>
16+
</Switch>
17+
</BrowserRouter>
18+
);
19+
}
20+
21+
export default App;

Diff for: ‎ts-react-router-v5/src/ButtonLink.tsx

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import * as React from 'react';
2+
import Button, { ButtonProps } from 'react-bootstrap/Button';
3+
4+
interface ButtonLinkProps extends ButtonProps {
5+
navigate: () => void;
6+
children?: React.ReactNode;
7+
}
8+
9+
function isModifiedEvent(event: React.MouseEvent) {
10+
return !!(event.metaKey || event.altKey || event.ctrlKey || event.shiftKey);
11+
}
12+
13+
const ButtonLink: React.FC<ButtonLinkProps> = ({ navigate, ...props }) => {
14+
const handleClick = (event: React.MouseEvent) => {
15+
props.onClick?.(event as any);
16+
17+
if (
18+
!event.defaultPrevented && // onClick prevented default
19+
event.button === 0 && // ignore everything but left clicks
20+
(!props.target || props.target === '_self') && // let browser handle "target=_blank" etc.
21+
!isModifiedEvent(event) // ignore clicks with modifier keys
22+
) {
23+
event.preventDefault();
24+
navigate();
25+
}
26+
};
27+
28+
return <Button {...props} onClick={handleClick} />;
29+
};
30+
31+
export default ButtonLink;

Diff for: ‎ts-react-router-v5/src/Page1.tsx

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import { Link } from 'react-router-dom';
2+
import Container from 'react-bootstrap/Container';
3+
import ButtonLink from './ButtonLink';
4+
5+
function Page1() {
6+
return (
7+
<Container>
8+
<h1>Page 1</h1>
9+
<Link to="/page2" component={ButtonLink}>
10+
Go to Page 1
11+
</Link>
12+
</Container>
13+
);
14+
}
15+
16+
export default Page1;

Diff for: ‎ts-react-router-v5/src/Page2.tsx

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { Link } from 'react-router-dom';
2+
import Container from 'react-bootstrap/Container';
3+
import ButtonLink from './ButtonLink';
4+
5+
function Page2() {
6+
// Types for Link doesn't allow arbitrary props.
7+
const LinkComponent = Link as any;
8+
9+
return (
10+
<Container>
11+
<h1>Page 2</h1>
12+
<LinkComponent to="/" variant="danger" component={ButtonLink}>
13+
Go to Page 1
14+
</LinkComponent>
15+
</Container>
16+
);
17+
}
18+
19+
export default Page2;

Diff for: ‎ts-react-router-v5/src/index.css

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
body {
2+
margin: 0;
3+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
4+
'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
5+
sans-serif;
6+
-webkit-font-smoothing: antialiased;
7+
-moz-osx-font-smoothing: grayscale;
8+
}
9+
10+
code {
11+
font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
12+
monospace;
13+
}

Diff for: ‎ts-react-router-v5/src/index.tsx

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import React from 'react';
2+
import ReactDOM from 'react-dom/client';
3+
import './index.css';
4+
import App from './App';
5+
import reportWebVitals from './reportWebVitals';
6+
7+
import 'bootstrap/dist/css/bootstrap.min.css';
8+
9+
const root = ReactDOM.createRoot(
10+
document.getElementById('root') as HTMLElement
11+
);
12+
root.render(
13+
<React.StrictMode>
14+
<App />
15+
</React.StrictMode>
16+
);
17+
18+
// If you want to start measuring performance in your app, pass a function
19+
// to log results (for example: reportWebVitals(console.log))
20+
// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
21+
reportWebVitals();

Diff for: ‎ts-react-router-v5/src/logo.svg

+1
Loading

Diff for: ‎ts-react-router-v5/src/react-app-env.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="react-scripts" />

Diff for: ‎ts-react-router-v5/src/reportWebVitals.ts

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import { ReportHandler } from 'web-vitals';
2+
3+
const reportWebVitals = (onPerfEntry?: ReportHandler) => {
4+
if (onPerfEntry && onPerfEntry instanceof Function) {
5+
import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
6+
getCLS(onPerfEntry);
7+
getFID(onPerfEntry);
8+
getFCP(onPerfEntry);
9+
getLCP(onPerfEntry);
10+
getTTFB(onPerfEntry);
11+
});
12+
}
13+
};
14+
15+
export default reportWebVitals;

Diff for: ‎ts-react-router-v5/src/setupTests.ts

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// jest-dom adds custom jest matchers for asserting on DOM nodes.
2+
// allows you to do things like:
3+
// expect(element).toHaveTextContent(/react/i)
4+
// learn more: https://github.com/testing-library/jest-dom
5+
import '@testing-library/jest-dom';

0 commit comments

Comments
 (0)