chore(docs): add comments to flow props
This commit is contained in:
+6
-1
@@ -83,11 +83,12 @@ export type FlowInstance<N = any, E = N> = {
|
|||||||
|
|
||||||
export interface FlowProps<N = any, E = N> {
|
export interface FlowProps<N = any, E = N> {
|
||||||
id?: string
|
id?: string
|
||||||
/** @deprecated use nodes / edges instead */
|
|
||||||
modelValue?: Elements<N, E>
|
modelValue?: Elements<N, E>
|
||||||
nodes?: Node<N>[]
|
nodes?: Node<N>[]
|
||||||
edges?: Edge<E>[]
|
edges?: Edge<E>[]
|
||||||
|
/** either use the edgeTypes prop to define your edge-types or use slots (<template #edge-mySpecialType="props">) */
|
||||||
edgeTypes?: { [key in keyof DefaultEdgeTypes]?: EdgeComponent } & { [key: string]: EdgeComponent }
|
edgeTypes?: { [key in keyof DefaultEdgeTypes]?: EdgeComponent } & { [key: string]: EdgeComponent }
|
||||||
|
/** either use the nodeTypes prop to define your node-types or use slots (<template #node-mySpecialType="props">) */
|
||||||
nodeTypes?: { [key in keyof DefaultNodeTypes]?: NodeComponent } & { [key: string]: NodeComponent }
|
nodeTypes?: { [key in keyof DefaultNodeTypes]?: NodeComponent } & { [key: string]: NodeComponent }
|
||||||
connectionMode?: ConnectionMode
|
connectionMode?: ConnectionMode
|
||||||
connectionLineType?: ConnectionLineType
|
connectionLineType?: ConnectionLineType
|
||||||
@@ -104,6 +105,7 @@ export interface FlowProps<N = any, E = N> {
|
|||||||
nodesConnectable?: boolean
|
nodesConnectable?: boolean
|
||||||
elementsSelectable?: boolean
|
elementsSelectable?: boolean
|
||||||
selectNodesOnDrag?: boolean
|
selectNodesOnDrag?: boolean
|
||||||
|
/** move pane on drag, replaced prop `paneMovable` */
|
||||||
panOnDrag?: boolean
|
panOnDrag?: boolean
|
||||||
minZoom?: number
|
minZoom?: number
|
||||||
maxZoom?: number
|
maxZoom?: number
|
||||||
@@ -118,15 +120,18 @@ export interface FlowProps<N = any, E = N> {
|
|||||||
panOnScrollSpeed?: number
|
panOnScrollSpeed?: number
|
||||||
panOnScrollMode?: PanOnScrollMode
|
panOnScrollMode?: PanOnScrollMode
|
||||||
zoomOnDoubleClick?: boolean
|
zoomOnDoubleClick?: boolean
|
||||||
|
/** enable this to prevent vue flow from scrolling inside the container, i.e. allow for the page to scroll */
|
||||||
preventScrolling?: boolean
|
preventScrolling?: boolean
|
||||||
edgeUpdaterRadius?: number
|
edgeUpdaterRadius?: number
|
||||||
fitViewOnInit?: boolean
|
fitViewOnInit?: boolean
|
||||||
|
/** allow connection with click handlers, i.e. support touch devices */
|
||||||
connectOnClick?: boolean
|
connectOnClick?: boolean
|
||||||
/** apply default change handlers for position, dimensions, adding/removing nodes. set this to false if you want to apply the changes manually */
|
/** apply default change handlers for position, dimensions, adding/removing nodes. set this to false if you want to apply the changes manually */
|
||||||
applyDefault?: boolean
|
applyDefault?: boolean
|
||||||
noDragClassName?: string
|
noDragClassName?: string
|
||||||
noWheelClassName?: string
|
noWheelClassName?: string
|
||||||
noPanClassName?: string
|
noPanClassName?: string
|
||||||
|
/** does not work for the `addEdge` utility! */
|
||||||
defaultEdgeOptions?: DefaultEdgeOptions
|
defaultEdgeOptions?: DefaultEdgeOptions
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user