github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-18 23:21:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_dom_drag_drop.devdocs.json

1089 lines
No EOL
39 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/dom-drag-drop",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ChildDragDropProvider",
"type": "Function",
"tags": [],
"label": "ChildDragDropProvider",
"description": [
"\nA React drag / drop provider that derives its state from a RootDragDropProvider. If\npart of a React application is rendered separately from the root, this provider can\nbe used to enable drag / drop functionality within the disconnected part.\n"
],
"signature": [
"({ value, children }: ",
"ProviderProps",
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ChildDragDropProvider.$1",
"type": "Object",
"tags": [],
"label": "{ value, children }",
"description": [],
"signature": [
"ProviderProps"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.Draggable",
"type": "Function",
"tags": [
"constructor"
],
"label": "Draggable",
"description": [
"\nDraggable component"
],
"signature": [
"({ reorderableGroup, ...props }: DraggableProps) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/draggable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.Draggable.$1",
"type": "Object",
"tags": [],
"label": "{ reorderableGroup, ...props }",
"description": [],
"signature": [
"DraggableProps"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/draggable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropOverlayWrapper",
"type": "Function",
"tags": [
"constructor"
],
"label": "DropOverlayWrapper",
"description": [
"\nThis prevents the in-place droppable styles (under children) and allows to rather show an overlay with droppable styles (on top of children)"
],
"signature": [
"({ isVisible, children, overlayProps, className, ...otherProps }: React.PropsWithChildren<",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropOverlayWrapperProps",
"text": "DropOverlayWrapperProps"
},
">) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_overlay_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropOverlayWrapper.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n isVisible,\n children,\n overlayProps,\n className,\n ...otherProps\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropOverlayWrapperProps",
"text": "DropOverlayWrapperProps"
},
">"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_overlay_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.Droppable",
"type": "Function",
"tags": [
"constructor"
],
"label": "Droppable",
"description": [
"\nDroppable component"
],
"signature": [
"(props: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DroppableProps",
"text": "DroppableProps"
},
") => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.Droppable.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DroppableProps",
"text": "DroppableProps"
}
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ReorderProvider",
"type": "Function",
"tags": [],
"label": "ReorderProvider",
"description": [],
"signature": [
"({\n children,\n className,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n}: { children: React.ReactNode; className?: string | undefined; dataTestSubj?: string | undefined; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/reorder_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ReorderProvider.$1",
"type": "Object",
"tags": [],
"label": "{\n children,\n className,\n dataTestSubj = DEFAULT_DATA_TEST_SUBJ,\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/reorder_provider.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ReorderProvider.$1.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/reorder_provider.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ReorderProvider.$1.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/reorder_provider.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.ReorderProvider.$1.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/reorder_provider.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.RootDragDropProvider",
"type": "Function",
"tags": [],
"label": "RootDragDropProvider",
"description": [],
"signature": [
"({\n children,\n customMiddleware,\n initialState = {},\n}: { children: React.ReactNode; customMiddleware?: ",
"CustomMiddleware",
" | undefined; initialState?: Partial<",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DragContextState",
"text": "DragContextState"
},
"> | undefined; }) => React.JSX.Element"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.RootDragDropProvider.$1",
"type": "Object",
"tags": [],
"label": "{\n children,\n customMiddleware,\n initialState = {},\n}",
"description": [],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.RootDragDropProvider.$1.children",
"type": "CompoundType",
"tags": [],
"label": "children",
"description": [],
"signature": [
"string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | null | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.RootDragDropProvider.$1.customMiddleware",
"type": "Function",
"tags": [],
"label": "customMiddleware",
"description": [],
"signature": [
"CustomMiddleware",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.RootDragDropProvider.$1.initialState",
"type": "Object",
"tags": [],
"label": "initialState",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DragContextState",
"text": "DragContextState"
},
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.useDragDropContext",
"type": "Function",
"tags": [],
"label": "useDragDropContext",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DragContextValue",
"text": "DragContextValue"
}
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextState",
"type": "Interface",
"tags": [],
"label": "DragContextState",
"description": [],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextState.dragging",
"type": "CompoundType",
"tags": [],
"label": "dragging",
"description": [
"\nThe item being dragged or undefined."
],
"signature": [
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DraggingIdentifier",
"text": "DraggingIdentifier"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextState.keyboardMode",
"type": "boolean",
"tags": [],
"label": "keyboardMode",
"description": [
"\nkeyboard mode"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextState.hoveredDropTarget",
"type": "CompoundType",
"tags": [],
"label": "hoveredDropTarget",
"description": [
"\ncurrently selected drop target"
],
"signature": [
"DropIdentifier",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextState.dropTargetsByOrder",
"type": "Object",
"tags": [],
"label": "dropTargetsByOrder",
"description": [
"\ncurrently registered drop targets"
],
"signature": [
"Record<string, ",
"DropIdentifier",
"> | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextState.dataTestSubjPrefix",
"type": "string",
"tags": [],
"label": "dataTestSubjPrefix",
"description": [
"\nCustomizable data-test-subj prefix"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropOverlayWrapperProps",
"type": "Interface",
"tags": [],
"label": "DropOverlayWrapperProps",
"description": [
"\nDropOverlayWrapper Props"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_overlay_wrapper.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropOverlayWrapperProps.isVisible",
"type": "boolean",
"tags": [],
"label": "isVisible",
"description": [],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_overlay_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropOverlayWrapperProps.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_overlay_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropOverlayWrapperProps.overlayProps",
"type": "Uncategorized",
"tags": [],
"label": "overlayProps",
"description": [],
"signature": [
"object | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_overlay_wrapper.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps",
"type": "Interface",
"tags": [],
"label": "DroppableProps",
"description": [
"\nThe base props to the Droppable component."
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.className",
"type": "string",
"tags": [],
"label": "className",
"description": [
"\nThe CSS class(es) for the root element."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.onDrop",
"type": "Function",
"tags": [],
"label": "onDrop",
"description": [
"\nThe event handler that fires when an item\nis dropped onto this Droppable component."
],
"signature": [
"DropHandler",
" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [
"\nThe value associated with this item."
],
"signature": [
"Record<string, unknown> & { id: string; humanData: ",
"HumanData",
"; }"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.children",
"type": "Object",
"tags": [],
"label": "children",
"description": [
"\nThe React element which will be passed the draggable handlers"
],
"signature": [
"React.ReactElement<any, string | React.JSXElementConstructor<any>>"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.isDisabled",
"type": "CompoundType",
"tags": [],
"label": "isDisabled",
"description": [
"\nDisable any drag & drop behaviour"
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.getAdditionalClassesOnEnter",
"type": "Function",
"tags": [],
"label": "getAdditionalClassesOnEnter",
"description": [
"\nAdditional class names to apply when another element is over the drop target"
],
"signature": [
"((dropType?: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
" | undefined) => string | undefined) | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.getAdditionalClassesOnEnter.$1",
"type": "CompoundType",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.getAdditionalClassesOnDroppable",
"type": "Function",
"tags": [],
"label": "getAdditionalClassesOnDroppable",
"description": [
"\nAdditional class names to apply when another element is droppable for a currently dragged item"
],
"signature": [
"((dropType?: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
" | undefined) => string | undefined) | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.getAdditionalClassesOnDroppable.$1",
"type": "CompoundType",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.dataTestSubj",
"type": "string",
"tags": [],
"label": "dataTestSubj",
"description": [
"\nThe optional test subject associated with this DOM element."
],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.reorderableGroup",
"type": "Array",
"tags": [],
"label": "reorderableGroup",
"description": [
"\nitems belonging to the same group that can be reordered"
],
"signature": [
"{ id: string; }[] | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.dropTypes",
"type": "Array",
"tags": [],
"label": "dropTypes",
"description": [
"\nIndicates the type of drop targets - when undefined, the currently dragged item\ncannot be dropped onto this component."
],
"signature": [
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
"[] | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.order",
"type": "Array",
"tags": [],
"label": "order",
"description": [
"\nOrder for keyboard dragging. This takes an array of numbers which will be used to order hierarchically"
],
"signature": [
"number[]"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.getCustomDropTarget",
"type": "Function",
"tags": [],
"label": "getCustomDropTarget",
"description": [
"\nExtra drop targets by dropType"
],
"signature": [
"((dropType: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
") => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null) | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DroppableProps.getCustomDropTarget.$1",
"type": "CompoundType",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
}
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/droppable.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragContextValue",
"type": "Type",
"tags": [],
"label": "DragContextValue",
"description": [],
"signature": [
"[state: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DragContextState",
"text": "DragContextState"
},
", dispatch: React.Dispatch<",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DragDropAction",
"text": "DragDropAction"
},
">, customMiddleware?: ",
"CustomMiddleware",
" | undefined]"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragDropAction",
"type": "Type",
"tags": [],
"label": "DragDropAction",
"description": [],
"signature": [
"ResetStateAction | RegisterDropTargetAction | LeaveDropTargetAction | SelectDropTargetAction | DragToTargetAction | StartDraggingAction | EndDraggingAction"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/providers.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DragDropIdentifier",
"type": "Type",
"tags": [],
"label": "DragDropIdentifier",
"description": [
"\nDrag Drop base identifier"
],
"signature": [
"Record<string, unknown> & { id: string; humanData: ",
"HumanData",
"; }"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DraggingIdentifier",
"type": "Type",
"tags": [],
"label": "DraggingIdentifier",
"description": [
"\nDragging identifier"
],
"signature": [
"Record<string, unknown> & { id: string; humanData: ",
"HumanData",
"; } & { ghost?: ",
"Ghost",
" | undefined; }"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/providers/types.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropType",
"type": "Type",
"tags": [],
"label": "DropType",
"description": [
"\nTypes of drop action"
],
"signature": [
"\"reorder\" | \"field_add\" | \"field_replace\" | \"move_compatible\" | \"replace_compatible\" | \"move_incompatible\" | \"replace_incompatible\" | \"replace_duplicate_compatible\" | \"duplicate_compatible\" | \"swap_compatible\" | \"replace_duplicate_incompatible\" | \"duplicate_incompatible\" | \"swap_incompatible\" | \"field_combine\" | \"combine_compatible\" | \"combine_incompatible\""
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine",
"type": "Object",
"tags": [],
"label": "DropTargetSwapDuplicateCombine",
"description": [
"\nHelpers for swap/duplicate/combine extra drops"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine.getCustomDropTarget",
"type": "Function",
"tags": [],
"label": "getCustomDropTarget",
"description": [],
"signature": [
"(dropType: ",
{
"pluginId": "@kbn/dom-drag-drop",
"scope": "common",
"docId": "kibKbnDomDragDropPluginApi",
"section": "def-common.DropType",
"text": "DropType"
},
") => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine.getCustomDropTarget.$1",
"type": "CompoundType",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
"\"reorder\" | \"field_add\" | \"field_replace\" | \"move_compatible\" | \"replace_compatible\" | \"move_incompatible\" | \"replace_incompatible\" | \"replace_duplicate_compatible\" | \"duplicate_compatible\" | \"swap_compatible\" | \"replace_duplicate_incompatible\" | \"duplicate_incompatible\" | \"swap_incompatible\" | \"field_combine\" | \"combine_compatible\" | \"combine_incompatible\""
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/swap_duplicate_combine.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnDroppable",
"type": "Function",
"tags": [],
"label": "getAdditionalClassesOnDroppable",
"description": [],
"signature": [
"(dropType?: string | undefined) => \"domDroppable--incompatible\" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnDroppable.$1",
"type": "string",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/swap_duplicate_combine.tsx",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnEnter",
"type": "Function",
"tags": [],
"label": "getAdditionalClassesOnEnter",
"description": [],
"signature": [
"(dropType?: string | undefined) => \"domDroppable--replacing\" | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/dom-drag-drop",
"id": "def-common.DropTargetSwapDuplicateCombine.getAdditionalClassesOnEnter.$1",
"type": "string",
"tags": [],
"label": "dropType",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/shared/kbn-dom-drag-drop/src/drop_targets/swap_duplicate_combine.tsx",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink