@lucasols/dnd-kit-core 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, Claudéric Demers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @dnd-kit/core
+
+[![Stable release](https://img.shields.io/npm/v/@dnd-kit/core.svg)](https://npm.im/@dnd-kit/core)
+
+@dnd-kit – a lightweight React library for building performant and accessible drag and drop experiences.
+
+## Installation
+
+To get started, install the `@dnd-kit/core` package via npm or yarn:
+
+```
+npm install @dnd-kit/core
+```
+
+## Usage
+
+Visit [docs.dndkit.com](https://docs.dndkit.com) to learn how to get started with @dnd-kit.

package/dist/components/Accessibility/Accessibility.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import type { Announcements, ScreenReaderInstructions } from './types';
+interface Props {
+    announcements?: Announcements;
+    container?: Element;
+    screenReaderInstructions?: ScreenReaderInstructions;
+    hiddenTextDescribedById: string;
+}
+export declare function Accessibility({ announcements, container, hiddenTextDescribedById, screenReaderInstructions, }: Props): JSX.Element | null;
+export {};

package/dist/components/Accessibility/components/RestoreFocus.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    disabled: boolean;
+}
+export declare function RestoreFocus({ disabled }: Props): null;
+export {};

package/dist/components/Accessibility/components/index.d.ts

@@ -0,0 +1 @@
+export { RestoreFocus } from './RestoreFocus';

package/dist/components/Accessibility/defaults.d.ts

@@ -0,0 +1,3 @@
+import type { Announcements, ScreenReaderInstructions } from './types';
+export declare const defaultScreenReaderInstructions: ScreenReaderInstructions;
+export declare const defaultAnnouncements: Announcements;

package/dist/components/Accessibility/index.d.ts

@@ -0,0 +1,4 @@
+export { Accessibility } from './Accessibility';
+export { RestoreFocus } from './components';
+export { defaultAnnouncements, defaultScreenReaderInstructions, } from './defaults';
+export type { Announcements, ScreenReaderInstructions } from './types';

package/dist/components/Accessibility/types.d.ts

@@ -0,0 +1,15 @@
+import type { Active, Over } from '../../store';
+export interface Arguments {
+    active: Active;
+    over: Over | null;
+}
+export interface Announcements {
+    onDragStart({ active }: Pick<Arguments, 'active'>): string | undefined;
+    onDragMove?({ active, over }: Arguments): string | undefined;
+    onDragOver({ active, over }: Arguments): string | undefined;
+    onDragEnd({ active, over }: Arguments): string | undefined;
+    onDragCancel({ active, over }: Arguments): string | undefined;
+}
+export interface ScreenReaderInstructions {
+    draggable: string;
+}

package/dist/components/DndContext/DndContext.d.ts

@@ -0,0 +1,35 @@
+import React from 'react';
+import type { Transform } from '@lucasols/dnd-kit-utilities';
+import type { AutoScrollOptions } from '../../hooks/utilities';
+import type { SensorDescriptor } from '../../sensors';
+import { CollisionDetection } from '../../utilities';
+import { Modifiers } from '../../modifiers';
+import type { DragStartEvent, DragCancelEvent, DragEndEvent, DragMoveEvent, DragOverEvent } from '../../types';
+import { Announcements, ScreenReaderInstructions } from '../Accessibility';
+import type { MeasuringConfiguration } from './types';
+export interface Props {
+    id?: string;
+    accessibility?: {
+        announcements?: Announcements;
+        container?: Element;
+        restoreFocus?: boolean;
+        screenReaderInstructions?: ScreenReaderInstructions;
+    };
+    autoScroll?: boolean | AutoScrollOptions;
+    cancelDrop?: CancelDrop;
+    children?: React.ReactNode;
+    collisionDetection?: CollisionDetection;
+    measuring?: MeasuringConfiguration;
+    modifiers?: Modifiers;
+    sensors?: SensorDescriptor<any>[];
+    onDragStart?(event: DragStartEvent): void;
+    onDragMove?(event: DragMoveEvent): void;
+    onDragOver?(event: DragOverEvent): void;
+    onDragEnd?(event: DragEndEvent): void;
+    onDragCancel?(event: DragCancelEvent): void;
+}
+export interface CancelDropArguments extends DragEndEvent {
+}
+export declare type CancelDrop = (args: CancelDropArguments) => boolean | Promise<boolean>;
+export declare const ActiveDraggableContext: React.Context<Transform>;
+export declare const DndContext: React.NamedExoticComponent<Props>;

package/dist/components/DndContext/defaults.d.ts

@@ -0,0 +1,13 @@
+import type { DeepRequired } from '@lucasols/dnd-kit-utilities';
+import type { DataRef } from '../../store/types';
+import { KeyboardSensor, PointerSensor } from '../../sensors';
+import type { MeasuringConfiguration } from './types';
+export declare const defaultSensors: ({
+    sensor: typeof PointerSensor;
+    options: {};
+} | {
+    sensor: typeof KeyboardSensor;
+    options: {};
+})[];
+export declare const defaultData: DataRef;
+export declare const defaultMeasuringConfiguration: DeepRequired<MeasuringConfiguration>;

package/dist/components/DndContext/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { useMeasuringConfiguration } from './useMeasuringConfiguration';
+export { useLayoutShiftScrollCompensation } from './useLayoutShiftScrollCompensation';

package/dist/components/DndContext/hooks/useLayoutShiftScrollCompensation.d.ts

@@ -0,0 +1,14 @@
+import type { ClientRect } from '../../../types';
+import type { DraggableNode } from '../../../store';
+import type { MeasuringFunction } from '../types';
+interface Options {
+    activeNode: DraggableNode | null | undefined;
+    config: boolean | {
+        x: boolean;
+        y: boolean;
+    } | undefined;
+    initialRect: ClientRect | null;
+    measure: MeasuringFunction;
+}
+export declare function useLayoutShiftScrollCompensation({ activeNode, measure, initialRect, config, }: Options): void;
+export {};

package/dist/components/DndContext/hooks/useMeasuringConfiguration.d.ts

@@ -0,0 +1,3 @@
+import type { DeepRequired } from '@lucasols/dnd-kit-utilities';
+import type { MeasuringConfiguration } from '../types';
+export declare function useMeasuringConfiguration(config: MeasuringConfiguration | undefined): DeepRequired<MeasuringConfiguration>;

package/dist/components/DndContext/index.d.ts

@@ -0,0 +1,3 @@
+export { ActiveDraggableContext, DndContext } from './DndContext';
+export type { CancelDrop, Props as DndContextProps } from './DndContext';
+export type { DraggableMeasuring, MeasuringConfiguration } from './types';

package/dist/components/DndContext/types.d.ts

@@ -0,0 +1,16 @@
+import type { ClientRect } from '../../types';
+import type { DroppableMeasuring } from '../../hooks/utilities';
+export declare type MeasuringFunction = (node: HTMLElement) => ClientRect;
+interface Measuring {
+    measure: MeasuringFunction;
+}
+export interface DraggableMeasuring extends Measuring {
+}
+export interface DragOverlayMeasuring extends Measuring {
+}
+export interface MeasuringConfiguration {
+    draggable?: Partial<DraggableMeasuring>;
+    droppable?: Partial<DroppableMeasuring>;
+    dragOverlay?: Partial<DragOverlayMeasuring>;
+}
+export {};

package/dist/components/DndMonitor/context.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { RegisterListener } from './types';
+export declare const DndMonitorContext: import("react").Context<RegisterListener | null>;

package/dist/components/DndMonitor/index.d.ts

@@ -0,0 +1,4 @@
+export { DndMonitorContext } from './context';
+export type { DndMonitorListener, DndMonitorEvent } from './types';
+export { useDndMonitor } from './useDndMonitor';
+export { useDndMonitorProvider } from './useDndMonitorProvider';

package/dist/components/DndMonitor/types.d.ts

@@ -0,0 +1,14 @@
+import type { DragStartEvent, DragCancelEvent, DragEndEvent, DragMoveEvent, DragOverEvent } from '../../types';
+export interface DndMonitorListener {
+    onDragStart?(event: DragStartEvent): void;
+    onDragMove?(event: DragMoveEvent): void;
+    onDragOver?(event: DragOverEvent): void;
+    onDragEnd?(event: DragEndEvent): void;
+    onDragCancel?(event: DragCancelEvent): void;
+}
+export interface DndMonitorEvent {
+    type: keyof DndMonitorListener;
+    event: DragStartEvent | DragMoveEvent | DragOverEvent | DragEndEvent | DragCancelEvent;
+}
+export declare type UnregisterListener = () => void;
+export declare type RegisterListener = (listener: DndMonitorListener) => UnregisterListener;

package/dist/components/DndMonitor/useDndMonitor.d.ts

@@ -0,0 +1,2 @@
+import type { DndMonitorListener } from './types';
+export declare function useDndMonitor(listener: DndMonitorListener): void;

package/dist/components/DndMonitor/useDndMonitorProvider.d.ts

@@ -0,0 +1,2 @@
+import type { DndMonitorEvent } from './types';
+export declare function useDndMonitorProvider(): readonly [({ type, event }: DndMonitorEvent) => void, (listener: any) => () => boolean];

package/dist/components/DragOverlay/DragOverlay.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { Modifiers } from '../../modifiers';
+import type { PositionedOverlayProps } from './components';
+import type { DropAnimation } from './hooks';
+export interface Props extends Pick<PositionedOverlayProps, 'adjustScale' | 'children' | 'className' | 'style' | 'transition'> {
+    dropAnimation?: DropAnimation | null | undefined;
+    modifiers?: Modifiers;
+    wrapperElement?: keyof JSX.IntrinsicElements;
+    zIndex?: number;
+}
+export declare const DragOverlay: React.MemoExoticComponent<({ adjustScale, children, dropAnimation: dropAnimationConfig, style, transition, modifiers, wrapperElement, className, zIndex, }: Props) => JSX.Element>;

package/dist/components/DragOverlay/components/AnimationManager/AnimationManager.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { UniqueIdentifier } from '../../../../types';
+export declare type Animation = (key: UniqueIdentifier, node: HTMLElement) => Promise<void> | void;
+export interface Props {
+    animation: Animation;
+    children: React.ReactElement | null;
+}
+export declare function AnimationManager({ animation, children }: Props): JSX.Element;

package/dist/components/DragOverlay/components/AnimationManager/index.d.ts

@@ -0,0 +1,2 @@
+export { AnimationManager } from './AnimationManager';
+export type { Animation } from './AnimationManager';

package/dist/components/DragOverlay/components/NullifiedContextProvider/NullifiedContextProvider.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface Props {
+    children: React.ReactNode;
+}
+export declare function NullifiedContextProvider({ children }: Props): JSX.Element;
+export {};

package/dist/components/DragOverlay/components/NullifiedContextProvider/index.d.ts

@@ -0,0 +1 @@
+export { NullifiedContextProvider } from './NullifiedContextProvider';

package/dist/components/DragOverlay/components/PositionedOverlay/PositionedOverlay.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import type { Transform } from '@lucasols/dnd-kit-utilities';
+import type { ClientRect, UniqueIdentifier } from '../../../../types';
+declare type TransitionGetter = (activatorEvent: Event | null) => React.CSSProperties['transition'] | undefined;
+export interface Props {
+    as: keyof JSX.IntrinsicElements;
+    activatorEvent: Event | null;
+    adjustScale?: boolean;
+    children?: React.ReactNode;
+    className?: string;
+    id: UniqueIdentifier;
+    rect: ClientRect | null;
+    style?: React.CSSProperties;
+    transition?: string | TransitionGetter;
+    transform: Transform;
+}
+export declare const PositionedOverlay: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLElement>>;
+export {};

package/dist/components/DragOverlay/components/PositionedOverlay/index.d.ts

@@ -0,0 +1,2 @@
+export { PositionedOverlay } from './PositionedOverlay';
+export type { Props as PositionedOverlayProps } from './PositionedOverlay';

package/dist/components/DragOverlay/components/index.d.ts

@@ -0,0 +1,5 @@
+export { AnimationManager } from './AnimationManager';
+export type { Animation } from './AnimationManager';
+export { NullifiedContextProvider } from './NullifiedContextProvider';
+export { PositionedOverlay } from './PositionedOverlay';
+export type { PositionedOverlayProps } from './PositionedOverlay';

package/dist/components/DragOverlay/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export { useDropAnimation, defaultDropAnimationConfiguration as defaultDropAnimation, defaultDropAnimationSideEffects, } from './useDropAnimation';
+export type { DropAnimation, DropAnimationFunction, DropAnimationFunctionArguments, KeyframeResolver as DropAnimationKeyframeResolver, DropAnimationSideEffects, } from './useDropAnimation';
+export { useKey } from './useKey';

package/dist/components/DragOverlay/hooks/useDropAnimation.d.ts

@@ -0,0 +1,65 @@
+import type { DeepRequired, Transform } from '@lucasols/dnd-kit-utilities';
+import type { Active, DraggableNodes, DroppableContainers } from '../../../store';
+import type { ClientRect, UniqueIdentifier } from '../../../types';
+import type { MeasuringConfiguration } from '../../DndContext';
+interface SharedParameters {
+    active: {
+        id: UniqueIdentifier;
+        data: Active['data'];
+        node: HTMLElement;
+        rect: ClientRect;
+    };
+    dragOverlay: {
+        node: HTMLElement;
+        rect: ClientRect;
+    };
+    draggableNodes: DraggableNodes;
+    droppableContainers: DroppableContainers;
+    measuringConfiguration: DeepRequired<MeasuringConfiguration>;
+}
+export interface KeyframeResolverParameters extends SharedParameters {
+    transform: {
+        initial: Transform;
+        final: Transform;
+    };
+}
+export declare type KeyframeResolver = (parameters: KeyframeResolverParameters) => Keyframe[];
+export interface DropAnimationOptions {
+    keyframes?: KeyframeResolver;
+    duration?: number;
+    easing?: string;
+    sideEffects?: DropAnimationSideEffects | null;
+}
+export declare type DropAnimation = DropAnimationFunction | DropAnimationOptions;
+interface Arguments {
+    draggableNodes: DraggableNodes;
+    droppableContainers: DroppableContainers;
+    measuringConfiguration: DeepRequired<MeasuringConfiguration>;
+    config?: DropAnimation | null;
+}
+export interface DropAnimationFunctionArguments extends SharedParameters {
+    transform: Transform;
+}
+export declare type DropAnimationFunction = (args: DropAnimationFunctionArguments) => Promise<void> | void;
+declare type CleanupFunction = () => void;
+export interface DropAnimationSideEffectsParameters extends SharedParameters {
+}
+export declare type DropAnimationSideEffects = (parameters: DropAnimationSideEffectsParameters) => CleanupFunction | void;
+declare type ExtractStringProperties<T> = {
+    [K in keyof T]?: T[K] extends string ? string : never;
+};
+declare type Styles = ExtractStringProperties<CSSStyleDeclaration>;
+interface DefaultDropAnimationSideEffectsOptions {
+    className?: {
+        active?: string;
+        dragOverlay?: string;
+    };
+    styles?: {
+        active?: Styles;
+        dragOverlay?: Styles;
+    };
+}
+export declare const defaultDropAnimationSideEffects: (options: DefaultDropAnimationSideEffectsOptions) => DropAnimationSideEffects;
+export declare const defaultDropAnimationConfiguration: Required<DropAnimationOptions>;
+export declare function useDropAnimation({ config, draggableNodes, droppableContainers, measuringConfiguration, }: Arguments): (...args: any) => any;
+export {};

package/dist/components/DragOverlay/hooks/useKey.d.ts

@@ -0,0 +1,2 @@
+import type { UniqueIdentifier } from '../../../types';
+export declare function useKey(id: UniqueIdentifier | undefined): number | undefined;

package/dist/components/DragOverlay/index.d.ts

@@ -0,0 +1,4 @@
+export { DragOverlay } from './DragOverlay';
+export type { Props } from './DragOverlay';
+export { defaultDropAnimation, defaultDropAnimationSideEffects } from './hooks';
+export type { DropAnimation, DropAnimationFunction, DropAnimationFunctionArguments, DropAnimationKeyframeResolver, DropAnimationSideEffects, } from './hooks';

package/dist/components/index.d.ts

@@ -0,0 +1,8 @@
+export { defaultAnnouncements, defaultScreenReaderInstructions, } from './Accessibility';
+export type { Announcements, ScreenReaderInstructions } from './Accessibility';
+export { DndContext } from './DndContext';
+export type { CancelDrop, DndContextProps, DraggableMeasuring, MeasuringConfiguration, } from './DndContext';
+export { useDndMonitor } from './DndMonitor';
+export type { DndMonitorListener } from './DndMonitor';
+export { DragOverlay, defaultDropAnimation, defaultDropAnimationSideEffects, } from './DragOverlay';
+export type { DropAnimation, DropAnimationFunction, DropAnimationFunctionArguments, DropAnimationKeyframeResolver, DropAnimationSideEffects, Props as DragOverlayProps, } from './DragOverlay';