Skip to content

Latest commit

 

History

History
234 lines (178 loc) · 9.4 KB

CHANGELOG.md

File metadata and controls

234 lines (178 loc) · 9.4 KB

Changelog

0.4.2 - 2022-02-06

Fixed

  • Update rollup-plugin-solid to 1.2.2 to address Bundlephobia build error (caused by it tripping over the optinal chaining syntax ?.). The plugin now targets a slightly older env in order to compile this syntax away.

0.4.1 - 2022-02-03

Fixed

  • Fix pointer sensor preventing default event behaviour on attachment. Instead, wait for activation of drag before intercepting relevant events. This avoids unexpected side effects, such as an <input/> not receiving focus on click.

    With this change, also listen for and clear any text selection that happens as a side effect during an active drag operation.

    Thanks to @yonathan06 for reporting this behaviour.

0.4.0 - 2022-01-09

Added

Changed

  • Breaking Change As part of adding typings to Solid DnD, change most function signatures to use positional parameters over an options object. This simplifies the typing and makes it easier to use and understand the function parameters.

    For reference, the rules used when applying this change were:

    • Default to multiple positional params. For example, a call to createDraggable({ id }) should now be createDraggable(id).
    • Use an object when multiple params are related as a single entity (such as an 'event'). For example, an onDragEnd(event) handler can remain unchanged (accepting a single parameter).
    • Use an options object when there are a large number of parameters (>3).

  • Breaking Change Rename DragDropContext to DragDropProvider and SortableContext to SortableProvider to match Solid convention and better reflect usage. Note that useDragDropContext and useSortableContext remain unchanged.

Fixed

  • Fix eventMap[key] is undefined error when attempting to drag a draggable that has been composed manually using the draggable.dragActivators property. This was due to naive key renaming in the asHandlers logic and so did not affect draggable usage as a directive.

0.3.3 - 2021-11-03

Fixed

  • Remove leftover debug log.

0.3.2 - 2021-11-03

Fixed

  • Cleanup dangling references to removed items. When draggables, droppables or sensors removed, clean up dangling references to them in the state (such as 'active' or 'previous' values). This helps prevent potential infinite recursion (such as in onDragEnd) where an item (like a draggable) oscillates between having a valid 'previous' value reference and undefined.

0.3.1 - 2021-09-05

Changed

  • As part of the fix for detecting collisions on drag start, recomputeLayouts no longer automatically calls detectCollisions when layouts have changed. Instead, it returns a boolean indicating whether a layout change detected and the caller can choose to call detectCollisions if desired.

Fixed

  • Fix case where a drag with no movement results in an incorrect drop. This was due to collisions not being detected on drag start if layouts had not changed (the common case). Collisions now always detected by dragStart.

0.3.0 - 2021-09-04

Added

  • Add sensorStart and sensorEnd to support sensors explicitly indicating whether they are active or not. Note that only one sensor can be considered active at a time.

Changed

  • Activate sensor in createPointerSensor if the pointer has moved more than 10 pixels. This is irrespective of whether the delay condition has been met. It addresses the issue where a dragged item appears to jump to its new location after a delay if the pointer moved quickly at the outset of the drag.

  • Make managing sensor active state explicit. Returning a truthy value from a sensor activator will no longer cause that sensor to be automatically marked as the active sensor. In addition, other activators will continue to be called until a sensor explicitly indicates it is active by calling sensorStart. Similarly, an active sensor must now call sensorEnd when it is no longer active (typically when a drag completes). This makes it clearer that a sensor is responsible for managing its activation state (and how to do so), especially in cases of delayed activation.

0.2.0 - 2021-07-12

Update to work with Solid 1.0 and streamline the interface with new directives.

Added

  • Update createDraggable, createDroppable and createSortable to provide a custom directive. These can be used with the Solid use:___ syntactic sugar for common usage setup - no need to pass refs and props around:
const MyComponent = (props) => {
  const draggable = createDraggable({ id: props.id });
  return <div use:draggable>Drag me!</div>;
};

If finer control needed, the underlying primitives are accessible by property lookup on the directive::

const MyComponent = (props) => {
  const draggable = createDraggable({ id: props.id });
  return (
    <div ref={draggable.ref}>
      <div {...draggable.dragActivators}>Drag Handle</div>
      Drag me!
    </div>
  );
};
  • Automatically detect and register usage of DragOverlay. Add to DragDropContext state a usingDragOverlay property that can be checked.
  • Return a new function displace as part of the DragDropContext that can be used to set the transform for a droppable or draggable. See usage in createSortable for example.

Changed

  • Breaking Change Update to work with Solid 1.0! Requires updating peer dependency of Solid to 1.0 or greater.
  • Refactor isActiveDraggable and isActiveDroppable to appear as resolved properties rather than functions to call (this is more consistent with the rest of interface). E.g. draggable.isActiveDraggable() -> draggable.isActivateDraggable.
  • Refactor sensor interface to use event type rather than handler name. For example, make createPointerSensor use pointerdown rather than onPointerDown for activation. As part of this, add a asHandlers option to draggableActivators to control whether to return object with on___ form or not (default is false).
  • Rename occurrences of translate to transform, which feels a more appropriate name. E.g. translateStyle should now be transformStyle and the translate property returned from create___ calls should be called transform.
  • Assume valid transform value is always present. In particular, transformStyle no longer checks for a null transform value.
  • Improve vertical sort algorithm to better handle arbitrary gaps (such as those created by the CSS gap property on flexbox). As part of this, remove the now redundant outerHeight and outerWidth properties from the layout data returned by elementLayout.
  • Update README.md to reflect simpler directive interface for draggables and droppables.

Removed

  • Remove support for explicitly managing droppable disabled state. The current implementation feels limiting and potentially confusing. For example, it prevents detecting when a draggable is over a disabled droppable and styling it appropriately. Note that a similar effect to disabled can be achieved by determining drop suitability in onDragEnd.

0.1.2 - 2021-07-03

Simplify releasing.

Added

  • Use release-it to simplify performing a release.
  • Add keywords to package.json for easier discoverability of package.
  • Add default publish configuration to package.json.

0.1.1 - 2021-06-22

Initial release supporting plain drag and drop as well as an early preset for sortable lists.

Added

  • Add createDraggable to easily integrate drag behaviour into components, with the component maintaining control over how it looks and behaves.
  • Add createDroppable to register and manage droppable areas.
  • Support conditionally enabling and disabling droppables via a disabled option on createDroppable.
  • Support dragging representations of a draggable through the use of a DragOverlay (which can be removed from the normal document flow).
  • Support using sensors to detect and manage drag starts.
  • Add createPointerSensor as the default sensor, and wrap for convenience in a <DragDropSensors/> component.
  • Support customising collision detection algorithms and provide two initial ones for common usage (mostIntersectingLayout and closestLayoutCenter).
  • Add sortable list primitives (SortableContext and createSortable) for drag and drop vertical list reordering.
  • Support using multiple (or nested) DragDropContext for containers isolated from each other.