@atlaskit/editor-plugin-text-formatting 0.3.2 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/editor-plugin-text-formatting
 
+## 0.4.1
+
+### Patch Changes
+
+- [`6acf9830b36`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6acf9830b36) - Update feature flags plugin
+  (@atlaskit/editor-plugin-feature-flags) to use a named export
+  rather than default export to match other plugins.
+
+  ```ts
+  // Before
+  import featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
+
+  // After
+  import { featureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+  ```
+
+## 0.4.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.3.2
 
 ### Patch Changes

package/README.md

@@ -1,9 +1,30 @@
-# EditorPluginTextFormatting
+# Editor plugin text formatting
 
-Text-formatting plugin for @atlaskit/editor-core
+Text formatting 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-text-formatting*
+- **npm** - [@atlaskit/editor-plugin-text-formatting](https://www.npmjs.com/package/@atlaskit/editor-plugin-text-formatting)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-text-formatting)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-text-formatting/dist/)
 
 ## Usage
+---
+**Internal use only**
+
+@atlaskit/editor-plugin-text-formatting 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.
 
-`import EditorPluginTextFormatting from '@atlaskit/editor-plugin-text-formatting';`
+Please see [Atlaskit - Editor plugin text formatting](https://atlaskit.atlassian.com/packages/editor/editor-plugin-text-formatting) for documentation and examples for this package.
 
-Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-text-formatting).
+## 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

@@ -17,6 +17,10 @@ var _keymap = _interopRequireDefault(require("./pm-plugins/keymap"));
 var _main = require("./pm-plugins/main");
 var _smartInputRule = _interopRequireDefault(require("./pm-plugins/smart-input-rule"));
 var _Toolbar = _interopRequireDefault(require("./ui/Toolbar"));
+/**
+ * Text formatting plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 var textFormattingPlugin = function textFormattingPlugin(_ref) {
   var _api$analytics7, _api$analytics8, _api$analytics9, _api$analytics10, _api$analytics11, _api$analytics12, _api$analytics13;
   var options = _ref.config,

package/dist/es2019/plugin.js

@@ -10,6 +10,10 @@ import keymapPlugin from './pm-plugins/keymap';
 import { plugin as pmPlugin, pluginKey as textFormattingPluginKey } from './pm-plugins/main';
 import textFormattingSmartInputRulePlugin from './pm-plugins/smart-input-rule';
 import Toolbar from './ui/Toolbar';
+/**
+ * Text formatting plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export const textFormattingPlugin = ({
   config: options,
   api

package/dist/esm/plugin.js

@@ -10,6 +10,10 @@ import keymapPlugin from './pm-plugins/keymap';
 import { plugin as pmPlugin, pluginKey as textFormattingPluginKey } from './pm-plugins/main';
 import textFormattingSmartInputRulePlugin from './pm-plugins/smart-input-rule';
 import Toolbar from './ui/Toolbar';
+/**
+ * Text formatting plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export var textFormattingPlugin = function textFormattingPlugin(_ref) {
   var _api$analytics7, _api$analytics8, _api$analytics9, _api$analytics10, _api$analytics11, _api$analytics12, _api$analytics13;
   var options = _ref.config,

package/dist/types/plugin.d.ts

@@ -15,4 +15,8 @@ export type TextFormattingPlugin = NextEditorPlugin<'textFormatting', {
     };
     sharedState: TextFormattingState | undefined;
 }>;
+/**
+ * Text formatting plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const textFormattingPlugin: TextFormattingPlugin;

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

@@ -17,4 +17,8 @@ export type TextFormattingPlugin = NextEditorPlugin<'textFormatting', {
     };
     sharedState: TextFormattingState | undefined;
 }>;
+/**
+ * Text formatting plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 export declare const textFormattingPlugin: TextFormattingPlugin;

package/docs/0-intro.tsx

@@ -0,0 +1,55 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-core/docs/editor-use-only';
+import { token } from '@atlaskit/tokens';
+
+export default md`
+
+${createEditorUseOnlyNotice('Editor Plugin Text Formatting', [
+  { name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${(
+    <div style={{ marginTop: token('space.100', '8px') }}>
+      <AtlassianInternalWarning />
+    </div>
+  )}
+
+  This package includes the text formatting plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
+below:  
+
+${code`
+type TextFormattingPlugin = NextEditorPlugin<
+  'textFormatting',
+  {
+    pluginConfiguration: TextFormattingOptions | undefined;
+    dependencies: [OptionalPlugin<typeof analyticsPlugin>];
+    commands: {
+      toggleSuperscript: ToggleMarkEditorCommand;
+      toggleSubscript: ToggleMarkEditorCommand;
+      toggleStrike: ToggleMarkEditorCommand;
+      toggleCode: ToggleMarkEditorCommand;
+      toggleUnderline: ToggleMarkEditorCommand;
+      toggleEm: ToggleMarkEditorCommand;
+      toggleStrong: ToggleMarkEditorCommand;
+    };
+    sharedState: TextFormattingState | undefined;
+  }
+>;
+`}
+
+
+  ## 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-text-formatting",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "description": "Text-formatting 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: Scarlet",
     "singleton": true,
     "releaseModel": "continuous"
   },
@@ -32,8 +32,8 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "28.1.2",
-    "@atlaskit/editor-common": "^74.53.0",
-    "@atlaskit/editor-plugin-analytics": "^0.1.0",
+    "@atlaskit/editor-common": "^74.56.0",
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-shared-styles": "^2.5.0",
     "@atlaskit/editor-tables": "^2.3.0",
@@ -47,9 +47,9 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/editor-plugin-composition": "^0.0.2",
-    "@atlaskit/editor-plugin-decorations": "^0.1.0",
-    "@atlaskit/editor-plugin-feature-flags": "^0.1.0",
+    "@atlaskit/editor-plugin-composition": "^0.1.0",
+    "@atlaskit/editor-plugin-decorations": "^0.2.0",
+    "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@testing-library/react": "^12.1.5",
     "typescript": "~4.9.5"

package/report.api.md

@@ -42,7 +42,7 @@ export type TextFormattingPlugin = NextEditorPlugin<
   }
 >;
 
-// @public (undocumented)
+// @public
 export const textFormattingPlugin: TextFormattingPlugin;
 
 // @public (undocumented)

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

@@ -28,7 +28,7 @@ export type TextFormattingPlugin = NextEditorPlugin<'textFormatting', {
     sharedState: TextFormattingState | undefined;
 }>;
 
-// @public (undocumented)
+// @public
 export const textFormattingPlugin: TextFormattingPlugin;
 
 // @public (undocumented)