Skip to content

Commit

Permalink
Up package versions
Browse files Browse the repository at this point in the history
  • Loading branch information
neki-dev committed Dec 29, 2023
1 parent e4559a1 commit 18f3fb0
Show file tree
Hide file tree
Showing 4 changed files with 1,542 additions and 1,398 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,25 @@ For each scene can be create one interface instance, which is container for all

.

* ### Install
Documentation

* [Install](https://github.com/neki-dev/phaser-react-ui?tab=readme-ov-file#install)
* [Integration](https://github.com/neki-dev/phaser-react-ui?tab=readme-ov-file#integration)
* [Hooks](https://github.com/neki-dev/phaser-react-ui?tab=readme-ov-file#hooks)
* [Components](https://github.com/neki-dev/phaser-react-ui?tab=readme-ov-file#components)
* [Utils](https://github.com/neki-dev/phaser-react-ui?tab=readme-ov-file#utils)
* [Example](https://github.com/neki-dev/phaser-react-ui?tab=readme-ov-file#example)

.


## Install

```sh
npm i phaser-react-ui
```

.

## Interface integration
## Integration
#### Add interface to scene
```ts
const ui = new Interface(scene: Phaser.Scene)
Expand Down Expand Up @@ -157,7 +167,6 @@ useInteraction(
.

## Components

#### Position relative to camera
```ts
<RelativePosition
Expand Down Expand Up @@ -217,8 +226,7 @@ const Component: React.FC = () => {

.

## Full example

## Example
#### Create interface component
```ts
import { useScene, useSceneUpdate, useEvent } from 'phaser-react-ui';
Expand Down
Loading

0 comments on commit 18f3fb0

Please sign in to comment.