@atlaskit/editor-plugin-selection 3.1.1 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atlaskit/editor-plugin-selection
 
+## 3.2.0
+
+### Minor Changes
+
+- [`22c631389088c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/22c631389088c) -
+  Add option to provide custom selection to get\* selection actions
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.1.1
 
 ### Patch Changes

package/dist/types/types/index.d.ts

@@ -14,18 +14,28 @@ export type SetSelectionRelativeToNode = (props: {
     selectionRelativeToNode?: RelativeSelectionPos;
     selection?: Selection | null;
 }) => (state: EditorState) => Transaction;
+type SelectionUtilityOptions = {
+    /**
+     * Use a specific selection rather than the current which is the default
+     */
+    selection?: Selection;
+};
 export type EditorSelectionAPI = {
     selectNearNode: SetSelectionRelativeToNode;
     /**
      * Gets the current selection fragment.
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection fragment as an array of JSON nodes.
      */
-    getSelectionFragment: () => JSONNode[] | null;
+    getSelectionFragment: (props?: SelectionUtilityOptions) => JSONNode[] | null;
     /**
      * Gets the current selection local IDs. This includes all local IDs
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection local IDs as an array of strings.
      */
-    getSelectionLocalIds: () => string[] | null;
+    getSelectionLocalIds: (props?: SelectionUtilityOptions) => string[] | null;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

package/dist/types-ts4.5/types/index.d.ts

@@ -14,18 +14,28 @@ export type SetSelectionRelativeToNode = (props: {
     selectionRelativeToNode?: RelativeSelectionPos;
     selection?: Selection | null;
 }) => (state: EditorState) => Transaction;
+type SelectionUtilityOptions = {
+    /**
+     * Use a specific selection rather than the current which is the default
+     */
+    selection?: Selection;
+};
 export type EditorSelectionAPI = {
     selectNearNode: SetSelectionRelativeToNode;
     /**
      * Gets the current selection fragment.
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection fragment as an array of JSON nodes.
      */
-    getSelectionFragment: () => JSONNode[] | null;
+    getSelectionFragment: (props?: SelectionUtilityOptions) => JSONNode[] | null;
     /**
      * Gets the current selection local IDs. This includes all local IDs
+     * @param props Options to customise the selection fragment
+     * @param props.selection Use a specific selection rather than the current
      * @returns The current selection local IDs as an array of strings.
      */
-    getSelectionLocalIds: () => string[] | null;
+    getSelectionLocalIds: (props?: SelectionUtilityOptions) => string[] | null;
 };
 export interface SelectionPluginOptions extends LongPressSelectionPluginOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-selection",
-	"version": "3.1.1",
+	"version": "3.2.0",
 	"description": "Selection plugin for @atlaskit/editor-core",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -25,12 +25,12 @@
 		"@atlaskit/editor-shared-styles": "^3.6.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^11.3.0",
+		"@atlaskit/tmp-editor-statsig": "^11.5.0",
 		"@atlaskit/tokens": "^6.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.27.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {