Skip to content
Merged
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
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# @webgui/react

> **Deprecated.** Use [`@webgui/client`](https://www.npmjs.com/package/@webgui/client) instead.
>
> ```bash
> npm install @webgui/client
> ```
>
> ```diff
> -import { ... } from '@webgui/react'
> +import { ... } from '@webgui/client/react'
> ```
>
> The React API is unchanged — this package now re-exports `@webgui/client/react`,
> so nothing breaks if you stay. New events and hooks land in `@webgui/client` only.

---


> **Requires the [WebGUI Minecraft mod](https://modrinth.com/mod/webgui)** ([GitHub](https://github.com/mc-webgui/webgui)) to be installed on the client. This library has no effect outside of the mod.

React hooks and TypeScript types for SPAs running inside the **WebGUI** Minecraft mod (free edition).
Expand Down
38 changes: 33 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@webgui/react",
"version": "1.6.0",
"description": "React hooks and types for the WebGUI Minecraft mod — access window.webgui client data from any SPA.",
"version": "1.8.0",
"description": "Deprecated — use @webgui/client/react. Re-export kept for existing installs.",
"keywords": [
"minecraft",
"webgui",
Expand Down Expand Up @@ -63,5 +63,8 @@
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@webgui/client": "^1.8.0"
}
}
32 changes: 0 additions & 32 deletions src/entityStore.ts

This file was deleted.

9 changes: 0 additions & 9 deletions src/hooks/useCloseGui.ts

This file was deleted.

9 changes: 0 additions & 9 deletions src/hooks/usePostToGame.ts

This file was deleted.

13 changes: 0 additions & 13 deletions src/hooks/useRunCommand.ts

This file was deleted.

7 changes: 0 additions & 7 deletions src/hooks/useWebGUIClient.ts

This file was deleted.

21 changes: 0 additions & 21 deletions src/hooks/useWebGUIEntity.ts

This file was deleted.

25 changes: 0 additions & 25 deletions src/hooks/useWebGUIEvent.ts

This file was deleted.

26 changes: 0 additions & 26 deletions src/hooks/useWebGUISelector.ts

This file was deleted.

25 changes: 0 additions & 25 deletions src/hooks/useWebGUIToken.ts

This file was deleted.

40 changes: 10 additions & 30 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,30 +1,10 @@
// Types
export type {
Vec3,
ServerInfo,
WebviewMode,
Gamemode,
Look,
WebGUIClient,
WebGUIEntity,
WebGUINamespace,
PostToGameLog,
PostToGameMessage,
PostToGamePayload,
} from './types';

// Utils
export { isInMod, isReady } from './utils';

// Commands
export { runCommand } from './runCommand';

// Hooks
export { useWebGUIClient } from './hooks/useWebGUIClient';
export { useWebGUIEntity } from './hooks/useWebGUIEntity';
export { usePostToGame } from './hooks/usePostToGame';
export { useWebGUISelector } from './hooks/useWebGUISelector';
export { useCloseGui } from './hooks/useCloseGui';
export { useWebGUIToken } from './hooks/useWebGUIToken';
export { useWebGUIEvent } from './hooks/useWebGUIEvent';
export { useRunCommand } from './hooks/useRunCommand';
/**
* @deprecated Use `@webgui/client/react` instead.
*
* This package is now a re-export of that one, kept so existing installs keep working.
* The names are identical, so migrating is a change of import path:
*
* -import { ... } from '@webgui/react'
* +import { ... } from '@webgui/client/react'
*/
export * from '@webgui/client/react';
16 changes: 0 additions & 16 deletions src/runCommand.ts

This file was deleted.

33 changes: 0 additions & 33 deletions src/store.ts

This file was deleted.

Loading
Loading