@atlaskit/editor-core 223.2.0 → 224.0.0
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.
- package/CHANGELOG.md +22 -0
- package/dist/cjs/ui/EditorContentContainer/styles/editorUGCTokenStyles.js +1 -26
- package/dist/cjs/utils/extensions.js +3 -1
- package/dist/cjs/version-wrapper.js +1 -1
- package/dist/es2019/ui/EditorContentContainer/styles/editorUGCTokenStyles.js +0 -25
- package/dist/es2019/utils/extensions.js +3 -0
- package/dist/es2019/version-wrapper.js +1 -1
- package/dist/esm/ui/EditorContentContainer/styles/editorUGCTokenStyles.js +0 -25
- package/dist/esm/utils/extensions.js +3 -1
- package/dist/esm/version-wrapper.js +1 -1
- package/dist/types/ui/EditorContentContainer/styles/editorUGCTokenStyles.d.ts +0 -14
- package/package.json +14 -17
- package/editor-core.docs.tsx +0 -70
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# @atlaskit/editor-core
|
|
2
2
|
|
|
3
|
+
## 224.0.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`603baa8adc517`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/603baa8adc517) -
|
|
8
|
+
Clean up feature gate `atlas_editor_typography_refreshed`
|
|
9
|
+
- [`bb37742539a7d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bb37742539a7d) -
|
|
10
|
+
Rename Quick Insert category analytics from app counts to macro counts, add reusable extension app
|
|
11
|
+
identity, and track internal, ecosystem, and all macro/app counts for externally provided items
|
|
12
|
+
behind `platform_editor_slash_app_category_analytics`. GUID-only app identities are grouped as
|
|
13
|
+
`unknown`.
|
|
14
|
+
|
|
15
|
+
Breaking change: `CategoryInformation` and `QuickInsertInformationAttributes` from
|
|
16
|
+
`@atlaskit/editor-common/analytics/types/quick-insert-events` have changed shape. Update usages to
|
|
17
|
+
the new fields (`internalMacroCount`, `internalAppCount`, `internalAppMacroMax`,
|
|
18
|
+
`ecosystemMacroCount`, `ecosystemAppCount`, `ecosystemAppMacroMax`, `allMacroCount`,
|
|
19
|
+
`allAppCount`, and `allAppMacroMax`) and add the `allCategories` aggregate. Remove references to
|
|
20
|
+
the removed `appCount` and `appMacros` fields. `ExtensionApp.ownership` has been replaced by
|
|
21
|
+
`ExtensionApp.source` (`internal` or `ecosystem`); update app metadata producers accordingly.
|
|
22
|
+
|
|
23
|
+
- Updated dependencies
|
|
24
|
+
|
|
3
25
|
## 223.2.0
|
|
4
26
|
|
|
5
27
|
### Minor Changes
|
|
@@ -3,38 +3,13 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.editorUGCTokensRefreshed = exports.
|
|
6
|
+
exports.editorUGCTokensRefreshed = exports.editorUGCSmallText = void 0;
|
|
7
7
|
var _react = require("@emotion/react");
|
|
8
8
|
/* eslint-disable @atlaskit/ui-styling-standard/use-compiled,
|
|
9
9
|
@repo/internal/deprecations/deprecation-ticket-required,
|
|
10
10
|
@atlaskit/ui-styling-standard/no-exported-styles */
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* Use when the following is not enabled:
|
|
14
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
15
|
-
*/
|
|
16
|
-
/**
|
|
17
|
-
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
18
|
-
* If you need to make changes here, also update the corresponding style in
|
|
19
|
-
* packages/editor/editor-core/src/ui/EditorContentContainer/EditorContentContainer-compiled.tsx
|
|
20
|
-
* See EDITOR-7600 for more details: https://hello.jira.atlassian.cloud/jira/browse/EDITOR-7600
|
|
21
|
-
*/
|
|
22
|
-
// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles, @atlaskit/volt-strict-mode/no-multiple-exports
|
|
23
|
-
var editorUGCTokensModernized = exports.editorUGCTokensModernized = (0, _react.css)({
|
|
24
|
-
'--editor-font-ugc-token-heading-h1': 'normal 600 1.71429em/1.16667 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
25
|
-
'--editor-font-ugc-token-heading-h2': 'normal 600 1.42857em/1.2 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
26
|
-
'--editor-font-ugc-token-heading-h3': 'normal 600 1.14286em/1.25 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
27
|
-
'--editor-font-ugc-token-heading-h4': 'normal 600 1em/1.14286 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
28
|
-
'--editor-font-ugc-token-heading-h5': 'normal 600 0.857143em/1.33333 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
29
|
-
'--editor-font-ugc-token-heading-h6': 'normal 600 0.785714em/1.45455 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
30
|
-
'--editor-font-ugc-token-body': 'normal 400 1em/1.714 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
31
|
-
'--editor-font-ugc-token-weight-heading-bold': '700'
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* Use when the following is enabled:
|
|
36
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
37
|
-
*/
|
|
38
13
|
/**
|
|
39
14
|
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
40
15
|
* If you need to make changes here, also update the corresponding style in
|
|
@@ -127,7 +127,9 @@ function _extensionProviderToQuickInsertProvider() {
|
|
|
127
127
|
return null;
|
|
128
128
|
}
|
|
129
129
|
});
|
|
130
|
-
return _objectSpread(_objectSpread({
|
|
130
|
+
return _objectSpread(_objectSpread(_objectSpread({}, (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_slash_app_category_analytics') && item.app ? {
|
|
131
|
+
app: item.app
|
|
132
|
+
} : {}), {}, {
|
|
131
133
|
// Add module key so typeahead/quick-insert can identify items
|
|
132
134
|
// **locale-agnostically**! nb: we _already_ send key in analytics
|
|
133
135
|
// events, this standardises and makes our items more predictable.
|
|
@@ -6,4 +6,4 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports.version = exports.name = void 0;
|
|
7
7
|
var name = exports.name = "@atlaskit/editor-core";
|
|
8
8
|
// eslint-disable-next-line @atlaskit/volt-strict-mode/no-multiple-exports
|
|
9
|
-
var version = exports.version = "223.
|
|
9
|
+
var version = exports.version = "223.2.0";
|
|
@@ -3,31 +3,6 @@
|
|
|
3
3
|
@atlaskit/ui-styling-standard/no-exported-styles */
|
|
4
4
|
import { css } from '@emotion/react';
|
|
5
5
|
/**
|
|
6
|
-
* Use when the following is not enabled:
|
|
7
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
8
|
-
*/
|
|
9
|
-
/**
|
|
10
|
-
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
11
|
-
* If you need to make changes here, also update the corresponding style in
|
|
12
|
-
* packages/editor/editor-core/src/ui/EditorContentContainer/EditorContentContainer-compiled.tsx
|
|
13
|
-
* See EDITOR-7600 for more details: https://hello.jira.atlassian.cloud/jira/browse/EDITOR-7600
|
|
14
|
-
*/
|
|
15
|
-
// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles, @atlaskit/volt-strict-mode/no-multiple-exports
|
|
16
|
-
export const editorUGCTokensModernized = css({
|
|
17
|
-
'--editor-font-ugc-token-heading-h1': 'normal 600 1.71429em/1.16667 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
18
|
-
'--editor-font-ugc-token-heading-h2': 'normal 600 1.42857em/1.2 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
19
|
-
'--editor-font-ugc-token-heading-h3': 'normal 600 1.14286em/1.25 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
20
|
-
'--editor-font-ugc-token-heading-h4': 'normal 600 1em/1.14286 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
21
|
-
'--editor-font-ugc-token-heading-h5': 'normal 600 0.857143em/1.33333 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
22
|
-
'--editor-font-ugc-token-heading-h6': 'normal 600 0.785714em/1.45455 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
23
|
-
'--editor-font-ugc-token-body': 'normal 400 1em/1.714 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
24
|
-
'--editor-font-ugc-token-weight-heading-bold': '700'
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Use when the following is enabled:
|
|
29
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
30
|
-
*/
|
|
31
6
|
/**
|
|
32
7
|
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
33
8
|
* If you need to make changes here, also update the corresponding style in
|
|
@@ -89,6 +89,9 @@ export async function extensionProviderToQuickInsertProvider(extensionProvider,
|
|
|
89
89
|
loading: () => null
|
|
90
90
|
});
|
|
91
91
|
return {
|
|
92
|
+
...(isExperimentEnabled('platform_editor_slash_app_category_analytics') && item.app ? {
|
|
93
|
+
app: item.app
|
|
94
|
+
} : {}),
|
|
92
95
|
// Add module key so typeahead/quick-insert can identify items
|
|
93
96
|
// **locale-agnostically**! nb: we _already_ send key in analytics
|
|
94
97
|
// events, this standardises and makes our items more predictable.
|
|
@@ -3,31 +3,6 @@
|
|
|
3
3
|
@atlaskit/ui-styling-standard/no-exported-styles */
|
|
4
4
|
import { css } from '@emotion/react';
|
|
5
5
|
/**
|
|
6
|
-
* Use when the following is not enabled:
|
|
7
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
8
|
-
*/
|
|
9
|
-
/**
|
|
10
|
-
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
11
|
-
* If you need to make changes here, also update the corresponding style in
|
|
12
|
-
* packages/editor/editor-core/src/ui/EditorContentContainer/EditorContentContainer-compiled.tsx
|
|
13
|
-
* See EDITOR-7600 for more details: https://hello.jira.atlassian.cloud/jira/browse/EDITOR-7600
|
|
14
|
-
*/
|
|
15
|
-
// eslint-disable-next-line @atlaskit/ui-styling-standard/no-exported-styles, @atlaskit/volt-strict-mode/no-multiple-exports
|
|
16
|
-
export var editorUGCTokensModernized = css({
|
|
17
|
-
'--editor-font-ugc-token-heading-h1': 'normal 600 1.71429em/1.16667 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
18
|
-
'--editor-font-ugc-token-heading-h2': 'normal 600 1.42857em/1.2 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
19
|
-
'--editor-font-ugc-token-heading-h3': 'normal 600 1.14286em/1.25 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
20
|
-
'--editor-font-ugc-token-heading-h4': 'normal 600 1em/1.14286 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
21
|
-
'--editor-font-ugc-token-heading-h5': 'normal 600 0.857143em/1.33333 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
22
|
-
'--editor-font-ugc-token-heading-h6': 'normal 600 0.785714em/1.45455 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
23
|
-
'--editor-font-ugc-token-body': 'normal 400 1em/1.714 ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI", Ubuntu, "Helvetica Neue", sans-serif',
|
|
24
|
-
'--editor-font-ugc-token-weight-heading-bold': '700'
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
/**
|
|
28
|
-
* Use when the following is enabled:
|
|
29
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
30
|
-
*/
|
|
31
6
|
/**
|
|
32
7
|
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
33
8
|
* If you need to make changes here, also update the corresponding style in
|
|
@@ -121,7 +121,9 @@ function _extensionProviderToQuickInsertProvider() {
|
|
|
121
121
|
return null;
|
|
122
122
|
}
|
|
123
123
|
});
|
|
124
|
-
return _objectSpread(_objectSpread({
|
|
124
|
+
return _objectSpread(_objectSpread(_objectSpread({}, isExperimentEnabled('platform_editor_slash_app_category_analytics') && item.app ? {
|
|
125
|
+
app: item.app
|
|
126
|
+
} : {}), {}, {
|
|
125
127
|
// Add module key so typeahead/quick-insert can identify items
|
|
126
128
|
// **locale-agnostically**! nb: we _already_ send key in analytics
|
|
127
129
|
// events, this standardises and makes our items more predictable.
|
|
@@ -1,19 +1,5 @@
|
|
|
1
1
|
import type { SerializedStyles } from '@emotion/react';
|
|
2
2
|
/**
|
|
3
|
-
* Use when the following is not enabled:
|
|
4
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
5
|
-
*/
|
|
6
|
-
/**
|
|
7
|
-
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
8
|
-
* If you need to make changes here, also update the corresponding style in
|
|
9
|
-
* packages/editor/editor-core/src/ui/EditorContentContainer/EditorContentContainer-compiled.tsx
|
|
10
|
-
* See EDITOR-7600 for more details: https://hello.jira.atlassian.cloud/jira/browse/EDITOR-7600
|
|
11
|
-
*/
|
|
12
|
-
export declare const editorUGCTokensModernized: SerializedStyles;
|
|
13
|
-
/**
|
|
14
|
-
* Use when the following is enabled:
|
|
15
|
-
* - fg('atlas_editor_typography_refreshed')
|
|
16
|
-
*/
|
|
17
3
|
/**
|
|
18
4
|
* @deprecated This style has been migrated to Compiled CSS, under experiment platform_editor_core_static_css
|
|
19
5
|
* If you need to make changes here, also update the corresponding style in
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-core",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "224.0.0",
|
|
4
4
|
"description": "A package contains Atlassian editor core functionality",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -47,13 +47,13 @@
|
|
|
47
47
|
"@atlaskit/css": "^1.0.0",
|
|
48
48
|
"@atlaskit/editor-json-transformer": "^9.2.0",
|
|
49
49
|
"@atlaskit/editor-performance-metrics": "^3.2.0",
|
|
50
|
-
"@atlaskit/editor-plugin-connectivity": "^
|
|
51
|
-
"@atlaskit/editor-plugin-quick-insert": "^
|
|
52
|
-
"@atlaskit/editor-plugin-user-preferences": "^
|
|
50
|
+
"@atlaskit/editor-plugin-connectivity": "^15.0.0",
|
|
51
|
+
"@atlaskit/editor-plugin-quick-insert": "^15.0.0",
|
|
52
|
+
"@atlaskit/editor-plugin-user-preferences": "^13.0.0",
|
|
53
53
|
"@atlaskit/editor-plugins": "^15.0.0",
|
|
54
54
|
"@atlaskit/editor-prosemirror": "^8.0.0",
|
|
55
55
|
"@atlaskit/editor-shared-styles": "^4.0.0",
|
|
56
|
-
"@atlaskit/editor-ssr-renderer": "^
|
|
56
|
+
"@atlaskit/editor-ssr-renderer": "^10.0.0",
|
|
57
57
|
"@atlaskit/editor-toolbar": "^2.4.0",
|
|
58
58
|
"@atlaskit/editor-toolbar-model": "^1.2.0",
|
|
59
59
|
"@atlaskit/emoji": "^71.16.0",
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
"uuid": "^3.1.0"
|
|
88
88
|
},
|
|
89
89
|
"peerDependencies": {
|
|
90
|
-
"@atlaskit/editor-common": "^
|
|
90
|
+
"@atlaskit/editor-common": "^119.0.0",
|
|
91
91
|
"@atlaskit/link-provider": "^5.3.0",
|
|
92
92
|
"@atlaskit/media-core": "^38.0.0",
|
|
93
93
|
"react": "^18.2.0",
|
|
@@ -101,11 +101,11 @@
|
|
|
101
101
|
"@atlaskit/adf-utils": "^20.5.0",
|
|
102
102
|
"@atlaskit/analytics-listeners": "^11.1.0",
|
|
103
103
|
"@atlaskit/code": "^19.0.0",
|
|
104
|
-
"@atlaskit/collab-provider": "^
|
|
105
|
-
"@atlaskit/editor-plugin-annotation": "^
|
|
106
|
-
"@atlaskit/editor-plugin-card": "^
|
|
107
|
-
"@atlaskit/editor-plugin-list": "^
|
|
108
|
-
"@atlaskit/editor-plugin-paste": "^
|
|
104
|
+
"@atlaskit/collab-provider": "^24.0.0",
|
|
105
|
+
"@atlaskit/editor-plugin-annotation": "^15.0.0",
|
|
106
|
+
"@atlaskit/editor-plugin-card": "^21.0.0",
|
|
107
|
+
"@atlaskit/editor-plugin-list": "^17.0.0",
|
|
108
|
+
"@atlaskit/editor-plugin-paste": "^16.0.0",
|
|
109
109
|
"@atlaskit/editor-test-helpers": "workspace:^",
|
|
110
110
|
"@atlaskit/link-provider": "^5.3.0",
|
|
111
111
|
"@atlaskit/linking-common": "^11.1.0",
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
"@atlaskit/modal-dialog": "^16.3.0",
|
|
117
117
|
"@atlaskit/popper": "^9.1.0",
|
|
118
118
|
"@atlaskit/portal": "^6.2.0",
|
|
119
|
-
"@atlaskit/renderer": "^
|
|
119
|
+
"@atlaskit/renderer": "^136.0.0",
|
|
120
120
|
"@atlaskit/section-message": "^10.0.0",
|
|
121
121
|
"@atlaskit/synchrony-test-helpers": "workspace:^",
|
|
122
122
|
"@atlaskit/toggle": "^17.1.0",
|
|
@@ -124,11 +124,11 @@
|
|
|
124
124
|
"@atlassian/a11y-jest-testing": "^0.15.0",
|
|
125
125
|
"@atlassian/a11y-playwright-testing": "^0.10.0",
|
|
126
126
|
"@atlassian/adf-schema-json": "^1.34.0",
|
|
127
|
-
"@atlassian/editor-rovo-bridge": "^
|
|
127
|
+
"@atlassian/editor-rovo-bridge": "^13.0.0",
|
|
128
128
|
"@atlassian/experiment-test-utils": "^0.2.0",
|
|
129
129
|
"@atlassian/feature-flags-test-utils": "^1.2.0",
|
|
130
130
|
"@atlassian/search-client": "^2.12.0",
|
|
131
|
-
"@atlassian/search-provider": "^
|
|
131
|
+
"@atlassian/search-provider": "^16.0.0",
|
|
132
132
|
"@atlassian/structured-docs-types": "workspace:^",
|
|
133
133
|
"@atlassian/user-profile-card": "^1.29.0",
|
|
134
134
|
"@emotion/jest": "^11.8.0",
|
|
@@ -263,9 +263,6 @@
|
|
|
263
263
|
"type": "boolean",
|
|
264
264
|
"referenceOnly": true
|
|
265
265
|
},
|
|
266
|
-
"atlas_editor_typography_refreshed": {
|
|
267
|
-
"type": "boolean"
|
|
268
|
-
},
|
|
269
266
|
"platform_editor_controls_increase_full_page_gutter": {
|
|
270
267
|
"type": "boolean"
|
|
271
268
|
},
|
package/editor-core.docs.tsx
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Testing structured MCP docs for review — ignore this file.
|
|
3
|
-
* Contact #dst-structured-content in Slack with questions.
|
|
4
|
-
*/
|
|
5
|
-
|
|
6
|
-
import path from 'path';
|
|
7
|
-
|
|
8
|
-
import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
|
|
9
|
-
|
|
10
|
-
import packageJson from './package.json';
|
|
11
|
-
|
|
12
|
-
const packagePath = path.resolve(__dirname);
|
|
13
|
-
|
|
14
|
-
const documentation: StructuredContentSource = {
|
|
15
|
-
components: [
|
|
16
|
-
{
|
|
17
|
-
name: 'Editor Core',
|
|
18
|
-
description: 'A package contains Atlassian editor core functionality',
|
|
19
|
-
status: 'general-availability',
|
|
20
|
-
import: {
|
|
21
|
-
name: 'ComposableEditor',
|
|
22
|
-
package: '@atlaskit/editor-core/composable-editor',
|
|
23
|
-
type: 'named',
|
|
24
|
-
packagePath,
|
|
25
|
-
packageJson,
|
|
26
|
-
},
|
|
27
|
-
usageGuidelines: [
|
|
28
|
-
'Use the comment appearance when the editor is not the primary focus (e.g. comments on a page); use full-page or full-width when the editor is the main focus; use chromeless when you need complete control over the editor UI; use mobile for mobile web.',
|
|
29
|
-
'Configure features via presets (default, universal, or custom). Always include basePlugin; use usePreset or similar memoization so the preset is stable across re-renders.',
|
|
30
|
-
'Use ComposableEditor with a preset; provide providers (e.g. mentionProvider) when the editor needs context from your app.',
|
|
31
|
-
],
|
|
32
|
-
contentGuidelines: [],
|
|
33
|
-
accessibilityGuidelines: [],
|
|
34
|
-
keywords: ['editor', 'editor-core', 'atlaskit'],
|
|
35
|
-
categories: ['editor'],
|
|
36
|
-
examples: [
|
|
37
|
-
{
|
|
38
|
-
name: 'Basic composable editor',
|
|
39
|
-
description: 'Minimal ComposableEditor with preset.',
|
|
40
|
-
source: path.resolve(packagePath, './examples/1-basic-composable-editor.tsx'),
|
|
41
|
-
},
|
|
42
|
-
{
|
|
43
|
-
name: 'Comment editor',
|
|
44
|
-
description: 'Comment appearance composable editor.',
|
|
45
|
-
source: path.resolve(packagePath, './examples/1-comment-editor-component-composable.tsx'),
|
|
46
|
-
},
|
|
47
|
-
{
|
|
48
|
-
name: 'Full page editor',
|
|
49
|
-
description: 'Full-page appearance composable editor.',
|
|
50
|
-
source: path.resolve(packagePath, './examples/1-full-page-editor-composable.tsx'),
|
|
51
|
-
},
|
|
52
|
-
{
|
|
53
|
-
name: 'Chromeless editor',
|
|
54
|
-
description: 'Chromeless appearance with custom UI.',
|
|
55
|
-
source: path.resolve(
|
|
56
|
-
packagePath,
|
|
57
|
-
'./examples/1-chromeless-editor-component-composable.tsx',
|
|
58
|
-
),
|
|
59
|
-
},
|
|
60
|
-
{
|
|
61
|
-
name: 'Collapsed editor',
|
|
62
|
-
description: 'Async collapsed editor (labs).',
|
|
63
|
-
source: path.resolve(packagePath, './examples/1-labs-async-collapsed-editor.tsx'),
|
|
64
|
-
},
|
|
65
|
-
],
|
|
66
|
-
},
|
|
67
|
-
],
|
|
68
|
-
};
|
|
69
|
-
|
|
70
|
-
export default documentation;
|