Skip to content

fix: add generic props type for NodeData #330

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: v0.1.x
Choose a base branch
from
Open

fix: add generic props type for NodeData #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions packages/core/src/interfaces/nodes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ export type UserComponent<T = any> = React.ComponentType<T> & {
export type NodeId = string;
export type NodeEventTypes = 'selected' | 'dragged' | 'hovered';

export type Node = {
export type Node<P = any> = {
id: NodeId;
data: NodeData;
data: NodeData<P>;
events: Record<NodeEventTypes, boolean>;
dom: HTMLElement | null;
related: Record<string, React.ElementType>;
Expand All @@ -42,7 +42,7 @@ export type NodeRules = {
};
export type NodeRelated = Record<string, React.ElementType>;

export type NodeData = {
export type NodeData<P = any> = {
props: Record<string, any>;
type: string | React.ElementType;
name: string;
Expand Down
22 changes: 11 additions & 11 deletions packages/core/src/nodes/useInternalNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@ import { NodeContext, NodeContextType } from './NodeContext';
import { useInternalEditor } from '../editor/useInternalEditor';
import { Node } from '../interfaces';

type internalActions = NodeContextType & {
type internalActions<P = any> = NodeContextType & {
inNodeContext: boolean;
actions: {
setProp: (cb: (props: any) => void, throttleRate?: number) => void;
setProp: (cb: (props: P) => void, throttleRate?: number) => void;
setCustom: (cb: (custom: any) => void, throttleRate?: number) => void;
setHidden: (bool: boolean) => void;
};
};

// TODO: Deprecate useInternalNode in favor of useNode
export type useInternalNodeReturnType<S = null> = S extends null
? internalActions
: S & internalActions;
export type useInternalNodeReturnType<S = null, P = any> = S extends null
? internalActions<P>
: S & internalActions<P>;
export function useInternalNode(): useInternalNodeReturnType;
export function useInternalNode<S = null>(
collect?: (node: Node) => S
): useInternalNodeReturnType<S>;
export function useInternalNode<S = null>(
collect?: (node: Node) => S
): useInternalNodeReturnType<S> {
export function useInternalNode<S = null, P = any>(
collect?: (node: Node<P>) => S
): useInternalNodeReturnType<S, P>;
export function useInternalNode<S = null, P = any>(
collect?: (node: Node<P>) => S
): useInternalNodeReturnType<S, P> {
const context = useContext(NodeContext);
invariant(context, ERROR_USE_NODE_OUTSIDE_OF_EDITOR_CONTEXT);

Expand Down