@atlaskit/editor-plugin-ufo 8.0.22 → 8.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +41 -1
  3. package/docs/0-intro.tsx +43 -0
  4. package/package.json +2 -2
  5. package/tsconfig.dev.json +9 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @atlaskit/editor-plugin-ufo
2
2
 
3
+ ## 8.0.23
4
+
5
+ ### Patch Changes
6
+
7
+ - [`9ff7d1c1aa288`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9ff7d1c1aa288) -
8
+ Update README.md and 0-intro.tsx
9
+ - Updated dependencies
10
+
3
11
  ## 8.0.22
4
12
 
5
13
  ### Patch Changes
package/README.md CHANGED
@@ -1 +1,41 @@
1
- # Editor plugin ufo
1
+ # Editor Plugin UFO
2
+
3
+ UFO plugin for @atlaskit/editor-core
4
+
5
+ **Note:** This component is designed for internal Atlassian development.
6
+ External contributors will be able to use this component but will not be able to submit issues.
7
+
8
+ ## Overview
9
+
10
+ The UFO (User-Facing Operations) plugin provides performance monitoring and interaction tracking capabilities for the Atlassian Editor. It integrates with `@atlaskit/react-ufo` to abort UFO measurements when user interactions occur, ensuring accurate performance metrics by preventing false measurements from ongoing interactions.
11
+
12
+ ## Key features
13
+
14
+ - **Interaction tracking** - Monitors first user interaction with the editor to abort ongoing UFO measurements
15
+ - **SSR compatibility** - Automatically disabled in server-side rendering environments
16
+ - **Event-based abort** - Aborts UFO measurements on various user interaction events (wheel, keydown, mousedown, pointerdown, pointerup, touchend, scroll, mouseover)
17
+ - **Selection change detection** - Aborts active 'edit-page' and 'live-edit' UFO interactions when editor selection changes
18
+
19
+ ## Install
20
+ ---
21
+ - **Install** - *yarn add @atlaskit/editor-plugin-ufo*
22
+ - **npm** - [@atlaskit/editor-plugin-ufo](https://www.npmjs.com/package/@atlaskit/editor-plugin-ufo)
23
+ - **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-ufo)
24
+ - **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-ufo/dist/)
25
+
26
+ ## Usage
27
+ ---
28
+ **Internal use only**
29
+
30
+ @atlaskit/editor-plugin-ufo is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
31
+
32
+ Direct use of this component is not supported.
33
+
34
+ Please see [Atlaskit - Editor plugin ufo](https://atlaskit.atlassian.com/packages/editor/editor-plugin-ufo) for documentation and examples for this package.
35
+
36
+ ## Support
37
+ ---
38
+ 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.
39
+ ## License
40
+ ---
41
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
package/docs/0-intro.tsx ADDED
@@ -0,0 +1,43 @@
1
+ import React from 'react';
2
+
3
+ import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
4
+ // eslint-disable-next-line @atlassian/tangerine/import/entry-points
5
+ import { createEditorUseOnlyNotice } from '@atlaskit/editor-common/doc-utils';
6
+ import { token } from '@atlaskit/tokens';
7
+
8
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
9
+ const _default_1: any = md`
10
+
11
+ ${createEditorUseOnlyNotice('Editor Plugin UFO', [
12
+ { name: 'Editor Core', link: '/packages/editor/editor-core' },
13
+ ])}\
14
+
15
+ ${
16
+ (
17
+ // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
18
+ <div style={{ marginTop: token('space.100', '8px') }}>
19
+ <AtlassianInternalWarning />
20
+ </div>
21
+ )
22
+ }\
23
+
24
+ This package includes the UFO plugin used by \`@atlaskit/editor-core\`.
25
+
26
+ ## Usage
27
+ ---
28
+
29
+ The exported types of the plugin are defined below:
30
+
31
+ ${code`
32
+ export type UfoPlugin = NextEditorPlugin<'ufo', Object>;
33
+ `}\
34
+
35
+
36
+ ## Support
37
+ ---
38
+ 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.
39
+ ## License
40
+ ---
41
+ Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
42
+ `;
43
+ export default _default_1;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-ufo",
3
- "version": "8.0.22",
3
+ "version": "8.0.23",
4
4
  "description": "Ufo plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -30,7 +30,7 @@
30
30
  "dependencies": {
31
31
  "@atlaskit/editor-prosemirror": "^7.3.0",
32
32
  "@atlaskit/react-ufo": "^5.12.0",
33
- "@atlaskit/tmp-editor-statsig": "^57.0.0",
33
+ "@atlaskit/tmp-editor-statsig": "^58.0.0",
34
34
  "@babel/runtime": "^7.0.0"
35
35
  },
36
36
  "peerDependencies": {
package/tsconfig.dev.json CHANGED
@@ -40,6 +40,15 @@
40
40
  "references": [
41
41
  {
42
42
  "path": "./tsconfig.app.json"
43
+ },
44
+ {
45
+ "path": "../../../build/website/docs/tsconfig.app.json"
46
+ },
47
+ {
48
+ "path": "../editor-common/tsconfig.app.json"
49
+ },
50
+ {
51
+ "path": "../../design-system/tokens/tsconfig.app.json"
43
52
  }
44
53
  ]
45
54
  }