Skip to content

feat(reactflow): generate types docs from TSDoc comments from d.ts files #716

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.

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

Merged
merged 133 commits into from
Apr 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
133 commits
Select commit Hold shift + click to select a range
5901d63
api docs
dimaMachina Mar 24, 2025
aba5e1b
api docs
dimaMachina Mar 24, 2025
68491ec
remove prefix x:
dimaMachina Mar 24, 2025
41583c4
more
dimaMachina Mar 24, 2025
f3effda
cleanup
dimaMachina Mar 24, 2025
67e1167
background is good
dimaMachina Mar 24, 2025
7a17452
okok
dimaMachina Mar 24, 2025
0d3e3aa
lint
dimaMachina Mar 24, 2025
7eba3b7
rm unused
dimaMachina Mar 24, 2025
4be0cd6
migrate BaseEdgeProps
dimaMachina Mar 24, 2025
89fbc0d
fix background props table
dimaMachina Mar 25, 2025
fbdf8be
add ControlProps
dimaMachina Mar 25, 2025
bf2464b
EdgeLabelRenderer
dimaMachina Mar 25, 2025
10ecd93
EdgeText
dimaMachina Mar 25, 2025
791d71f
NodeToolbarProps
dimaMachina Mar 25, 2025
1b2c74e
NodeResizer
dimaMachina Mar 25, 2025
636b375
refactor for better DX
dimaMachina Mar 25, 2025
c1f899a
Merge branch 'main' into api-docs
dimaMachina Mar 31, 2025
66ea6d8
rm nextra/typescript
dimaMachina Mar 31, 2025
4dcc872
connection type
dimaMachina Apr 1, 2025
0c6e844
ConnectionLineComponentProps.fields.ts
dimaMachina Apr 1, 2025
592ab28
ConnectionState
dimaMachina Apr 1, 2025
92c60db
DefaultEdgeOptions
dimaMachina Apr 1, 2025
bb0588d
Edge
dimaMachina Apr 1, 2025
63863bc
EdgeChange
dimaMachina Apr 1, 2025
a307e43
EdgeMarker
dimaMachina Apr 1, 2025
57c2c52
fit-view-options
dimaMachina Apr 1, 2025
afebd9d
MiniMapNodeProps
dimaMachina Apr 1, 2025
4f149b9
add HandleConnection
dimaMachina Apr 1, 2025
ea890aa
NodeBase
dimaMachina Apr 1, 2025
e0982e8
NodeChange
dimaMachina Apr 1, 2025
5528a4a
Handle
dimaMachina Apr 1, 2025
3262984
NodeConnection
dimaMachina Apr 1, 2025
e2b6d19
Viewport
dimaMachina Apr 1, 2025
522c9ff
ResizeParams
dimaMachina Apr 1, 2025
1fd79ae
NodeProps
dimaMachina Apr 1, 2025
b0b7599
EdgeProps
dimaMachina Apr 1, 2025
726d969
ReactFlowJsonObject
dimaMachina Apr 1, 2025
1072ebf
ReactFlowInstance
dimaMachina Apr 1, 2025
0760a6e
PanelProps
dimaMachina Apr 1, 2025
aa5e99b
ViewportPortal
dimaMachina Apr 1, 2025
ca20a83
NodeToolbar
dimaMachina Apr 1, 2025
fb19a68
NodeResizer
dimaMachina Apr 1, 2025
cd5e123
NodeResizeControl
dimaMachina Apr 1, 2025
af10490
minimap props
dimaMachina Apr 1, 2025
fc93ec8
Handle
dimaMachina Apr 1, 2025
2acd9c9
EdgeText
dimaMachina Apr 1, 2025
8816e6c
EdgeLabelRenderer
dimaMachina Apr 1, 2025
9fa62eb
Controls
dimaMachina Apr 1, 2025
5afaecc
ControlButton
dimaMachina Apr 1, 2025
6e3611e
BaseEdge
dimaMachina Apr 1, 2025
5999826
Background
dimaMachina Apr 1, 2025
ab9c002
upd
dimaMachina Apr 1, 2025
1cf4fcb
InternalNode
dimaMachina Apr 1, 2025
c34a507
Edge
dimaMachina Apr 1, 2025
062ae32
react-flow-instance.tsx
dimaMachina Apr 1, 2025
fe1a9ae
upd
dimaMachina Apr 1, 2025
c5adb01
upd
dimaMachina Apr 1, 2025
b576584
useReactFlow
dimaMachina Apr 1, 2025
d48453b
upd
dimaMachina Apr 1, 2025
2042ae0
fix lock file
dimaMachina Apr 1, 2025
be2019c
upd
dimaMachina Apr 1, 2025
c257497
Merge branch 'main' into api-docs
dimaMachina Apr 1, 2025
da828a8
build pass
dimaMachina Apr 1, 2025
f239df1
Merge branch 'main' into api-docs
dimaMachina Apr 2, 2025
02379ae
useInternalNode
dimaMachina Apr 3, 2025
a961be7
useNodeConnections
dimaMachina Apr 3, 2025
9daac4e
useConnection
dimaMachina Apr 3, 2025
ba9124b
useHandleConnections
dimaMachina Apr 3, 2025
5226ae4
useNodesInitialized
dimaMachina Apr 3, 2025
e9f92f9
useOnSelectionChange
dimaMachina Apr 4, 2025
740ec89
useOnViewportChange
dimaMachina Apr 4, 2025
7e7f9e0
useStore
dimaMachina Apr 4, 2025
23db6ca
addEdge
dimaMachina Apr 4, 2025
8d8b7ef
applyEdgeChanges
dimaMachina Apr 4, 2025
04fbedf
applyNodeChanges
dimaMachina Apr 4, 2025
ada12be
getConnectedEdges
dimaMachina Apr 4, 2025
d23ddf7
getIncomers
dimaMachina Apr 4, 2025
2fc5952
getOutgoers
dimaMachina Apr 4, 2025
f901ba4
getViewportForBounds
dimaMachina Apr 4, 2025
19c6c8d
isEdge and isNode
dimaMachina Apr 4, 2025
0058d39
reconnectEdge
dimaMachina Apr 4, 2025
dfa4443
more
dimaMachina Apr 4, 2025
e9a3d99
edgeProps
dimaMachina Apr 4, 2025
fdd407f
nodeEvents
dimaMachina Apr 4, 2025
7f1fd88
selectionEvents
dimaMachina Apr 4, 2025
5906d0d
fix common props
dimaMachina Apr 4, 2025
fd7b27d
paneEvents
dimaMachina Apr 4, 2025
bf09f96
styleProps
dimaMachina Apr 4, 2025
6eb7e66
generalEventHandlerProps
dimaMachina Apr 4, 2025
0aeb4e5
edgeEventHandlerProps
dimaMachina Apr 4, 2025
3f08e05
OnEdgesChange and OnNodesChange
dimaMachina Apr 4, 2025
193b4ff
getNodesBounds
dimaMachina Apr 4, 2025
e7f246d
useNodeId
dimaMachina Apr 4, 2025
c6d0845
useViewport
dimaMachina Apr 4, 2025
c544197
useEdges
dimaMachina Apr 4, 2025
969ff0c
useNodes
dimaMachina Apr 4, 2025
6d4ffe1
ts
dimaMachina Apr 4, 2025
0a9a2a6
useReactFlow
dimaMachina Apr 4, 2025
3d396d8
remove fields since it's exist on dedicated page
dimaMachina Apr 4, 2025
685afa6
useUpdateNodeInternals
dimaMachina Apr 4, 2025
8a425b8
useStoreApi
dimaMachina Apr 4, 2025
5dcea38
useEdgesState
dimaMachina Apr 5, 2025
8c44f7a
useNodesState
dimaMachina Apr 5, 2025
114d11c
getStraightPath
dimaMachina Apr 5, 2025
7ba3af1
getBezierPath
dimaMachina Apr 5, 2025
6527016
getSimpleBezierPath
dimaMachina Apr 5, 2025
9378efb
getTransformForBounds
dimaMachina Apr 5, 2025
d145ad0
getSmoothStepPath
dimaMachina Apr 5, 2025
70d5b27
connectionEvents
dimaMachina Apr 5, 2025
a2dc9aa
interactionProps
dimaMachina Apr 6, 2025
f31932c
connectionLineProps
dimaMachina Apr 6, 2025
4b0fb83
keyboardProps
dimaMachina Apr 6, 2025
b50b036
commonProps
dimaMachina Apr 6, 2025
d2e6d71
useNodesData
dimaMachina Apr 6, 2025
e9f5c37
bump nextra
dimaMachina Apr 6, 2025
54a4e31
upd base-edge
dimaMachina Apr 6, 2025
b984f5d
chore(reactflow): use latest version
moklick Apr 7, 2025
73c6b7f
Merge branch 'main' into api-docs
moklick Apr 7, 2025
308edce
Update sites/reactflow.dev/src/content/api-reference/react-flow.mdx
dimaMachina Apr 8, 2025
c88e2fb
fix(tutorials): remove bleed component and index page (#756)
chrtze Apr 9, 2025
80d372f
chore(deps): bump @xyflow/react from 12.5.4 to 12.5.5 in /sites/svelt…
dependabot[bot] Apr 9, 2025
bec6165
chore(deps): bump @xyflow/react from 12.5.1 to 12.5.5 in /packages/xy…
dependabot[bot] Apr 9, 2025
2dfba46
chore(deps): bump @xyflow/react from 12.5.4 to 12.5.5 in /sites/xyflo…
dependabot[bot] Apr 9, 2025
857938e
#758 fix: drag and drop needs onDragStart handler for Opera
printerscanner Apr 9, 2025
f8ff43f
Add What's New section for @xyflow/react@12.5.5 (#749)
github-actions[bot] Apr 9, 2025
6b600f3
Add What's New section for @xyflow/svelte@0.1.35 (#750)
github-actions[bot] Apr 9, 2025
e709ff2
chore(deps): bump @xyflow/react from 12.5.1 to 12.5.5 in /sites/react…
dependabot[bot] Apr 9, 2025
9abf4c2
feat(playground): add links to playground app in sidebar (#757)
chrtze Apr 9, 2025
7c58135
use latest nextra with review fixes
dimaMachina Apr 12, 2025
00875bf
Merge branch 'main' into api-docs
dimaMachina Apr 12, 2025
b77fc24
extract `<APIDocs />` in `components/api-docs.tsx`
dimaMachina Apr 14, 2025
aa6182e
bump nextra and simple sentence for `noParametersContent`
dimaMachina Apr 14, 2025
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ tmp
vite.config.ts.*
.idea/
tsconfig.tsbuildinfo
dist/
3 changes: 1 addition & 2 deletions apps/example-apps/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ lerna-debug.log*


node_modules
dist
dist-ssr
*.local

Expand All @@ -27,4 +26,4 @@ dist-ssr
public/

# Vite temporary files
*.timestamp-*.mjs
*.timestamp-*.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/** @type {import('tailwindcss').Config} */
import { Config } from 'tailwindcss';

export default {
content: [
'./src/**/*.{js,ts,jsx,tsx,mdx}',
Expand Down Expand Up @@ -88,12 +89,12 @@ export default {
},
keyframes: {
'accordion-down': {
from: { height: 0 },
from: { height: '0' },
to: { height: 'var(--radix-accordion-content-height)' },
},
'accordion-up': {
from: { height: 'var(--radix-accordion-content-height)' },
to: { height: 0 },
to: { height: '0' },
},
},
animation: {
Expand All @@ -103,4 +104,4 @@ export default {
},
},
plugins: [],
};
} satisfies Config;
13 changes: 8 additions & 5 deletions packages/xy-shared/components/fathom.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
'use client';

import { load, trackPageview } from 'fathom-client';
import { useEffect, Suspense } from 'react';
import { useEffect, Suspense, FC } from 'react';
import { usePathname, useSearchParams } from 'next/navigation';

function TrackPageView({ id, domains }: { id: string; domains?: string[] }) {
const TrackPageView: FC<{ id: string; domains?: string[] }> = ({
id,
domains,
}) => {
const pathname = usePathname();
const searchParams = useSearchParams();

Expand All @@ -25,9 +28,9 @@ function TrackPageView({ id, domains }: { id: string; domains?: string[] }) {
}, [pathname, searchParams]);

return null;
}
};

export function Fathom(props: { id: string; domains?: string[] }) {
export const Fathom: FC<{ id: string; domains?: string[] }> = (props) => {
if (process.env.NODE_ENV !== 'production') {
return null;
}
Expand All @@ -36,4 +39,4 @@ export function Fathom(props: { id: string; domains?: string[] }) {
<TrackPageView {...props} />
</Suspense>
);
}
};
2 changes: 1 addition & 1 deletion packages/xy-shared/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"clsx": "^2.1.1",
"fathom-client": "^3.7.2",
"next": "^14.2.15",
"nextra": "4.2.13",
"nextra": "4.3.0-alpha.19",
"react-player": "^2.16.0",
"tailwindcss": "^3.4.14",
"tailwindcss-animate": "^1.0.7",
Expand Down
Loading