alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add panOnScroll options to documentation

Browse Source
This commit is contained in:
Christopher Möller
2020-11-03 16:26:43 +01:00
parent de1f7dba5d
commit 0eeb632dde
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/src/markdown/docs/api/component-props.md
+3 -1
View File
@@ -53,7 +53,9 @@ import ReactFlow from 'react-flow-renderer';
- `nodesDraggable`: default: `true`. This applies to all nodes. You can also change the behavior of a specific node with the `draggable` node option - `nodesDraggable`: default: `true`. This applies to all nodes. You can also change the behavior of a specific node with the `draggable` node option
- `nodesConnectable`: default: `true`. This applies to all nodes. You can also change the behavior of a specific node with the `connectable` node option - `nodesConnectable`: default: `true`. This applies to all nodes. You can also change the behavior of a specific node with the `connectable` node option
- `elementsSelectable`: default: `true`. This applies to all elements. You can also change the behavior of a specific node with the `selectable` node option - `elementsSelectable`: default: `true`. This applies to all elements. You can also change the behavior of a specific node with the `selectable` node option
- `zoomOnScroll`: default: `true` - `zoomOnScroll`: default: `true`. Zoom the graph in and out using the mousewheel or trackpad
- `panOnScroll`: default: `false`. Move the graph while keeping the zoomlevel using mousewheel or trackpad. Overwrites `zoomOnScroll`.
- `panOnScrollSpeed`: default: `0.5`. Controls how fast the canvas is moved while using the mousewheel. Only has an effect if `panOnScroll` is enabled.
- `zoomOnDoubleClick`: default: `true` - `zoomOnDoubleClick`: default: `true`
- `selectNodesOnDrag`: default: `true` - `selectNodesOnDrag`: default: `true`
- `paneMoveable`: default: `true` - If set to `false`, panning and zooming is disabled - `paneMoveable`: default: `true` - If set to `false`, panning and zooming is disabled
website/src/markdown/docs/api/handle.md
+2 -2
View File
@@ -23,8 +23,8 @@ const targetHandleWithValidation = (
- `type`: 'source' or 'target' - `type`: 'source' or 'target'
- `id`: string - you only need this when you have multiple source or target handles (otherwise the node id is used) - `id`: string - you only need this when you have multiple source or target handles (otherwise the node id is used)
- `position`: 'left', 'right', 'top' or 'bottom' handle position - default: 'top' for type target, 'bottom' for type source - `position`: 'left', 'right', 'top' or 'bottom' handle position - default: 'top' for type target, 'bottom' for type source
- `onConnect`: function that gets triggered on connect - `onConnect`: function that gets triggered on connect. This callback only gets executed on source handles.
- `isValidConnection`: function receives a connection `{ target: 'some-id', source: 'another-id', sourceHandle: 'source handle id or null', targetHandle: 'target handle id or null' }` as param, returns a boolean - default: `true` - `isValidConnection`: function receives a connection `{ target: 'some-id', source: 'another-id', sourceHandle: 'source handle id or null', targetHandle: 'target handle id or null' }` as param, returns a boolean - default: `true`.
- `style`: css properties - `style`: css properties
- `className`: additional class name - `className`: additional class name