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
4 changes: 2 additions & 2 deletions packages/joint-react/src/components/graph/graph-provider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export interface GraphProviderProps<
/**
* Pre-existing JointJS graph instance to use. If omitted, GraphProvider
* creates a fresh `new dia.Graph(...)`.
* @see https://docs.jointjs.com/api/dia/Graph
* @see [`dia.Graph`](https://docs.jointjs.com/api/dia/Graph)
*/
readonly graph?: dia.Graph;
/** React children rendered inside the provider, typically a `<Paper />`. */
Expand All @@ -43,7 +43,7 @@ export interface GraphProviderProps<
* Base model class used for every cell the graph constructs from JSON. Maps to
* the (deprecated) `cellModel` option of `dia.Graph`; prefer `cellNamespace`,
* which registers shapes by `type` and supports per-type model classes.
* @see https://docs.jointjs.com/api/dia/Graph
* @see [`dia.Graph`](https://docs.jointjs.com/api/dia/Graph)
*/
readonly cellModel?: typeof dia.Cell;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/joint-react/src/components/paper/paper.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ export type RenderLink<LinkData = unknown> = (data: LinkData) => ReactNode;
* re-subscription on render. For raw native event names or events without an
* `on*` form (`render:done`, `cell:highlight`, …), use the {@link useOnPaperEvents}
* hook.
* @see https://docs.jointjs.com/api/dia/Paper
* @see [`dia.Paper`](https://docs.jointjs.com/api/dia/Paper)
* @expand
* @group Types
*/
Expand Down
8 changes: 4 additions & 4 deletions packages/joint-react/src/hooks/use-paper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,19 @@ export interface PaperApi {
/**
* Trigger a render pass on the paper. Forwards to `paper.wakeUp()`.
* No-op when the paper isn't resolved yet.
* @see https://docs.jointjs.com/api/dia/Paper#wakeUp
* @see [`paper.wakeUp()`](https://docs.jointjs.com/api/dia/Paper#wakeup)
*/
readonly wakeUp: () => void;
/**
* Suspend view updates so edits don't repaint until {@link PaperApi.unfreeze}.
* Forwards to `paper.freeze()`. No-op when the paper isn't resolved yet.
* @see https://docs.jointjs.com/api/dia/Paper#freeze
* @see [`paper.freeze()`](https://docs.jointjs.com/api/dia/Paper#freeze)
*/
readonly freeze: () => void;
/**
* Resume view updates and flush everything queued while frozen. Forwards to
* `paper.unfreeze()`. No-op when the paper isn't resolved yet.
* @see https://docs.jointjs.com/api/dia/Paper#unfreeze
* @see [`paper.unfreeze()`](https://docs.jointjs.com/api/dia/Paper#unfreeze)
*/
readonly unfreeze: () => void;
}
Expand All @@ -109,7 +109,7 @@ export interface PaperApi {
* @param paperId - An explicit paper id, or omitted for the context/default paper.
* @returns The {@link PaperApi}: the resolved `paper` (or `null`) plus `wakeUp`,
* `freeze`, and `unfreeze` actions.
* @see https://docs.jointjs.com/learn/quickstart/paper
* @see [Paper quickstart](https://docs.jointjs.com/learn/quickstart/paper)
* @group Hooks
* @example
* ```tsx
Expand Down
Loading