@atlaskit/editor-plugin-editor-disabled 0.1.2 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-editor-disabled
 
+## 0.2.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 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.
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -1,7 +1,30 @@
-# EditorPluginEditorDisabled
+# Editor plugin editor disabled
 
 Editor disabled 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-editor-disabled*
+- **npm** - [@atlaskit/editor-plugin-editor-disabled](https://www.npmjs.com/package/@atlaskit/editor-plugin-editor-disabled)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-editor-disabled)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-editor-disabled/dist/)
+
 ## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-editor-disabled 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 editor disabled](https://atlaskit.atlassian.com/packages/editor/editor-plugin-editor-disabled) for documentation and examples for this package.
 
-`import { editorDisabledPlugin } from '@atlaskit/editor-plugin-editor-disabled';`
+## 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

@@ -41,6 +41,10 @@ function createPlugin(dispatch) {
     }
   });
 }
+/**
+ * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 var editorDisabledPlugin = function editorDisabledPlugin() {
   return {
     name: 'editorDisabled',

package/dist/es2019/plugin.js

@@ -36,6 +36,10 @@ function createPlugin(dispatch) {
     }
   });
 }
+/**
+ * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export const editorDisabledPlugin = () => ({
   name: 'editorDisabled',
   getSharedState(editorState) {

package/dist/esm/plugin.js

@@ -35,6 +35,10 @@ function createPlugin(dispatch) {
     }
   });
 }
+/**
+ * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export var editorDisabledPlugin = function editorDisabledPlugin() {
   return {
     name: 'editorDisabled',

package/dist/types/plugin.d.ts

@@ -5,4 +5,8 @@ export type EditorDisabledPluginState = {
 export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
     sharedState: EditorDisabledPluginState;
 }>;
+/**
+ * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const editorDisabledPlugin: EditorDisabledPlugin;

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

@@ -5,4 +5,8 @@ export type EditorDisabledPluginState = {
 export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
     sharedState: EditorDisabledPluginState;
 }>;
+/**
+ * Editor disabled plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const editorDisabledPlugin: EditorDisabledPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-editor-disabled",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Editor disabled 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: Lego",
     "singleton": true,
     "releaseModel": "continuous"
   },
@@ -23,7 +23,7 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/editor-common": "^74.52.0",
+    "@atlaskit/editor-common": "^75.0.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@babel/runtime": "^7.0.0"
   },

package/report.api.md

@@ -25,7 +25,7 @@ export type EditorDisabledPlugin = NextEditorPlugin<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const editorDisabledPlugin: EditorDisabledPlugin;
 
 // @public (undocumented)

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

@@ -0,0 +1,24 @@
+## API Report File for "@atlaskit/editor-plugin-editor-disabled"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+export type EditorDisabledPlugin = NextEditorPlugin<'editorDisabled', {
+    sharedState: EditorDisabledPluginState;
+}>;
+
+// @public
+export const editorDisabledPlugin: EditorDisabledPlugin;
+
+// @public (undocumented)
+export type EditorDisabledPluginState = {
+    editorDisabled: boolean;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```