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

WIP #1

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


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

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
.idea
39,888 changes: 39,888 additions & 0 deletions package-lock.json

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"name": "frontend-test",
"version": "0.1.0",
"private": true,
"dependencies": {
"@testing-library/jest-dom": "^5.11.9",
"@testing-library/react": "^11.2.5",
"@testing-library/user-event": "^12.8.3",
"@types/jest": "^26.0.20",
"@types/node": "^12.20.6",
"@types/react": "^17.0.3",
"@types/react-dom": "^17.0.2",
"@types/styled-components": "^5.1.9",
"antd": "^4.14.0",
"react": "^17.0.1",
"react-dom": "^17.0.1",
"react-scripts": "4.0.3",
"styled-components": "^5.2.1",
"typescript": "^4.2.3",
"web-vitals": "^1.1.1"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"eslintConfig": {
"extends": [
"react-app",
"react-app/jest"
]
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"devDependencies": {
"ttypescript": "^1.5.12"
}
}
Binary file added public/favicon.ico
Binary file not shown.
43 changes: 43 additions & 0 deletions public/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-react-app"
/>
<link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>
Binary file added public/logo192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/logo512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions public/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
{
"src": "logo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "logo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}
3 changes: 3 additions & 0 deletions public/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:
9 changes: 9 additions & 0 deletions src/App.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import React from 'react';
import { render, screen } from '@testing-library/react';
import App from './App';

test('renders learn react link', () => {
render(<App />);
const linkElement = screen.getByText(/learn react/i);
expect(linkElement).toBeInTheDocument();
});
18 changes: 18 additions & 0 deletions src/App.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import React from 'react'
import {AppContainer} from './styles'

import 'antd/dist/antd.dark.css'
import XboxWidget from './widget/xbox-debug-widget'

// todo: add dropdown to allow selecting available supported gamepads.
// Demo app hosted on localhost:3000.
// Change gamepadInd to index of xbox controller on your local machine
const App: React.FC = () => {
return (
<AppContainer>
<XboxWidget gamepadInd={0}/>
</AppContainer>
)
}

export default App
13 changes: 13 additions & 0 deletions src/index.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
body {
margin: 0;
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}

code {
font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
monospace;
}
11 changes: 11 additions & 0 deletions src/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import React from 'react'
import ReactDOM from 'react-dom'
import './index.css'
import App from './App'

ReactDOM.render(
<React.StrictMode>
<App />
</React.StrictMode>,
document.getElementById('root')
);
48 changes: 48 additions & 0 deletions src/lib/hook.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import * as React from 'react'

const useGamePads = (onChangeGamePad: UseGamePadCallback) => {
const allGamePads = React.useRef<GamepadsConnectedRef>({})
const requestAnimationRef = React.useRef<number>()

const hasConnectedEvent = 'ongamepadconnected' in window

const addGamePad = (gamepad: Gamepad) => {
allGamePads.current = {
...allGamePads.current,
[gamepad.index]: gamepad
}
onChangeGamePad(allGamePads.current)
}

const onConnectGamePad = (e: GamepadEvent) => addGamePad(e.gamepad)

const scanAllGamePads = () => {
const detectedGamepads = navigator.getGamepads()
for (let i = 0; i < detectedGamepads.length; i++) {
const gamepadAtInd = detectedGamepads[i]
gamepadAtInd && addGamePad(gamepadAtInd)
}
}

React.useEffect(() => {
window.addEventListener('gamepadconnected', onConnectGamePad)
return () => window.removeEventListener('gamepadconnected', onConnectGamePad)
})

const gameLoop: FrameRequestCallback = (time) => {
if (!hasConnectedEvent) scanAllGamePads()
requestAnimationRef.current = requestAnimationFrame(gameLoop)
}

React.useEffect(() => {
requestAnimationRef.current = requestAnimationFrame(gameLoop)
return () => {
const currentTickerValue = requestAnimationRef.current
currentTickerValue && cancelAnimationFrame(currentTickerValue)
}
})

return allGamePads.current
}

export default useGamePads
64 changes: 64 additions & 0 deletions src/lib/how-to.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# React Use Gamepad Hook

---

## The `useGamepads` hook

This hook allows a React component to subscribe to the all gamepads and their input.

In this example, we are using an `xbox-utils` helper function to fetch gamepad input for the `A` button.

```typescript jsx
import React, { useState } from 'react';
import { useGamepads } from 'react-gamepads';
import * as xbox from 'xbox-utils'

export const Example: React.FC = () => {
const [gamepads, setGamepads] = useState({});
useGamepads(gamepads => setGamepads(gamepads));
return <div>{xbox.button(gamepads[0], 'A').pressed}</div>;
}
```

## Xbox Utils

Utility functions and types for fetching gamepad input objects using conventional labels.

Getting button input.

```typescript
// GamepadButton
xbox.button(gamepads[0], 'A')

// true if pressed, false otherwise
xbox.button(gamepads[0], 'A').pressed
```

Getting axes values for joysticks.

```typescript
// number from 0..1 ad
xbox.axesVertical(maybeXboxGamePad, 'L-Joy')
```

### Debug Widget (Xbox Only)

For debugging purposes we've provided an on-screen controller widget.
This widget mimics the input on the gamepad on-screen.

```typescript jsx
// Change gamepadInd to index of xbox controller on your local machine
const App: React.FC = () => {
return (
<AppContainer>
<XboxWidget gamepadInd={2}/>
</AppContainer>
)
}

export default App
```


![Screenshot](../widget/widget.png)

5 changes: 5 additions & 0 deletions src/lib/types/core.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type GamepadsConnectedRef = {
[ind: number]: Gamepad
}

type UseGamePadCallback = (s: GamepadsConnectedRef) => any
16 changes: 16 additions & 0 deletions src/lib/types/xbox.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// binary (true | false)
type XBoxAbxyBtns = 'A' | 'B' | 'X' | 'Y'
type XBoxDPadBtns = 'DPad-Up' | 'DPad-Right' | 'DPad-Down' | 'DPad-Left'
type XboxBumperBtns = 'L-Bumper' | 'R-Bumper'
type XboxSysBtns = 'Windows' | 'Menu'
// Axes
type XboxTriggers = 'L-Trigger' | 'R-Trigger'
type XboxJoySticks = 'L-Joy' | 'R-Joy'

type XboxBtnName =
XBoxAbxyBtns
| XBoxDPadBtns
| XboxBumperBtns
| XboxSysBtns
| XboxTriggers
| XboxJoySticks
Loading