- Z Index
- Static CSS Classes
- Interactive CSS Classes
- Preventing text selection while dragging
- User specified CSS classes
- CSS for SVG Elements
Styling via CSS
Using CSS to style the artifacts that jsPlumb creates is a lot more flexible than using
On this page we'll first run through the default CSS classes that jsPlumb attaches, followed by a quick explanation of how to attach your own, and then we'll discuss how to style SVG.
The information on this page pertains both to the Community edition, and to the Surface widget used by the Toolkit edition.
One thing you can - and should - use CSS for, regardless of the renderer, is z-index. Every connection, endpoint and overlay in jsPlumb adds some element to the UI, and you should take care to establish appropriate z-indices for each of these, in conjunction with the nodes/groups in your application.
By default, jsPlumb adds a specific class to each of the three types of elements it creates (These class names are exposed on the jsPlumb object and can be overridden if you need to do so - see the third column in the table)
|Component||CSS Class||jsPlumb Member|
|Connector Outline||jtk-connector-outline||connectorOutlineClass (SVG only)|
|Endpoint when full||jtk-endpoint-full||endpointFullClass|
In a simple UI, you can set appropriate z-index values for these classes. The jsPlumb demo pages, for instance, typically use a class of
.window for the nodes in each demo page, and the z-index of the UI is controlled with CSS rules like this:
jsPlumb assigns these classes on both connectors and endpoints when specific user interactivity occurs:
|Activity||CSS Class||jsPlumb Member||Description|
|Mouse Hover||jtk-hover||hoverClass||Assigned to both Connectors and Endpoints when the mouse is hovering over them|
|Connection Drag||jtk-dragging||draggingClass||Assigned to a Connection when it is being dragged (either a new Connection or an existing Connection)|
|Element Dragging||jtk-element-dragging||elementDraggingClass||Assigned to all Connections whose source or target element is currently being dragged, and to their Endpoints.|
|Source Element Dragging||jtk-source-element-dragging||sourceElementDraggingClass||Assigned to all Connections whose source element is being dragged, and to their Endpoints|
|Target Element Dragging||jtk-target-element-dragging||targetElementDraggingClass||Assigned to all Connections whose target element is being dragged, and to their Endpoints|
|Anchor Class||***jtk-endpoint-anchor-***||endpointAnchorClassPrefix||Assigned to Endpoints, and their associated elements, that have either a static Anchor with an associated class, or a Dynamic Anchor whose individual locations have an associated CSS class. The `***` suffix in the class name above is the associated class. Note that this class is added to both the artefact that jsPlumb creates and also the element on which the Endpoint resides, so you will normally have to build a selector with more criteria than just this class in order to target things properly. See the documentation regarding Anchors for a discussion of this.|
|Drop Allowed on Endpoint||jtk-endpoint-drop-allowed||endpointDropAllowedClass||Assigned to an Endpoint when another Endpoint is hovering over it and a drop would be allowed|
|Drop Forbidden on Endpoint||jtk-endpoint-drop-forbidden||endpointDropForbiddenClass||Assigned to an Endpoint when another Endpoint is hovering over it and a drop would not be allowed|
|Connection Hover||jtk-source-hover||hoverSourceClass||Assigned to the source element in a Connection when the mouse is hovering over the Connection|
|Connection Hover||jtk-target-hover||hoverTargetClass||Assigned to the target element in a Connection when the mouse is hovering over the Connection|
|Drag||jtk-drag-select||dragSelectClass||Assigned to the document body whenever a drag is in progress. It allows you to ensure document selection is disabled - see [here](home#dragSelection)|
|Source disable||jtk-source-disabled||-||Assigned to an element that was configured with `makeSource` and was subsequently disabled via `setEnabled(el, false)`.|
|Target disable||jtk-target-disabled||-||Assigned to an element that was configured with `makeTarget` and was subsequently disabled via `setEnabled(el, false)`.|
jsPlumb puts a jtk-drag-select class on the body that you can use to disable the default browser behaviour of selecting DOM elements when dragging.
A suitable value for this (from the jsPlumb demos) is:
In addition to the default CSS classes, endpoints and connections support the following two parameters:
- cssClass - class(es) to set on the display elements
- hoverClass - class(es) to set on the display elements when in hover mode
In the Toolkit edition, these are specified in
connector definitions inside your view, for instance:
In addition, endpoint definitions allow you to specify what these classes will be for any edges that are dragged from them:
- connectorClass - class(es) to set on the display elements of Connections
- connectorHoverClass - class(es) to set on the display elements of Connections when in hover mode
These parameters should be supplied as a String; they will be appended as-is to the class member, so feel free to include multiple classes. jsPlumb won't even know.
Edges in jsPlumb consist of a parent
svg element, inside of which there are one or more
path elements, depending on whether or not you have specified an
outlineStyle. To target the path element for some edge, you need a rule like this:
"foo" cssClass from before as a starting point, you might do something like this:
You might be thinking to yourself, why have the
path elements in this? In fact they are perhaps not required: they're just there to call out the fact that this is a style on an SVG connector.
SVG Endpoints created by jsPlumb consist of a
div, inside of which is an
svg parent element, inside of which there is some shape, the tag name of which depends on the type of Endpoint:
|Endpoint Type||SVG Shape|
So you can choose, when writing CSS rules for these, whether or not you specify the shape exactly, or just leave it up to a wildcard:
For a full discussion of the properties you can configure on an SVG element via CSS, we refer you to the SVG spec.