Skip to content

Commit

Permalink
feat(react): Add useExperimental hook (#524)
Browse files Browse the repository at this point in the history
  • Loading branch information
manzt committed Apr 2, 2024
1 parent 8753d21 commit 0c62995
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 9 deletions.
5 changes: 5 additions & 0 deletions .changeset/sweet-needles-shop.md
@@ -0,0 +1,5 @@
---
"@anywidget/react": patch
---

Add `useExperimental` hook
5 changes: 5 additions & 0 deletions .changeset/thirty-pans-hope.md
@@ -0,0 +1,5 @@
---
"@anywidget/types": patch
---

Export `Experimental` type
34 changes: 26 additions & 8 deletions packages/react/index.js
@@ -1,14 +1,32 @@
import * as React from "react";
import * as ReactDOM from "react-dom/client";

/** @type {React.Context<import("@anywidget/types").AnyModel>} */
let ModelContext = React.createContext(/** @type {any} */ (null));
/**
* @typedef RenderContext
* @property {import("@anywidget/types").AnyModel} model
* @property {import("@anywidget/types").Experimental} experimental
*/

/** @type {React.Context<RenderContext>} */
let RenderContext = React.createContext(/** @type {any} */ (null));

/** @returns {RenderContext} */
function useRenderContext() {
let ctx = React.useContext(RenderContext);
if (!ctx) throw new Error("RenderContext not found");
return ctx;
}

/** @returns {import("@anywidget/types").AnyModel} */
export function useModel() {
let model = React.useContext(ModelContext);
if (!model) throw new Error("Model not found");
return model;
let ctx = useRenderContext();
return ctx.model;
}

/** @returns {import("@anywidget/types").Experimental} */
export function useExperimental() {
let ctx = useRenderContext();
return ctx.experimental;
}

/**
Expand Down Expand Up @@ -39,15 +57,15 @@ export function useModelState(key) {
* @returns {import("@anywidget/types").Render}
*/
export function createRender(Widget) {
return ({ model, el }) => {
return ({ el, model, experimental }) => {
let root = ReactDOM.createRoot(el);
root.render(
React.createElement(
React.StrictMode,
null,
React.createElement(
ModelContext.Provider,
{ value: model },
RenderContext.Provider,
{ value: { model, experimental } },
React.createElement(Widget),
),
),
Expand Down
2 changes: 1 addition & 1 deletion packages/types/index.ts
Expand Up @@ -43,7 +43,7 @@ export interface AnyModel<T extends ObjectHash = ObjectHash> {
widget_manager: IWidgetManager;
}

type Experimental = {
export type Experimental = {
invoke: <T>(
name: string,
msg?: any,
Expand Down

0 comments on commit 0c62995

Please sign in to comment.