# @atlaskit/pragmatic-drag-and-drop-auto-scroll

## 3.0.0

### Major Changes

- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.

  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.

  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.

  ```diff
  - "typesVersions": {
  -    ">=4.5 <4.9": {
  -        "*": [
  -            "dist/types-ts4.5/*",
  -            "dist/types-ts4.5/index.d.ts"
  -        ]
  -    }
  - },
  ```

### Patch Changes

- Updated dependencies

## 2.1.5

### Patch Changes

- [`d3ed1b65a2181`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d3ed1b65a2181) -
  Add @atlassian/a11y-jest-testing to devDependencies.

## 2.1.4

### Patch Changes

- [`e4b717d8304e8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e4b717d8304e8) -
  Add @atlassian/a11y-jest-testing to devDependencies.

## 2.1.3

### Patch Changes

- [`aa9ff75020fcb`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/aa9ff75020fcb) -
  Add @atlassian/a11y-jest-testing to devDependencies.

## 2.1.2

### Patch Changes

- [`beaa6ee463aa8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/beaa6ee463aa8) -
  Internal changes to how border radius is applied.
- Updated dependencies

## 2.1.1

### Patch Changes

- [#164244](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/164244)
  [`65021fc0267e2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/65021fc0267e2) -
  The cleanup functions returned by the following utilities now only work on the first call. This
  was done to prevent unexpected side effects of calling a cleanup function multiple times.
  - `@atlaskit/pragmatic-drag-and-drop/adapter/element`
    - `draggable`
    - `dropTargetForElements`
    - `monitorForElements`
  - `@atlaskit/pragmatic-drag-and-drop/adapter/text-selection`
    - `dropTargetForTextSelection`
    - `monitorForTextSelection`
  - `@atlaskit/pragmatic-drag-and-drop/adapter/external`
    - `dropTargetForExternal`
    - `monitorForExternal`
  - `@atlaskit/pragmatic-drag-and-drop-auto-scroll/element`
    - `autoScrollForElements`
    - `autoScrollWindowForElements`
  - `@atlaskit/pragmatic-drag-and-drop-auto-scroll/external`
    - `autoScrollForExternal`
    - `autoScrollWindowForExternal`
  - `@atlaskit/pragmatic-drag-and-drop-auto-scroll/text-selection`
    - `autoScrollForTextSelection`
    - `autoScrollWindowForTextSelection`

- Updated dependencies

## 2.1.0

### Minor Changes

- [#172374](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/172374)
  [`4ca6346256c8a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4ca6346256c8a) -
  Minor increase of time dampening duration. After lots of explorations, we have increased the value
  to make it easier for people to avoid the impacts of rapid scroll speed spikes when lifting or
  entering into a high scroll speed area.

## 2.0.0

### Major Changes

- [#170839](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/170839)
  [`1534389dcb75b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1534389dcb75b) -
  In order to improve clarity, we have renamed the `from*Edge` (eg `fromTopEdge`) argument
  properties to `for*Edge` (eg `forTopEdge`) for the overflow scroller. If you are not using
  overflow scrolling, there is nothing you need to do.

  ```diff
  - fromTopEdge
  + forTopEdge
  - fromRightEdge
  + forRightEdge
  - fromBottomEdge
  + forBottomEdge
  - fromLeftEdge
  + forLeftEdge
  ```

  ```diff
  const unbind = unsafeOverflowAutoScrollForElements({
  		element,
  		getOverflow: () => ({
  -			fromTopEdge: {
  +			forTopEdge: {
  				top: 6000,
  				right: 6000,
  				left: 6000,
  			},
  -			fromRightEdge: {
  +			forRightEdge: {
  				top: 6000,
  				right: 6000,
  				bottom: 6000,
  			},
  -			fromBottomEdge: {
  +			forBottomEdge: {
  				right: 6000,
  				bottom: 6000,
  				left: 6000,
  			},
  -			fromLeftEdge: {
  +			forLeftEdge: {
  				top: 6000,
  				left: 6000,
  				bottom: 6000,
  			},
  		}),
  });
  ```

  We thought that `for*` more accurately represented what was being provided, as these are the
  overflow definitions _for_ a defined edge.

  We have also improved the types for `for*Edge` so that you do not need to provide redundant cross
  axis information if you only want to overflow scroll on the main axis.

  ```diff
  const unbind = unsafeOverflowAutoScrollForElements({
  		element,
  		getOverflow: () => ({
  			forTopEdge: {
  				top: 100,
  +       // no longer need to pass `0` for the cross axis if you don't need it
  -				right: 0,
  -				left: 0,
  			},
  			forRightEdge: {
  				right: 100,
  -				top: 0,
  -				bottom: 0,
  			},
  			forBottomEdge: {
  				bottom: 100,
  -				right: 0,
  -				left: 0,
  			},
  			forLeftEdge: {
  				left: 100,
  -				top: 0,
  -				bottom: 0,
  			},
  		}),
  });
  ```

  When declaring overflow scrolling for an edge, you cannot provide how deep the scrolling should
  occur into the element (that is defined by the "over element" overflow scroller). Providing
  redundant information for an edge will now also give a type error rather than providing no
  feedback.

  ```ts
  const unbind = unsafeOverflowAutoScrollForElements({
  	element,
  	getOverflow: () => ({
  		forTopEdge: {
  			top: 100,
  			bottom: 30, // ❌ now a type error
  		},
  		forRightEdge: {
  			right: 100,
  			left: 10, // ❌ now a type error
  		},
  		forBottomEdge: {
  			bottom: 100,
  			top: 200, // ❌ now a type error
  		},
  		forLeftEdge: {
  			left: 100,
  			right: 20, // ❌ now a type error
  		},
  	}),
  });
  ```

## 1.4.0

### Minor Changes

- [#116572](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/116572)
  [`98c65e7ff719c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/98c65e7ff719c) -
  🍯 Introducing "the honey pot fix" which is an improved workaround for a
  [painful browser bug](https://issues.chromium.org/issues/41129937).

  **Background**

  The browser bug causes the browser to think the users pointer is continually depressed at the
  point that the user started a drag. This could lead to incorrect events being triggered, and
  incorrect styles being applied to elements that the user is not currently over during a drag.

  **Outcomes**
  - Elements will no longer receive `MouseEvent`s (eg `"mouseenter"` and `"mouseleave"`) during a
    drag (which is a violation of the
    [drag and drop specification](https://html.spec.whatwg.org/multipage/dnd.html#drag-and-drop-processing-model))
  - Elements will no longer apply `:hover` or `:active` styles during a drag. Previously consumers
    would need to disable these style rules during a drag to prevent these styles being applied.
  - Dramatically improved post drop performance. Our prior solution could require a noticeable delay
    due to a large style recalculation after a drop.

### Patch Changes

- Updated dependencies

## 1.3.0

### Minor Changes

- [#95426](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/95426)
  [`a58266bf88e6`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a58266bf88e6) -
  Adding axis locking functionality

  ```diff
  + // `getAllowedAxis` added to element, text selection and external auto scrollers

    autoScrollForElements({
      element: myElement,
  +    getAllowedAxis: (args: ElementGetFeedbackArgs<DragType>) =>  'horizontal' | 'vertical' | 'all',
    });

    autoScrollWindowForElements({
  +    getAllowedAxis: (args: WindowGetFeedbackArgs<DragType>) =>  'horizontal' | 'vertical' | 'all',
    });

    unsafeOverflowAutoScrollForElements({
  +    getAllowedAxis?: (args: ElementGetFeedbackArgs<DragType>) => AllowedAxis;
    })
  ```

## 1.2.0

### Minor Changes

> `1.2.0` is deprecated on `npm` and should not be used. Shortly after release we decided to change
> this API

- [#94103](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/94103)
  [`4e3fb63eb288`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4e3fb63eb288) -
  Added axis locking functionality.

  ```diff
  autoScrollForElements({
    element: myElement,
    getConfiguration: () => ({
      maxScrollSpeed: 'fast' | 'standard',
  +    allowedAxis: 'horizontal' | 'vertical' | 'all',
    }),
  })
  ```

## 1.1.0

### Minor Changes

- [#94454](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/94454)
  [`4b40eb010074`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4b40eb010074) -
  Exposing the unsafe overflow auto scroller for external drags
  (`unsafeOverflowAutoScrollForExternal()`). This already existed, but it was not exposed publicly
  🤦‍♂️.

  ```diff
  import {unsafeOverflowAutoScrollForElements from '@atlaskit/pragmatic-drag-and-drop-auto-scroll/unsafe-overflow/element';
  import {unsafeOverflowAutoScrollForTextSelection} from '@atlaskit/pragmatic-drag-and-drop-auto-scroll/unsafe-overflow/text-selection';
  + import {unsafeOverflowAutoScrollForExternal} from '@atlaskit/pragmatic-drag-and-drop-auto-scroll/unsafe-overflow/external';
  ```

## 1.0.4

### Patch Changes

- [#94316](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/94316)
  [`35fd5ed8e1d7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/35fd5ed8e1d7) -
  Upgrading internal dependency `bind-event-listener` to `@^3.0.0`

## 1.0.3

### Patch Changes

- [#84398](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/84398)
  [`77694db987fc`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/77694db987fc) -
  Public release of Pragmatic drag and drop documentation

## 1.0.2

### Patch Changes

- [#83702](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/83702)
  [`4d9e25ab4eaa`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4d9e25ab4eaa) -
  Updating the descriptions of Pragmatic drag and drop packages, so they each provide a consistent
  description to various consumers, and so they are consistently formed amongst each other.
  - `package.json` `description`
  - `README.md`
  - Website documentation

## 1.0.1

### Patch Changes

- [#83116](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/83116)
  [`8d4e99057fe0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8d4e99057fe0) -
  Upgrade Typescript from `4.9.5` to `5.4.2`

## 1.0.0

### Major Changes

- [#70616](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/70616)
  [`42e57ea65fee`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/42e57ea65fee) -
  This is our first `major` release (`1.0`) for all Pragmatic drag and drop packages.

  For a detailed explanation of these changes, and how to upgrade (automatically) to `1.0` please
  see our
  [1.0 upgrade guide](http://atlassian.design/components/pragmatic-drag-and-drop/core-package/upgrade-guides/upgrade-guide-for-1.0)

### Patch Changes

- Updated dependencies

## 0.8.1

### Patch Changes

- Updated dependencies

## 0.8.0

### Minor Changes

- [#57337](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/57337)
  [`4ad3fa749a5c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4ad3fa749a5c) -
  Adding the ability to increase the maximum automatic scroll speed.

  ```diff
  autoScrollForElements({
    element: myElement,
  +  getConfiguration: () => ({maxScrollSpeed: 'fast' | 'standard'}),
  })
  ```

  `getConfiguration()` is a new _optional_ argument be used with all auto scrolling registration
  functions:
  - `autoScrollForElements`
  - `autoScrollWindowForElements`
  - `autoScrollForFiles`
  - `autoScrollWindowForFiles`
  - `unsafeOverflowForElements`
  - `unsafeOverflowForFiles`

  ```ts
  autoScrollForElements({
    element: myElement,
    getConfiguration: () => ({ maxScrollSpeed : 'fast' })
  }),
  ```

  We recommend using the default `"standard"` max scroll speed for most experiences. However, on
  _some_ larger experiences, a faster max scroll speed (`"fast"`) can feel better.

## 0.7.0

### Minor Changes

- [#42774](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/42774)
  [`66d9475437e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/66d9475437e) - Internal
  refactoring to improve clarity and safety

## 0.6.0

### Minor Changes

- [#42668](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/42668)
  [`0a4e3f44ba3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0a4e3f44ba3) - We have
  landed a few fixes for "overflow scrolling"
  - Fix: Time dampening could be incorrectly reset when transitioning from "over element" auto
    scrolling to "overflow" auto scrolling for certain element configurations.
  - Fix: Parent "overflow scrolling" registrations could prevent overflow scrolling on children
    elements, if the parent was registered first.
  - Fix: "overflow scrolling" `canScroll() => false` would incorrectly opt out of "overflow
    scrolling" for younger registrations.

## 0.5.0

### Minor Changes

- [#39935](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39935)
  [`20a91012629`](https://bitbucket.org/atlassian/atlassian-frontend/commits/20a91012629) - First
  public release of this package. Please refer to documentation for usage and API information.

### Patch Changes

- Updated dependencies

## 0.4.0

### Minor Changes

- [#39303](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39303)
  [`a6d9f3bb566`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a6d9f3bb566) - Adding
  optional overflow scrolling API. API information shared directly with Trello

## 0.3.2

### Patch Changes

- Updated dependencies

## 0.3.1

### Patch Changes

- Updated dependencies

## 0.3.0

### Minor Changes

- [#38658](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/38658)
  [`7803a90e9c6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7803a90e9c6) - This
  change makes it so that distance dampening is based on the size of the hitbox and not the
  container. Now that we clamp the size of the hitbox, our distance dampening needs to be based on
  the size of the hitbox, and not the container.

## 0.2.0

### Minor Changes

- [#38630](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/38630)
  [`5c643ce004d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5c643ce004d) - Limiting
  the max size of auto scrolling hitboxes. This prevents large elements having giant auto scroll
  hitboxes

## 0.1.0

### Minor Changes

- [#38525](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/38525)
  [`693af8c5775`](https://bitbucket.org/atlassian/atlassian-frontend/commits/693af8c5775) - Early
  release of our new optional drag and drop package for Pragmatic drag and drop. Package release is
  only for early integration with Trello.

### Patch Changes

- Updated dependencies