@atlaskit/editor-plugin-width

Version:
Width plugin for @atlaskit/editor-core
bitbucket.org/atlassian/atlassian-frontend-mirror
870 lines (502 loc) • 19.6 kB
Markdown
# @atlaskit/editor-plugin-width

## 31.0.0

### Patch Changes

- Updated dependencies

## 30.0.1

### Patch Changes

- [`7e9b540abc74b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7e9b540abc74b) -
  Behind `platform_editor_reduce_forced_layout`, use `window.innerWidth` instead of
  `window.outerWidth` for the width plugin's initial placeholder width. `outerWidth` includes
  browser chrome and ignores page zoom, so content first rendered against an overstated width and
  shifted once the real width was measured.
- Updated dependencies

## 30.0.0

### Patch Changes

- Updated dependencies

## 29.0.0

### Patch Changes

- Updated dependencies

## 28.0.0

### Patch Changes

- Updated dependencies

## 27.0.0

### Patch Changes

- Updated dependencies

## 26.0.0

### Patch Changes

- Updated dependencies

## 25.0.0

### Patch Changes

- Updated dependencies

## 24.1.0

### Minor Changes

- [`4a10837c24245`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4a10837c24245) -
  Reduce forced layout in the width plugin, behind the `platform_editor_reduce_forced_layout`
  experiment.

  `useWidthObserver` selects between the existing observer hook and a new
  `useResizeWidthObserverNext` using `conditionalHooksFactory`, so only one implementation runs and
  the existing one is left unchanged.

  The replacement no longer reads `editorView.dom.clientWidth` from its dependency array. Dependency
  arrays are evaluated during React's render phase, so that read forced a style and layout
  recalculation on every render of the plugin slot rather than only when the width changed. It is
  replaced by a counter from `useRefreshWidthOnTransitionNext`, which detects the same `full-width`
  to `full-page` transition without measuring. The `ResizeObserver` callback also no longer discards
  deliveries that batch more than one entry, which previously left the plugin with a stale width
  until the next resize, and no longer dispatches an undefined width when the editor has no
  container element.

  The plugin's initial state no longer measures `document.body.offsetWidth`. `init` runs before the
  editor is in the DOM, so the body is the only thing it can measure, and that read forces a style
  and layout recalculation on every editor creation, including each renderer to editor transition.
  It is replaced by `window.outerWidth`, an OS window dimension rather than a layout property, so it
  can be read without forcing a recalculation. The two can report different numbers where the body
  is narrower than the window, but both are only a stand-in for the container width until the resize
  observer reports the real value, and neither is close enough to it to cross the thresholds
  consumers branch on.

  `@atlaskit/editor-plugin-width` adds `@atlaskit/platform-feature-experiments` and
  `@atlaskit/platform-feature-flags-react` as dependencies.

### Patch Changes

- Updated dependencies

## 24.0.0

### Patch Changes

- Updated dependencies

## 23.0.0

### Patch Changes

- Updated dependencies

## 22.0.0

### Patch Changes

- Updated dependencies

## 21.0.0

### Patch Changes

- Updated dependencies

## 20.0.0

### Patch Changes

- Updated dependencies

## 19.0.0

### Patch Changes

- Updated dependencies

## 18.0.0

### Patch Changes

- Updated dependencies

## 17.1.0

### Minor Changes

- [`bd2c5b0112185`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bd2c5b0112185) -
  Remove stale API report artifacts from published Platform packages.

### Patch Changes

- Updated dependencies

## 17.0.0

### Patch Changes

- Updated dependencies

## 16.0.0

### Patch Changes

- Updated dependencies

## 15.0.0

### Patch Changes

- Updated dependencies

## 14.0.0

### Patch Changes

- Updated dependencies

## 13.1.0

### Minor Changes

- [`51c33ef5349b6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/51c33ef5349b6) -
  Enable compatibility with React 19.2.0

### Patch Changes

- Updated dependencies

## 13.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

## 12.0.0

### Patch Changes

- Updated dependencies

## 11.1.0

### Minor Changes

- [`ebab8f80bfc40`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ebab8f80bfc40) -
  Autofix: add explicit package exports (barrel removal)

### Patch Changes

- Updated dependencies

## 11.0.0

### Patch Changes

- Updated dependencies

## 10.0.0

### Patch Changes

- Updated dependencies

## 9.0.3

### Patch Changes

- [`7b7c52dff5d7d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7b7c52dff5d7d) -
  Fix eslint violations for type import syntax

## 9.0.2

### Patch Changes

- [`9ff7d1c1aa288`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9ff7d1c1aa288) -
  Update README.md and 0-intro.tsx
- Updated dependencies

## 9.0.1

### Patch Changes

- [`0f4a08b633f6e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0f4a08b633f6e) -
  Internal changes to remove unnecessary token fallbacks and imports from `@atlaskit/theme`
- Updated dependencies

## 9.0.0

### Patch Changes

- Updated dependencies

## 8.1.0

### Minor Changes

- [`d4d2a325144b8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d4d2a325144b8) -
  [EDITOR-4646](https://hello.jira.atlassian.cloud/browse/EDITOR-4646) - clean up
  platform_editor_stop_width_reflows

## 8.0.0

### Patch Changes

- Updated dependencies

## 7.0.7

### Patch Changes

- Updated dependencies

## 7.0.6

### Patch Changes

- Updated dependencies

## 7.0.5

### Patch Changes

- [`55920a92e882a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/55920a92e882a) -
  tsignores added for help-center local consumpton removed
- Updated dependencies

## 7.0.4

### Patch Changes

- Updated dependencies

## 7.0.3

### Patch Changes

- [`4d676bbdb3ce6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4d676bbdb3ce6) -
  ts-ignore added temporarily to unblock local consumption for help-center, will be removed once
  project refs are setup
- Updated dependencies

## 7.0.2

### Patch Changes

- Updated dependencies

## 7.0.1

### Patch Changes

- Updated dependencies

## 7.0.0

### Patch Changes

- Updated dependencies

## 6.0.2

### Patch Changes

- [`a77acd87fef67`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a77acd87fef67) -
  EDITOR-1391 add new analytics event which logs editor width and all table widths on the page once
  after page is loaded in both editor and renderer. remove previous implementation in width plugin.
- Updated dependencies

## 6.0.1

### Patch Changes

- [`cef73d344aa16`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cef73d344aa16) -
  EDITOR-1391 add analytics event for initial editor width
- Updated dependencies

## 6.0.0

### Patch Changes

- Updated dependencies

## 5.0.0

### Patch Changes

- Updated dependencies

## 4.0.5

### Patch Changes

- Updated dependencies

## 4.0.4

### Patch Changes

- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
  Sorted type and interface props to improve Atlaskit docs

## 4.0.3

### Patch Changes

- Updated dependencies

## 4.0.2

### Patch Changes

- Updated dependencies

## 4.0.1

### Patch Changes

- Updated dependencies

## 4.0.0

### Major Changes

- [#181024](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/181024)
  [`8e80c487ca307`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8e80c487ca307) - ##
  Make `@atlaskit/editor-common` a peer dependency

  **WHAT:** `@atlaskit/editor-common` has been moved from `dependencies` to `peerDependencies` in
  all editor plugin packages.

  **WHY:** This change ensures that only a single version of `@atlaskit/editor-common` is used in
  consuming applications, preventing issues caused by multiple versions of singleton libraries (such
  as context mismatches or duplicated state). This is especially important for packages that rely on
  shared context or singletons.

  **HOW TO ADJUST:**
  - Consumers must now explicitly install `@atlaskit/editor-common` in their own project if they use
    any of these editor plugins.
  - Ensure the version you install matches the version required by the plugins.
  - You can use the
    [`check-peer-dependencies`](https://www.npmjs.com/package/check-peer-dependencies) package to
    verify that all required peer dependencies are installed and compatible.
  - Example install command:
    ```
    npm install @atlaskit/editor-common
    ```
    or
    ```
    yarn add @atlaskit/editor-common
    ```

  **Note:** This is a breaking change. If `@atlaskit/editor-common` is not installed at the
  application level, you may see errors or unexpected behavior.

### Patch Changes

- Updated dependencies

## 3.0.11

### Patch Changes

- Updated dependencies

## 3.0.10

### Patch Changes

- Updated dependencies

## 3.0.9

### Patch Changes

- Updated dependencies

## 3.0.8

### Patch Changes

- Updated dependencies

## 3.0.7

### Patch Changes

- Updated dependencies

## 3.0.6

### Patch Changes

- [#159894](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/159894)
  [`98f3c43ca93c5`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/98f3c43ca93c5) -
  Avoid unnecessary reflows in the width plugin.
- Updated dependencies

## 3.0.5

### Patch Changes

- Updated dependencies

## 3.0.4

### Patch Changes

- Updated dependencies

## 3.0.3

### Patch Changes

- Updated dependencies

## 3.0.2

### Patch Changes

- Updated dependencies

## 3.0.1

### Patch Changes

- Updated dependencies

## 3.0.0

### Major Changes

- [#117363](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/117363)
  [`10a0f7f6c2027`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/10a0f7f6c2027) -
  This package's `peerDependencies` have been adjusted for `react` and/or `react-dom` to reflect the
  status of only supporting React 18 going forward. No explicit breaking change to React support has
  been made in this release, but this is to signify going forward, breaking changes for React 16 or
  React 17 may come via non-major semver releases.

  Please refer this community post for more details:
  https://community.developer.atlassian.com/t/rfc-78-dropping-support-for-react-16-and-rendering-in-a-react-18-concurrent-root-in-jira-and-confluence/87026

### Patch Changes

- Updated dependencies

## 2.1.0

### Minor Changes

- [#105322](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/105322)
  [`8876083532adc`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8876083532adc) -
  Bumped editor-prosemirror version to 7.0.0

### Patch Changes

- Updated dependencies

## 2.0.4

### Patch Changes

- Updated dependencies

## 2.0.3

### Patch Changes

- [#103674](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/103674)
  [`5cd5e35c2e27c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5cd5e35c2e27c) -
  Cleanup flag that gated change to PluginSlot using a React18 compatible component

## 2.0.2

### Patch Changes

- Updated dependencies

## 2.0.1

### Patch Changes

- Updated dependencies

## 2.0.0

### Major Changes

- [#98576](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/98576)
  [`fb72f1550d5f1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/fb72f1550d5f1) -
  Removed external re-export from entry file:

  @atlaskit/editor-plugin-width:
  - type `WidthPluginState` -> Use type `EditorContainerWidth` from `@atlaskit/editor-common/types`
    instead

### Patch Changes

- Updated dependencies

## 1.3.14

### Patch Changes

- Updated dependencies

## 1.3.13

### Patch Changes

- Updated dependencies

## 1.3.12

### Patch Changes

- Updated dependencies

## 1.3.11

### Patch Changes

- [#155735](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/155735)
  [`1beeeda29023a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1beeeda29023a) -
  Upgrades editor packages to react 18

## 1.3.10

### Patch Changes

- Updated dependencies

## 1.3.9

### Patch Changes

- [#149735](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/149735)
  [`bca64a14f9448`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/bca64a14f9448) -
  Fix bug where width plugin state doesn't update on appearance change

## 1.3.8

### Patch Changes

- Updated dependencies

## 1.3.7

### Patch Changes

- Updated dependencies

## 1.3.6

### Patch Changes

- Updated dependencies

## 1.3.5

### Patch Changes

- Updated dependencies

## 1.3.4

### Patch Changes

- [#141343](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/141343)
  [`3893ae8e037fb`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/3893ae8e037fb) -
  Rearranging plugins to meet folder structure linting guidelines.

## 1.3.3

### Patch Changes

- [#139334](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/139334)
  [`30793649657c0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/30793649657c0) -
  [HOT-111629] We had an incident where the last character disappears when hitting the enter key on
  windows OS for Korean characters. Bumping to prosemirror-view@1.34.2 for the fix.

## 1.3.2

### Patch Changes

- Updated dependencies

## 1.3.1

### Patch Changes

- Updated dependencies

## 1.3.0

### Minor Changes

- [#130825](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/130825)
  [`d8a00de5637ff`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/d8a00de5637ff) -
  ENGHEALTH-9890: Bumps React peer dependency for Lego editor plugins

## 1.2.1

### Patch Changes

- Updated dependencies

## 1.2.0

### Minor Changes

- [#124209](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/124209)
  [`8aa1792f12ed3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8aa1792f12ed3) -
  bump @atlaskit/editor-prosemirror to 5.0.0, bump @atlaskit/adf-schema to 40.1.0

### Patch Changes

- Updated dependencies

## 1.1.9

### Patch Changes

- Updated dependencies

## 1.1.8

### Patch Changes

- Updated dependencies

## 1.1.7

### Patch Changes

- Updated dependencies

## 1.1.6

### Patch Changes

- Updated dependencies

## 1.1.5

### Patch Changes

- Updated dependencies

## 1.1.4

### Patch Changes

- Updated dependencies

## 1.1.3

### Patch Changes

- Updated dependencies

## 1.1.2

### Patch Changes

- [#97698](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/97698)
  [`1c7b378c0d3b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/1c7b378c0d3b) -
  [HOT-108999] We had an incident where the cursor jumps back a character in table headers for any
  language triggering composition on an empty line.This was fixed in a patch bump of
  prosemirror-view. https://github.com/ProseMirror/prosemirror-view/compare/1.33.4...1.33.5

## 1.1.1

### Patch Changes

- Updated dependencies

## 1.1.0

### Minor Changes

- [#91934](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91934)
  [`b76a78c6a199`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b76a78c6a199) -
  bumped editor-prosemirror version to 4.0.0

### Patch Changes

- Updated dependencies

## 1.0.2

### 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.1

### Patch Changes

- Updated dependencies

## 1.0.0

### Major Changes

- [#72386](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/72386)
  [`0c52b0be40c1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0c52b0be40c1) -
  This changeset exists to bump all editor plugins that currently don't have a major version. This
  is to address an issue with Jira plugin consumption.

## 0.2.5

### Patch Changes

- [#68572](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/68572)
  [`15d407fe5143`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/15d407fe5143) -
  Upgrading @atlaskit/editor-prosemirror dependency

## 0.2.4

### Patch Changes

- Updated dependencies

## 0.2.3

### Patch Changes

- Updated dependencies

## 0.2.2

### Patch Changes

- [#39984](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39984)
  [`37c62369dae`](https://bitbucket.org/atlassian/atlassian-frontend/commits/37c62369dae) - NO-ISSUE
  Import doc builder types from editor-common

## 0.2.1

### Patch Changes

- Updated dependencies

## 0.2.0

### Minor Changes

- [#39325](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39325)
  [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating
  all plugins with minor version to correct issue with semver.

## 0.1.4

### Patch Changes

- [#39177](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/39177)
  [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added
  atlaskit docs to all existing plugins.

## 0.1.3

### Patch Changes

- Updated dependencies

## 0.1.2

### Patch Changes

- [#37785](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/37785)
  [`4e6f1bf8511`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4e6f1bf8511) -
  [ED-19233] Import prosemirror libraries from internal facade package

## 0.1.1

### Patch Changes

- [#35782](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/35782)
  [`73b5128036b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/73b5128036b) -
  [ED-17082] Mark package as a singleton one
- Updated dependencies

## 0.1.0

### Minor Changes

- [#34938](https://bitbucket.org/atlassian/atlassian-frontend/pull-requests/34938)
  [`7cd4abcdc0d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7cd4abcdc0d) - Fix
  workaround in `editor-plugin-width`. This involved removing `WidthEmitter` in `editor-core`,
  removing `containerWidth` from `WidthPluginState`. This change also introduces `usePluginHook` for
  an `EditorPlugin` - this enables a react hook to be mounted for plugins (in all appearances).

### Patch Changes

- Updated dependencies