@atlaskit/editor-core 219.1.10 → 219.1.11
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 +6 -0
- package/editor-core.docs.tsx +46 -0
- package/package.json +4 -3
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,46 @@
|
|
|
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
|
+
|
|
9
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
10
|
+
|
|
11
|
+
import packageJson from './package.json';
|
|
12
|
+
|
|
13
|
+
const packagePath = path.resolve(__dirname);
|
|
14
|
+
|
|
15
|
+
const documentation: ComponentStructuredContentSource[] = [
|
|
16
|
+
{
|
|
17
|
+
name: 'Editor Core',
|
|
18
|
+
description: 'A package contains Atlassian editor core functionality',
|
|
19
|
+
status: 'general-availability',
|
|
20
|
+
import: {
|
|
21
|
+
name: 'Editor Core',
|
|
22
|
+
package: '@atlaskit/editor-core',
|
|
23
|
+
type: 'default',
|
|
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
|
+
{ name: 'Basic composable editor', description: 'Minimal ComposableEditor with preset.', source: path.resolve(packagePath, './examples/1-basic-composable-editor.tsx') },
|
|
38
|
+
{ name: 'Comment editor', description: 'Comment appearance composable editor.', source: path.resolve(packagePath, './examples/1-comment-editor-component-composable.tsx') },
|
|
39
|
+
{ name: 'Full page editor', description: 'Full-page appearance composable editor.', source: path.resolve(packagePath, './examples/1-full-page-editor-composable.tsx') },
|
|
40
|
+
{ name: 'Chromeless editor', description: 'Chromeless appearance with custom UI.', source: path.resolve(packagePath, './examples/1-chromeless-editor-component-composable.tsx') },
|
|
41
|
+
{ name: 'Collapsed editor', description: 'Async collapsed editor (labs).', source: path.resolve(packagePath, './examples/1-labs-async-collapsed-editor.tsx') },
|
|
42
|
+
],
|
|
43
|
+
},
|
|
44
|
+
];
|
|
45
|
+
|
|
46
|
+
export default documentation;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/editor-core",
|
|
3
|
-
"version": "219.1.
|
|
3
|
+
"version": "219.1.11",
|
|
4
4
|
"description": "A package contains Atlassian editor core functionality",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -72,9 +72,9 @@
|
|
|
72
72
|
"@atlaskit/mention": "^25.0.0",
|
|
73
73
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
74
74
|
"@atlaskit/platform-feature-flags-react": "^0.4.0",
|
|
75
|
-
"@atlaskit/react-ufo": "^5.
|
|
75
|
+
"@atlaskit/react-ufo": "^5.17.0",
|
|
76
76
|
"@atlaskit/task-decision": "^20.0.0",
|
|
77
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
77
|
+
"@atlaskit/tmp-editor-statsig": "^73.0.0",
|
|
78
78
|
"@atlaskit/tokens": "^13.0.0",
|
|
79
79
|
"@atlaskit/tooltip": "^21.2.0",
|
|
80
80
|
"@atlaskit/width-detector": "^5.1.0",
|
|
@@ -130,6 +130,7 @@
|
|
|
130
130
|
"@atlassian/react-compiler-gating": "workspace:^",
|
|
131
131
|
"@atlassian/search-client": "^1.5.0",
|
|
132
132
|
"@atlassian/search-provider": "^11.0.0",
|
|
133
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
133
134
|
"@emotion/jest": "^11.8.0",
|
|
134
135
|
"@testing-library/react": "^16.3.0",
|
|
135
136
|
"@types/diff": "^5.0.2",
|