@atlaskit/renderer 130.2.15 → 130.2.17
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 +14 -0
- package/dist/cjs/react/nodes/codeBlock/components/codeBlockCopyButton.js +1 -2
- package/dist/cjs/react/nodes/heading-anchor.js +1 -1
- package/dist/es2019/react/nodes/codeBlock/components/codeBlockCopyButton.js +1 -2
- package/dist/es2019/react/nodes/heading-anchor.js +1 -1
- package/dist/esm/react/nodes/codeBlock/components/codeBlockCopyButton.js +1 -2
- package/dist/esm/react/nodes/heading-anchor.js +1 -1
- package/dist/types/react/nodes/index.d.ts +2 -2
- package/dist/types/ui/annotations/draft/dom.d.ts +1 -1
- package/dist/types/ui/annotations/hooks/use-events.d.ts +1 -1
- package/dist/types-ts4.5/react/nodes/index.d.ts +2 -2
- package/dist/types-ts4.5/ui/annotations/draft/dom.d.ts +1 -1
- package/dist/types-ts4.5/ui/annotations/hooks/use-events.d.ts +1 -1
- package/package.json +6 -5
- package/renderer.docs.tsx +47 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @atlaskit/renderer
|
|
2
2
|
|
|
3
|
+
## 130.2.17
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
|
|
9
|
+
## 130.2.16
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`d94df511393a9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d94df511393a9) -
|
|
14
|
+
Removing FG platform_editor_a11y_eslint_fix
|
|
15
|
+
- Updated dependencies
|
|
16
|
+
|
|
3
17
|
## 130.2.15
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
|
@@ -9,7 +9,6 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
|
|
|
9
9
|
var _customThemeButton = _interopRequireDefault(require("@atlaskit/button/custom-theme-button"));
|
|
10
10
|
var _messages = require("@atlaskit/editor-common/messages");
|
|
11
11
|
var _copy = _interopRequireDefault(require("@atlaskit/icon/core/copy"));
|
|
12
|
-
var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
|
|
13
12
|
var _tooltip = _interopRequireDefault(require("@atlaskit/tooltip"));
|
|
14
13
|
var _react = require("@emotion/react");
|
|
15
14
|
var _react2 = require("react");
|
|
@@ -47,7 +46,7 @@ var CopyButton = function CopyButton(_ref) {
|
|
|
47
46
|
position: "top"
|
|
48
47
|
}, (0, _react.jsx)("div", {
|
|
49
48
|
onMouseLeave: onMouseLeave,
|
|
50
|
-
onBlur:
|
|
49
|
+
onBlur: onMouseLeave
|
|
51
50
|
}, (0, _react.jsx)(_customThemeButton.default, {
|
|
52
51
|
appearance: "subtle",
|
|
53
52
|
"aria-haspopup": true,
|
|
@@ -120,7 +120,7 @@ var HeadingAnchor = /*#__PURE__*/function (_React$PureComponent) {
|
|
|
120
120
|
id: _this.copyLinkId,
|
|
121
121
|
css: copyAnchorButtonStyles,
|
|
122
122
|
onMouseLeave: _this.resetMessage,
|
|
123
|
-
onBlur:
|
|
123
|
+
onBlur: _this.resetMessage,
|
|
124
124
|
onClick: _this.copyToClipboard,
|
|
125
125
|
"aria-hidden": hideFromScreenReader,
|
|
126
126
|
tabIndex: tabIndex,
|
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
import Button from '@atlaskit/button/custom-theme-button';
|
|
6
6
|
import { codeBlockButtonMessages } from '@atlaskit/editor-common/messages';
|
|
7
7
|
import CopyIcon from '@atlaskit/icon/core/copy';
|
|
8
|
-
import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
|
|
9
8
|
import Tooltip from '@atlaskit/tooltip';
|
|
10
9
|
// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
|
|
11
10
|
import { jsx } from '@emotion/react';
|
|
@@ -32,7 +31,7 @@ const CopyButton = ({
|
|
|
32
31
|
position: "top"
|
|
33
32
|
}, jsx("div", {
|
|
34
33
|
onMouseLeave: onMouseLeave,
|
|
35
|
-
onBlur:
|
|
34
|
+
onBlur: onMouseLeave
|
|
36
35
|
}, jsx(Button, {
|
|
37
36
|
appearance: "subtle",
|
|
38
37
|
"aria-haspopup": true,
|
|
@@ -88,7 +88,7 @@ class HeadingAnchor extends React.PureComponent {
|
|
|
88
88
|
id: this.copyLinkId,
|
|
89
89
|
css: copyAnchorButtonStyles,
|
|
90
90
|
onMouseLeave: this.resetMessage,
|
|
91
|
-
onBlur:
|
|
91
|
+
onBlur: this.resetMessage,
|
|
92
92
|
onClick: this.copyToClipboard,
|
|
93
93
|
"aria-hidden": hideFromScreenReader,
|
|
94
94
|
tabIndex: tabIndex,
|
|
@@ -6,7 +6,6 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
|
|
|
6
6
|
import Button from '@atlaskit/button/custom-theme-button';
|
|
7
7
|
import { codeBlockButtonMessages } from '@atlaskit/editor-common/messages';
|
|
8
8
|
import CopyIcon from '@atlaskit/icon/core/copy';
|
|
9
|
-
import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
|
|
10
9
|
import Tooltip from '@atlaskit/tooltip';
|
|
11
10
|
// eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
|
|
12
11
|
import { jsx } from '@emotion/react';
|
|
@@ -38,7 +37,7 @@ var CopyButton = function CopyButton(_ref) {
|
|
|
38
37
|
position: "top"
|
|
39
38
|
}, jsx("div", {
|
|
40
39
|
onMouseLeave: onMouseLeave,
|
|
41
|
-
onBlur:
|
|
40
|
+
onBlur: onMouseLeave
|
|
42
41
|
}, jsx(Button, {
|
|
43
42
|
appearance: "subtle",
|
|
44
43
|
"aria-haspopup": true,
|
|
@@ -114,7 +114,7 @@ var HeadingAnchor = /*#__PURE__*/function (_React$PureComponent) {
|
|
|
114
114
|
id: _this.copyLinkId,
|
|
115
115
|
css: copyAnchorButtonStyles,
|
|
116
116
|
onMouseLeave: _this.resetMessage,
|
|
117
|
-
onBlur:
|
|
117
|
+
onBlur: _this.resetMessage,
|
|
118
118
|
onClick: _this.copyToClipboard,
|
|
119
119
|
"aria-hidden": hideFromScreenReader,
|
|
120
120
|
tabIndex: tabIndex,
|
|
@@ -65,7 +65,7 @@ declare const EmbedCard: React.ComponentType<{
|
|
|
65
65
|
isInsideOfBlockNode?: boolean;
|
|
66
66
|
isInsideOfInlineExtension?: boolean;
|
|
67
67
|
layout: RichMediaLayout;
|
|
68
|
-
onSetLinkTarget?: (url: string) =>
|
|
68
|
+
onSetLinkTarget?: (url: string) => '_blank' | undefined;
|
|
69
69
|
originalHeight?: number;
|
|
70
70
|
originalWidth?: number;
|
|
71
71
|
portal?: HTMLElement;
|
|
@@ -82,7 +82,7 @@ declare const BlockCard: React.ComponentType<{
|
|
|
82
82
|
isNodeNested?: boolean;
|
|
83
83
|
layout?: string;
|
|
84
84
|
localId?: string;
|
|
85
|
-
onSetLinkTarget?: (url: string) =>
|
|
85
|
+
onSetLinkTarget?: (url: string) => '_blank' | undefined;
|
|
86
86
|
portal?: HTMLElement;
|
|
87
87
|
rendererAppearance?: RendererAppearance;
|
|
88
88
|
smartLinks?: SmartLinksOptions;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Position } from '../types';
|
|
2
|
-
export declare const dataAttributes: ({ from, to }: Position) => {
|
|
2
|
+
export declare const dataAttributes: ({ from, to, }: Position) => {
|
|
3
3
|
"data-annotation-draft-mark": boolean;
|
|
4
4
|
"data-draft-end-at": number;
|
|
5
5
|
"data-draft-start-at": number;
|
|
@@ -13,7 +13,7 @@ type UseAnnotationUpdateSatteByEventProps = {
|
|
|
13
13
|
updateSubscriber: AnnotationUpdateEmitter | null;
|
|
14
14
|
};
|
|
15
15
|
export declare const useAnnotationStateByTypeEvent: ({ type, updateSubscriber, }: UseAnnotationUpdateSatteByEventProps) => Record<string, AnnotationMarkStates | null>;
|
|
16
|
-
export declare const useHasFocusEvent: ({ id, updateSubscriber }: ListenEventProps) => {
|
|
16
|
+
export declare const useHasFocusEvent: ({ id, updateSubscriber, }: ListenEventProps) => {
|
|
17
17
|
hasFocus: boolean;
|
|
18
18
|
isHovered: boolean;
|
|
19
19
|
};
|
|
@@ -65,7 +65,7 @@ declare const EmbedCard: React.ComponentType<{
|
|
|
65
65
|
isInsideOfBlockNode?: boolean;
|
|
66
66
|
isInsideOfInlineExtension?: boolean;
|
|
67
67
|
layout: RichMediaLayout;
|
|
68
|
-
onSetLinkTarget?: (url: string) =>
|
|
68
|
+
onSetLinkTarget?: (url: string) => '_blank' | undefined;
|
|
69
69
|
originalHeight?: number;
|
|
70
70
|
originalWidth?: number;
|
|
71
71
|
portal?: HTMLElement;
|
|
@@ -82,7 +82,7 @@ declare const BlockCard: React.ComponentType<{
|
|
|
82
82
|
isNodeNested?: boolean;
|
|
83
83
|
layout?: string;
|
|
84
84
|
localId?: string;
|
|
85
|
-
onSetLinkTarget?: (url: string) =>
|
|
85
|
+
onSetLinkTarget?: (url: string) => '_blank' | undefined;
|
|
86
86
|
portal?: HTMLElement;
|
|
87
87
|
rendererAppearance?: RendererAppearance;
|
|
88
88
|
smartLinks?: SmartLinksOptions;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Position } from '../types';
|
|
2
|
-
export declare const dataAttributes: ({ from, to }: Position) => {
|
|
2
|
+
export declare const dataAttributes: ({ from, to, }: Position) => {
|
|
3
3
|
"data-annotation-draft-mark": boolean;
|
|
4
4
|
"data-draft-end-at": number;
|
|
5
5
|
"data-draft-start-at": number;
|
|
@@ -13,7 +13,7 @@ type UseAnnotationUpdateSatteByEventProps = {
|
|
|
13
13
|
updateSubscriber: AnnotationUpdateEmitter | null;
|
|
14
14
|
};
|
|
15
15
|
export declare const useAnnotationStateByTypeEvent: ({ type, updateSubscriber, }: UseAnnotationUpdateSatteByEventProps) => Record<string, AnnotationMarkStates | null>;
|
|
16
|
-
export declare const useHasFocusEvent: ({ id, updateSubscriber }: ListenEventProps) => {
|
|
16
|
+
export declare const useHasFocusEvent: ({ id, updateSubscriber, }: ListenEventProps) => {
|
|
17
17
|
hasFocus: boolean;
|
|
18
18
|
isHovered: boolean;
|
|
19
19
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/renderer",
|
|
3
|
-
"version": "130.2.
|
|
3
|
+
"version": "130.2.17",
|
|
4
4
|
"description": "Renderer component",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -61,12 +61,12 @@
|
|
|
61
61
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
62
62
|
"@atlaskit/platform-feature-flags-react": "^0.4.0",
|
|
63
63
|
"@atlaskit/pragmatic-drag-and-drop": "^1.8.0",
|
|
64
|
-
"@atlaskit/react-ufo": "^5.
|
|
64
|
+
"@atlaskit/react-ufo": "^5.17.0",
|
|
65
65
|
"@atlaskit/smart-card": "^44.3.0",
|
|
66
66
|
"@atlaskit/status": "^4.0.0",
|
|
67
67
|
"@atlaskit/task-decision": "^20.0.0",
|
|
68
68
|
"@atlaskit/theme": "^23.2.0",
|
|
69
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
69
|
+
"@atlaskit/tmp-editor-statsig": "^73.0.0",
|
|
70
70
|
"@atlaskit/tokens": "^13.0.0",
|
|
71
71
|
"@atlaskit/tooltip": "^21.2.0",
|
|
72
72
|
"@atlaskit/visually-hidden": "^3.0.0",
|
|
@@ -79,7 +79,7 @@
|
|
|
79
79
|
"uuid": "^3.1.0"
|
|
80
80
|
},
|
|
81
81
|
"peerDependencies": {
|
|
82
|
-
"@atlaskit/editor-common": "^114.
|
|
82
|
+
"@atlaskit/editor-common": "^114.13.0",
|
|
83
83
|
"@atlaskit/link-provider": "^4.3.0",
|
|
84
84
|
"@atlaskit/media-core": "^37.0.0",
|
|
85
85
|
"react": "^18.2.0",
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
"@atlaskit/media-test-helpers": "^41.0.0",
|
|
99
99
|
"@atlaskit/mention": "^25.0.0",
|
|
100
100
|
"@atlaskit/modal-dialog": "^14.18.0",
|
|
101
|
-
"@atlaskit/navigation-system": "^
|
|
101
|
+
"@atlaskit/navigation-system": "^9.0.0",
|
|
102
102
|
"@atlaskit/profilecard": "^25.1.0",
|
|
103
103
|
"@atlaskit/side-nav-items": "^1.13.0",
|
|
104
104
|
"@atlaskit/util-data-test": "^18.5.0",
|
|
@@ -106,6 +106,7 @@
|
|
|
106
106
|
"@atlassian/a11y-playwright-testing": "^0.9.0",
|
|
107
107
|
"@atlassian/feature-flags-test-utils": "^1.0.0",
|
|
108
108
|
"@atlassian/react-compiler-gating": "workspace:^",
|
|
109
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
109
110
|
"@atlassian/testing-library": "^0.5.0",
|
|
110
111
|
"@testing-library/react": "^16.3.0",
|
|
111
112
|
"@testing-library/user-event": "^14.4.3",
|
|
@@ -0,0 +1,47 @@
|
|
|
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: 'Renderer',
|
|
18
|
+
description: 'Renderer component',
|
|
19
|
+
status: 'general-availability',
|
|
20
|
+
import: {
|
|
21
|
+
name: 'Renderer',
|
|
22
|
+
package: '@atlaskit/renderer',
|
|
23
|
+
type: 'default',
|
|
24
|
+
packagePath,
|
|
25
|
+
packageJson,
|
|
26
|
+
},
|
|
27
|
+
usageGuidelines: [
|
|
28
|
+
'Use ReactRenderer with an ADF document; use a transformer (e.g. BitbucketTransformer) with ADFEncoder when your storage format is not ADF.',
|
|
29
|
+
'Avoid unnecessary props changes: extract static objects to constants, avoid passing new objects or anonymous functions on every render, use useMemo/useCallback for props and callbacks to prevent performance degradation.',
|
|
30
|
+
'Ensure only one version of Renderer sub-dependencies (adf-schema, editor-common, prosemirror-model, etc.) in your bundles; use deduplication or resolutions. Use correct peer dependency versions.',
|
|
31
|
+
'Use the truncated prop with maxHeight/fadeOutHeight when you need to cap rendered content with a fade; add polyfills for fetch and ES6/ES7 when targeting older browsers.',
|
|
32
|
+
],
|
|
33
|
+
contentGuidelines: [],
|
|
34
|
+
accessibilityGuidelines: [],
|
|
35
|
+
keywords: ['editor', 'renderer', 'atlaskit'],
|
|
36
|
+
categories: ['editor'],
|
|
37
|
+
examples: [
|
|
38
|
+
{ name: 'Basic', description: 'Basic ReactRenderer with ADF document.', source: path.resolve(packagePath, './examples/0-basic.tsx') },
|
|
39
|
+
{ name: 'Full page', description: 'Full-page renderer with full ADF.', source: path.resolve(packagePath, './examples/0-full-page.tsx') },
|
|
40
|
+
{ name: 'With providers', description: 'Renderer with media and other providers.', source: path.resolve(packagePath, './examples/1-with-providers.tsx') },
|
|
41
|
+
{ name: 'Full page with media caption', description: 'Renderer with media and captions.', source: path.resolve(packagePath, './examples/0-full-page-with-media-caption.tsx') },
|
|
42
|
+
{ name: 'Column layout', description: 'Renderer with column layout.', source: path.resolve(packagePath, './examples/10-column-layout.tsx') },
|
|
43
|
+
],
|
|
44
|
+
},
|
|
45
|
+
];
|
|
46
|
+
|
|
47
|
+
export default documentation;
|