Import
import { DragHandle } from '@contentful/f36-components';// orimport { DragHandle } from '@contentful/f36-drag-handle';
Examples
The DragHandle can be styled based on the props you pass to it:
Variants
DragHandle has 2 different variants:
- Secondary - Default variant.
- Transparent - For having an unstyled DragHandle.
States
Card example
Props (API reference)
Open in StorybookName | Type | Default |
---|---|---|
label required | string Label rendered in DragHandle - not visible on screen as its purpose is for screen readers only | |
as | HTML Tag or React Component (e.g. div, span, etc) The element used for the root node | div |
className | string CSS class to be appended to the root element | |
isActive | false true Applies styling for when the component is actively being dragged by the user | |
isFocused | false true Applies focus styling | |
isHovered | false true Applies hover styling | |
testId | string A [data-test-id] attribute used for testing purposes | |
type | string Set type button for div element | |
variant | "secondary" "transparent" Determines style variation | secondary |
Accessibility
- You should pass a relevant label to DragHandle for screen readers, the label is not rendered.