@atlaskit/editor-plugin-grid 0.1.6 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @atlaskit/editor-plugin-grid
 
+## 0.2.0
+
+### Minor Changes
+
+- [`ad3c5c21079`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ad3c5c21079) - Updating all plugins with minor version to correct issue with semver.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 0.1.7
+
+### Patch Changes
+
+- [`8467bdcdf4f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8467bdcdf4f) - Removing `dependencies` prop from PluginInjectionAPI and changing
+  signature of `NextEditorPlugin`.
+
+  Previously a `NextEditorPlugin` would be consumed as so:
+
+  ```ts
+  const plugin: NextEditorPlugin< ... > = (config, api) => {
+    // Can use api like so:
+    api.dependencies.core.actions.execute( ... )
+    return { ... }
+  }
+  ```
+
+  Now these have become named parameters like so and the `pluginInjectionAPI` is used
+  without the `dependencies` prop:
+
+  ```ts
+  const plugin: NextEditorPlugin< ... > = ({ config, api }) => {
+    // Can use api like so:
+    api.core.actions.execute( ... )
+    return { ... }
+  }
+  ```
+
+- Updated dependencies
+
 ## 0.1.6
 
 ### Patch Changes

package/README.md

@@ -1,7 +1,30 @@
-# EditorPluginGrid
+# Editor plugin grid
 
 Grid plugin for @atlaskit/editor-core
 
+**Note:** This component is designed for internal Atlassian development.
+External contributors will be able to use this component but will not be able to submit issues.
+
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-grid*
+- **npm** - [@atlaskit/editor-plugin-grid](https://www.npmjs.com/package/@atlaskit/editor-plugin-grid)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-grid)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-grid/dist/)
+
 ## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-grid is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+
+Direct use of this component is not supported.
+
+Please see [Atlaskit - Editor plugin grid](https://atlaskit.atlassian.com/packages/editor/editor-plugin-grid) for documentation and examples for this package.
 
-`import { gridPlugin } from '@atlaskit/editor-plugin-grid';`
+## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.

package/dist/cjs/plugin.js

@@ -143,7 +143,13 @@ var gridPMPlugin = new _safePlugin.SafePlugin({
     }
   }
 });
-var gridPlugin = function gridPlugin(options, api) {
+/**
+ * Grid plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+var gridPlugin = function gridPlugin(_ref5) {
+  var options = _ref5.config,
+    api = _ref5.api;
   return {
     name: 'grid',
     getSharedState: function getSharedState(editorState) {
@@ -163,8 +169,8 @@ var gridPlugin = function gridPlugin(options, api) {
         }
       }];
     },
-    contentComponent: function contentComponent(_ref5) {
-      var editorView = _ref5.editorView;
+    contentComponent: function contentComponent(_ref6) {
+      var editorView = _ref6.editorView;
       return /*#__PURE__*/_react.default.createElement(ContentComponent, {
         editorView: editorView,
         options: options,

package/dist/es2019/plugin.js

@@ -134,7 +134,14 @@ const gridPMPlugin = new SafePlugin({
     }
   }
 });
-export const gridPlugin = (options, api) => {
+/**
+ * Grid plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export const gridPlugin = ({
+  config: options,
+  api
+}) => {
   return {
     name: 'grid',
     getSharedState(editorState) {

package/dist/esm/plugin.js

@@ -135,7 +135,13 @@ var gridPMPlugin = new SafePlugin({
     }
   }
 });
-export var gridPlugin = function gridPlugin(options, api) {
+/**
+ * Grid plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export var gridPlugin = function gridPlugin(_ref5) {
+  var options = _ref5.config,
+    api = _ref5.api;
   return {
     name: 'grid',
     getSharedState: function getSharedState(editorState) {
@@ -155,8 +161,8 @@ export var gridPlugin = function gridPlugin(options, api) {
         }
       }];
     },
-    contentComponent: function contentComponent(_ref5) {
-      var editorView = _ref5.editorView;
+    contentComponent: function contentComponent(_ref6) {
+      var editorView = _ref6.editorView;
       return /*#__PURE__*/React.createElement(ContentComponent, {
         editorView: editorView,
         options: options,

package/dist/types/plugin.d.ts

@@ -19,5 +19,9 @@ export type GridPlugin = NextEditorPlugin<'grid', {
         displayGrid: CreateDisplayGrid;
     };
 }>;
+/**
+ * Grid plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const gridPlugin: GridPlugin;
 export {};

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

@@ -21,5 +21,9 @@ export type GridPlugin = NextEditorPlugin<'grid', {
         displayGrid: CreateDisplayGrid;
     };
 }>;
+/**
+ * Grid plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const gridPlugin: GridPlugin;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-grid",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Grid plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -8,7 +8,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "atlassian": {
-    "team": "Editor",
+    "team": "Editor: Media Experience Porygon",
     "singleton": true,
     "releaseModel": "continuous"
   },
@@ -23,8 +23,8 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.52.0",
-    "@atlaskit/editor-plugin-width": "^0.1.0",
+    "@atlaskit/editor-common": "^74.55.0",
+    "@atlaskit/editor-plugin-width": "^0.2.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-shared-styles": "^2.6.0",
     "@babel/runtime": "^7.0.0",

package/report.api.md

@@ -39,7 +39,7 @@ export type GridPlugin = NextEditorPlugin<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const gridPlugin: GridPlugin;
 
 // @public (undocumented)

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,54 @@
+## API Report File for "@atlaskit/editor-plugin-grid"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { GridType } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { WidthPlugin } from '@atlaskit/editor-plugin-width';
+
+// @public (undocumented)
+type CreateDisplayGrid = (view: EditorView) => DisplayGrid;
+
+// @public (undocumented)
+type DisplayGrid = (props: Required_2<GridPluginState>) => boolean;
+
+// @public (undocumented)
+export type GridPlugin = NextEditorPlugin<'grid', {
+    pluginConfiguration: GridPluginOptions | undefined;
+    dependencies: [WidthPlugin];
+    sharedState: GridPluginState | null;
+    actions: {
+        displayGrid: CreateDisplayGrid;
+    };
+}>;
+
+// @public
+export const gridPlugin: GridPlugin;
+
+// @public (undocumented)
+interface GridPluginOptions {
+    // (undocumented)
+    shouldCalcBreakoutGridLines?: boolean;
+}
+
+// @public (undocumented)
+type GridPluginState = {
+    visible: boolean;
+    gridType?: GridType;
+    highlight: Highlights;
+};
+
+// @public (undocumented)
+export type Highlights = Array<'full-width' | 'wide' | number>;
+
+// @public (undocumented)
+type Required_2<T> = {
+    [P in keyof T]-?: T[P];
+};
+
+// (No @packageDocumentation comment for this package)
+
+```