feat(reactflow): generate types docs from TSDoc comments from d.ts files
#716
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@dimaMachina is attempting to deploy a commit to the xyflow Team on Vercel. A member of the Team first needs to authorize it. |
dimaMachina
commented
Mar 24, 2025
…eflow.dev (xyflow#755) * chore(deps): bump @xyflow/react in /sites/svelteflow.dev Bumps [@xyflow/react](https://github.com/xyflow/xyflow/tree/HEAD/packages/react) from 12.5.4 to 12.5.5. - [Release notes](https://github.com/xyflow/xyflow/releases) - [Changelog](https://github.com/xyflow/xyflow/blob/main/packages/react/CHANGELOG.md) - [Commits](https://github.com/xyflow/xyflow/commits/@xyflow/react@12.5.5/packages/react) --- updated-dependencies: - dependency-name: "@xyflow/react" dependency-version: 12.5.5 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update pnpm-lock.yaml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Abbey Yacoe <abbey@xyflow.com>
…-shared (xyflow#753) * chore(deps): bump @xyflow/react in /packages/xy-shared Bumps [@xyflow/react](https://github.com/xyflow/xyflow/tree/HEAD/packages/react) from 12.5.1 to 12.5.5. - [Release notes](https://github.com/xyflow/xyflow/releases) - [Changelog](https://github.com/xyflow/xyflow/blob/main/packages/react/CHANGELOG.md) - [Commits](https://github.com/xyflow/xyflow/commits/@xyflow/react@12.5.5/packages/react) --- updated-dependencies: - dependency-name: "@xyflow/react" dependency-version: 12.5.5 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update pnpm-lock.yaml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Abbey Yacoe <abbey@xyflow.com>
…w.com (xyflow#752) * chore(deps): bump @xyflow/react in /sites/xyflow.com Bumps [@xyflow/react](https://github.com/xyflow/xyflow/tree/HEAD/packages/react) from 12.5.4 to 12.5.5. - [Release notes](https://github.com/xyflow/xyflow/releases) - [Changelog](https://github.com/xyflow/xyflow/blob/main/packages/react/CHANGELOG.md) - [Commits](https://github.com/xyflow/xyflow/commits/@xyflow/react@12.5.5/packages/react) --- updated-dependencies: - dependency-name: "@xyflow/react" dependency-version: 12.5.5 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update pnpm-lock.yaml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Abbey Yacoe <abbey@xyflow.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
…flow.dev (xyflow#751) * chore(deps): bump @xyflow/react in /sites/reactflow.dev Bumps [@xyflow/react](https://github.com/xyflow/xyflow/tree/HEAD/packages/react) from 12.5.1 to 12.5.5. - [Release notes](https://github.com/xyflow/xyflow/releases) - [Changelog](https://github.com/xyflow/xyflow/blob/main/packages/react/CHANGELOG.md) - [Commits](https://github.com/xyflow/xyflow/commits/@xyflow/react@12.5.5/packages/react) --- updated-dependencies: - dependency-name: "@xyflow/react" dependency-version: 12.5.5 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update pnpm-lock.yaml --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Abbey Yacoe <abbey@xyflow.com>
moklick
requested changes
Apr 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #708
POC for - [x] `` - [x] `` - [x] `` - [x] `` - [x] `` - [x] `` - [x] ``API docs generated from TSDoc comments, should use new updated types from
fix: improve TSDoc comments for
BackgroundPropsxyflow#5109fix: improve TSDoc comments for
EdgeLabelOptionsandBaseEdgePropsxyflow#5110fix: improve TSDoc comments for
ControlPropsxyflow#5113feat: export
EdgeLabelRendererPropsxyflow#5114fix: improve TSDoc comments for
EdgeLabelOptionsandEdgeTextPropsxyflow#5115fix: improve TSDoc comments for
NodeToolbarPropsxyflow#5116fix: compare
nodeStrokeWidthwithnumber, not withstringxyflow#5144fix: improve TSDoc comments for
ReactFlowInstanceandGeneralHelpersxyflow#5143fix: improve TSDoc comments for HandleProps, NodeBase and
InternalNodeBasexyflow#5142fix: improve TSDoc comments for
Edge,BaseEdgePropsandConnectionLineComponentPropsxyflow#5141fix: improve TSDoc comments for
MiniMapPropsandPanelPropsxyflow#5140fix: use
rgbafor colors with opacity instead ofrgbxyflow#5139fix: improve TSDoc comments for
ViewportHelperFunctionsandNodeToolbarPropsxyflow#5138fix: improve TSDoc comments for
ConnectionandConnectionInProgressxyflow#5137fix: improve TSDoc comments for
EdgeBasexyflow#5136fix: improve TSDoc comments for
NodeResizerPropsandResizeControlPropsxyflow#5135fix
@defaultTSDoc tags forBackgroundPropsxyflow#5134Improve TSDoc comments for
BaseEdgePropsxyflow#5174Improve TSDoc comments for
useNodesData,useReactFlow,isNodeandisEdgexyflow#5172Improve TSDoc comments for
ReactFlowPropsxyflow#5171Improve TSDoc comments for
interface GetSimpleBezierPathParamsandgetSimpleBezierPathxyflow#5170Improve TSDoc comments for
type ReconnectEdgeOptionsandgetViewportForBoundsxyflow#5169Improve TSDoc comments for
getOutgoers,getIncomersandtype GetNodesBoundsParamsxyflow#5168Improve TSDoc comments for
useEdges,useInternalNode,useNodesanduseNodeIdhooks xyflow#5167Improve TSDoc comments for
useStorehook xyflow#5166Improve TSDoc comments for
useViewport,useUpdateNodeInternals,useOnSelectionChange,useNodesInitializedhooks andUseOnSelectionChangeOptions,UseNodesInitializedOptionstypes xyflow#5165Improve TSDoc comments for
type UseOnViewportChangeOptionsanduseOnViewportChangehook xyflow#5164Improve TSDoc comments for
useNodesStateanduseEdgesStatehook xyflow#5163Improve TSDoc comments for
type UseNodeConnectionsParamsanduseNodeConnectionshook xyflow#5162Improve TSDoc comments for
type UseKeyPressOptionsanduseKeyPresshook xyflow#5161Improve TSDoc comments for
type UseHandleConnectionsParamsanduseHandleConnectionshook xyflow#5160Improve TSDoc comments for
useConnectionhook xyflow#5159Fix typo
React Flow->Svelte Flowxyflow#5158Improve TSDoc comments for
type GetBezierPathParamsandgetBezierPathfunction xyflow#5157Improve TSDoc comments for
type GetSmoothStepPathParamsandgetSmoothStepPathfunction xyflow#5156Improve TSDoc comments for
type GetStraightPathParamsandgetStraightPathfunction xyflow#5155Use the newly generated properties table for all
/api-reference/...pagesScreen.Recording.2025-03-24.at.21.24.48.mov
and added
Type:/Default:on mobile