chore(tsdocs): cleanup

packages/react/src/additional-components/Controls/types.ts

@@ -3,6 +3,9 @@ import type { PanelPosition } from '@xyflow/system';
 
 import type { FitViewOptions } from '../../types';
 
+/**
+ * @expand
+ */
 export type ControlProps = {
   /** Show button for zoom in/out */
   showZoom?: boolean;
@@ -35,4 +38,7 @@ export type ControlProps = {
   orientation?: 'horizontal' | 'vertical';
 };
 
+/**
+ * @expand
+ */
 export type ControlButtonProps = ButtonHTMLAttributes<HTMLButtonElement>;

packages/react/src/additional-components/MiniMap/types.ts

@@ -6,6 +6,9 @@ import type { Node } from '../../types';
 
 export type GetMiniMapNodeAttribute<NodeType extends Node = Node> = (node: NodeType) => string;
 
+/**
+ * @expand
+ */
 export type MiniMapProps<NodeType extends Node = Node> = Omit<HTMLAttributes<SVGSVGElement>, 'onClick'> & {
   /** Color of nodes on minimap */
   nodeColor?: string | GetMiniMapNodeAttribute<NodeType>;
@@ -62,6 +65,7 @@ export type MiniMapNodes<NodeType extends Node = Node> = Pick<
  * The props that are passed to the MiniMapNode component
  *
  * @public
+ * @expand
  */
 export type MiniMapNodeProps = {
   id: string;

packages/react/src/additional-components/NodeResizer/types.ts

@@ -9,6 +9,9 @@ import type {
   OnResizeEnd,
 } from '@xyflow/system';
 
+/**
+ * @expand
+ */
 export type NodeResizerProps = {
   /**
    * Id of the node it is resizing
@@ -47,6 +50,9 @@ export type NodeResizerProps = {
   onResizeEnd?: OnResizeEnd;
 };
 
+/**
+ * @expand
+ */
 export type ResizeControlProps = Pick<
   NodeResizerProps,
   | 'nodeId'
@@ -77,6 +83,9 @@ export type ResizeControlProps = Pick<
   children?: ReactNode;
 };
 
+/**
+ * @expand
+ */
 export type ResizeControlLineProps = ResizeControlProps & {
   position?: ControlLinePosition;
 };

packages/react/src/additional-components/NodeToolbar/types.ts

@@ -1,6 +1,9 @@
 import type { HTMLAttributes } from 'react';
 import type { Position, Align } from '@xyflow/system';
 
+/**
+ * @expand
+ */
 export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & {
   /** Id of the node, or array of ids the toolbar should be displayed at */
   nodeId?: string | string[];

packages/react/src/components/Handle/index.tsx

@@ -28,10 +28,14 @@ import { useNodeId } from '../../contexts/NodeIdContext';
 import { type ReactFlowState } from '../../types';
 import { fixedForwardRef } from '../../utils';
 
-export interface HandleProps extends HandlePropsSystem, Omit<HTMLAttributes<HTMLDivElement>, 'id'> {
+/**
-  /** Callback called when connection is made */
+ * @expand
-  onConnect?: OnConnect;
+ */
-}
+export type HandleProps = HandlePropsSystem &
+  Omit<HTMLAttributes<HTMLDivElement>, 'id'> & {
+    /** Callback called when connection is made */
+    onConnect?: OnConnect;
+  };
 
 const selector = (s: ReactFlowState) => ({
   connectOnClick: s.connectOnClick,

packages/react/src/components/Panel/index.tsx

@@ -5,6 +5,19 @@ import type { PanelPosition } from '@xyflow/system';
 import { useStore } from '../../hooks/useStore';
 import type { ReactFlowState } from '../../types';
 
+/**
+ * @expand
+ */
+export type PanelProps = HTMLAttributes<HTMLDivElement> & {
+  /**
+   * The position of the panel
+   */
+  position?: PanelPosition;
+  children: ReactNode;
+};
+
+const selector = (s: ReactFlowState) => (s.userSelectionActive ? 'none' : 'all');
+
 /**
  * The `<Panel />` component helps you position content above the viewport.
  * It is used internally by the [`<MiniMap />`](/api-reference/components/minimap)
@@ -30,16 +43,6 @@ import type { ReactFlowState } from '../../types';
  *}
  *```
  */
-export type PanelProps = HTMLAttributes<HTMLDivElement> & {
-  /**
-   * The position of the panel
-   */
-  position?: PanelPosition;
-  children: ReactNode;
-};
-
-const selector = (s: ReactFlowState) => (s.userSelectionActive ? 'none' : 'all');
-
 export const Panel = forwardRef<HTMLDivElement, PanelProps>(
   ({ position = 'top-left', children, className, style, ...rest }, ref) => {
     const pointerEvents = useStore(selector);

packages/react/src/types/edges.ts

@@ -132,6 +132,7 @@ export type EdgeProps<EdgeType extends Edge = Edge> = Pick<
 /**
  * BaseEdge component props
  * @public
+ * @expand
  */
 export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd'> &
   EdgeLabelOptions & {
@@ -148,6 +149,7 @@ export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd'> &
 /**
  * Helper type for edge components that get exported by the library
  * @public
+ * @expand
  */
 export type EdgeComponentProps = EdgePosition &
   EdgeLabelOptions & {
@@ -167,30 +169,35 @@ export type EdgeComponentWithPathOptions<PathOptions> = EdgeComponentProps & {
 /**
  * BezierEdge component props
  * @public
+ * @expand
  */
 export type BezierEdgeProps = EdgeComponentWithPathOptions<BezierPathOptions>;
 
 /**
  * SmoothStepEdge component props
  * @public
+ * @expand
  */
 export type SmoothStepEdgeProps = EdgeComponentWithPathOptions<SmoothStepPathOptions>;
 
 /**
  * StepEdge component props
  * @public
+ * @expand
  */
 export type StepEdgeProps = EdgeComponentWithPathOptions<StepPathOptions>;
 
 /**
  * StraightEdge component props
  * @public
+ * @expand
  */
 export type StraightEdgeProps = Omit<EdgeComponentProps, 'sourcePosition' | 'targetPosition'>;
 
 /**
  * SimpleBezier component props
  * @public
+ * @expand
  */
 export type SimpleBezierEdgeProps = EdgeComponentProps;
 

packages/system/src/types/edges.ts

@@ -118,6 +118,9 @@ export type MarkerProps = EdgeMarker & {
   id: string;
 };
 
+/**
+ * @inline
+ */
 export type EdgePosition = {
   sourceX: number;
   sourceY: number;

packages/system/src/xyresizer/types.ts

@@ -11,10 +11,25 @@ export type ResizeParamsWithDirection = ResizeParams & {
   direction: number[];
 };
 
+/**
+ * Used to determine the control line position of the NodeResizer
+ *
+ * @public
+ */
 export type ControlLinePosition = 'top' | 'bottom' | 'left' | 'right';
 
+/**
+ * Used to determine the control position of the NodeResizer
+ *
+ * @public
+ */
 export type ControlPosition = ControlLinePosition | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 
+/**
+ * Used to determine the variant of the resize control
+ *
+ * @public
+ */
 export enum ResizeControlVariant {
   Line = 'line',
   Handle = 'handle',