@atlaskit/editor-common 103.20.0 → 103.21.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-common
 
+## 103.21.0
+
+### Minor Changes
+
+- [#142736](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/142736)
+  [`0ec12ef9f6524`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0ec12ef9f6524) -
+  [ux] scrollToPos function added to the core plugin. It can be accessed via
+  editorAPI.core.actions.scrollToPos().
+
 ## 103.20.0
 
 ### Minor Changes

package/dist/cjs/monitoring/error.js

@@ -17,7 +17,7 @@ function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "103.20.0";
+var packageVersion = "103.21.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/cjs/preset/core-plugin/index.js

@@ -54,6 +54,29 @@ var corePlugin = exports.corePlugin = function corePlugin(_ref) {
         editorView.dom.blur();
         return true;
       },
+      scrollToPos: function scrollToPos(pos, scrollOptions) {
+        var editorView = config === null || config === void 0 ? void 0 : config.getEditorView();
+        if (!editorView) {
+          return false;
+        }
+        var tr = editorView.state.tr;
+        var isValidPos = typeof pos === 'number' && pos >= 0 && pos <= tr.doc.content.size;
+        if (!isValidPos) {
+          return false;
+        }
+        var dom = editorView.domAtPos(pos).node;
+        if (!(dom instanceof Element)) {
+          // If it's not an element (e.g. #text node), we'll try the parent.
+          // This is expected to cover most of the scenarios, if not, window.scrollTo is an alternative
+          if (dom.parentNode instanceof Element) {
+            dom.parentNode.scrollIntoView(scrollOptions);
+            return true;
+          }
+          return false;
+        }
+        dom.scrollIntoView(scrollOptions);
+        return true;
+      },
       replaceDocument: function replaceDocument(replaceValue, options) {
         var editorView = config === null || config === void 0 ? void 0 : config.getEditorView();
         if (!editorView || replaceValue === undefined || replaceValue === null) {

package/dist/cjs/ui/DropList/index.js

@@ -23,7 +23,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * @jsx jsx
  */ // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "103.20.0";
+var packageVersion = "103.21.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/es2019/monitoring/error.js

@@ -1,7 +1,7 @@
 import { isFedRamp } from './environment';
 const SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 const packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-const packageVersion = "103.20.0";
+const packageVersion = "103.21.0";
 const sanitiseSentryEvents = (data, _hint) => {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/es2019/preset/core-plugin/index.js

@@ -52,6 +52,29 @@ export const corePlugin = ({
         editorView.dom.blur();
         return true;
       },
+      scrollToPos(pos, scrollOptions) {
+        const editorView = config === null || config === void 0 ? void 0 : config.getEditorView();
+        if (!editorView) {
+          return false;
+        }
+        const tr = editorView.state.tr;
+        const isValidPos = typeof pos === 'number' && pos >= 0 && pos <= tr.doc.content.size;
+        if (!isValidPos) {
+          return false;
+        }
+        const dom = editorView.domAtPos(pos).node;
+        if (!(dom instanceof Element)) {
+          // If it's not an element (e.g. #text node), we'll try the parent.
+          // This is expected to cover most of the scenarios, if not, window.scrollTo is an alternative
+          if (dom.parentNode instanceof Element) {
+            dom.parentNode.scrollIntoView(scrollOptions);
+            return true;
+          }
+          return false;
+        }
+        dom.scrollIntoView(scrollOptions);
+        return true;
+      },
       replaceDocument: (replaceValue, options) => {
         const editorView = config === null || config === void 0 ? void 0 : config.getEditorView();
         if (!editorView || replaceValue === undefined || replaceValue === null) {

package/dist/es2019/ui/DropList/index.js

@@ -13,7 +13,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 const packageName = "@atlaskit/editor-common";
-const packageVersion = "103.20.0";
+const packageVersion = "103.21.0";
 const halfFocusRing = 1;
 const dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/esm/monitoring/error.js

@@ -7,7 +7,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { isFedRamp } from './environment';
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "103.20.0";
+var packageVersion = "103.21.0";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // Ignored via go/ees007

package/dist/esm/preset/core-plugin/index.js

@@ -49,6 +49,29 @@ export var corePlugin = function corePlugin(_ref) {
         editorView.dom.blur();
         return true;
       },
+      scrollToPos: function scrollToPos(pos, scrollOptions) {
+        var editorView = config === null || config === void 0 ? void 0 : config.getEditorView();
+        if (!editorView) {
+          return false;
+        }
+        var tr = editorView.state.tr;
+        var isValidPos = typeof pos === 'number' && pos >= 0 && pos <= tr.doc.content.size;
+        if (!isValidPos) {
+          return false;
+        }
+        var dom = editorView.domAtPos(pos).node;
+        if (!(dom instanceof Element)) {
+          // If it's not an element (e.g. #text node), we'll try the parent.
+          // This is expected to cover most of the scenarios, if not, window.scrollTo is an alternative
+          if (dom.parentNode instanceof Element) {
+            dom.parentNode.scrollIntoView(scrollOptions);
+            return true;
+          }
+          return false;
+        }
+        dom.scrollIntoView(scrollOptions);
+        return true;
+      },
       replaceDocument: function replaceDocument(replaceValue, options) {
         var editorView = config === null || config === void 0 ? void 0 : config.getEditorView();
         if (!editorView || replaceValue === undefined || replaceValue === null) {

package/dist/esm/ui/DropList/index.js

@@ -20,7 +20,7 @@ import withAnalyticsContext from '@atlaskit/analytics-next/withAnalyticsContext'
 import withAnalyticsEvents from '@atlaskit/analytics-next/withAnalyticsEvents';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "103.20.0";
+var packageVersion = "103.21.0";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 // Ignored via go/ees005

package/dist/types/types/next-editor-plugin.d.ts

@@ -50,6 +50,14 @@ export type CorePlugin = NextEditorPlugin<'core', {
          * @returns (boolean) if the blur was successful
          */
         blur: () => boolean;
+        /**
+         * Scroll to a specific position in the editor using native Element.scrollIntoView
+         *
+         * @param pos - Position number scroll to
+         * @param scrollOptions - [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
+         * @returns (boolean) if scroll was successful
+         */
+        scrollToPos: (pos: number, scrollOptions?: boolean | ScrollIntoViewOptions) => boolean;
         /**
          * Replaces the current content of the editor with the provided raw value.
          *

package/dist/types-ts4.5/types/next-editor-plugin.d.ts

@@ -50,6 +50,14 @@ export type CorePlugin = NextEditorPlugin<'core', {
          * @returns (boolean) if the blur was successful
          */
         blur: () => boolean;
+        /**
+         * Scroll to a specific position in the editor using native Element.scrollIntoView
+         *
+         * @param pos - Position number scroll to
+         * @param scrollOptions - [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)
+         * @returns (boolean) if scroll was successful
+         */
+        scrollToPos: (pos: number, scrollOptions?: boolean | ScrollIntoViewOptions) => boolean;
         /**
          * Replaces the current content of the editor with the provided raw value.
          *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "103.20.0",
+	"version": "103.21.0",
 	"description": "A package that contains common classes and components for editor and renderer",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -156,10 +156,10 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/popper": "^7.0.0",
 		"@atlaskit/primitives": "^14.4.0",
-		"@atlaskit/profilecard": "^23.9.0",
+		"@atlaskit/profilecard": "^23.10.0",
 		"@atlaskit/react-ufo": "^3.9.0",
 		"@atlaskit/section-message": "^8.2.0",
-		"@atlaskit/smart-card": "^36.11.0",
+		"@atlaskit/smart-card": "^36.12.0",
 		"@atlaskit/smart-user-picker": "^8.0.0",
 		"@atlaskit/spinner": "^18.0.0",
 		"@atlaskit/task-decision": "^19.2.0",