@atlaskit/help-article 4.1.2 → 4.1.3
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/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/dist/types-ts4.5/components/ArticleBody/index.d.ts +11 -0
- package/dist/types-ts4.5/components/ArticleBody/resetCss.d.ts +2 -0
- package/dist/types-ts4.5/components/ArticleBody/styled.d.ts +2 -0
- package/dist/types-ts4.5/components/HelpArticle.d.ts +4 -0
- package/dist/types-ts4.5/components/styled.d.ts +4 -0
- package/dist/types-ts4.5/index.d.ts +3 -0
- package/dist/types-ts4.5/model/HelpArticle.d.ts +19 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { BODY_FORMAT_TYPES } from '../../model/HelpArticle';
|
|
3
|
+
import type { AdfDoc } from '../../model/HelpArticle';
|
|
4
|
+
export interface Props {
|
|
5
|
+
body?: string | AdfDoc;
|
|
6
|
+
bodyFormat: BODY_FORMAT_TYPES;
|
|
7
|
+
onArticleRenderBegin?(): void;
|
|
8
|
+
onArticleRenderDone?(): void;
|
|
9
|
+
}
|
|
10
|
+
export declare const ArticleBody: (props: Props) => JSX.Element | null;
|
|
11
|
+
export default ArticleBody;
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
export declare const ArticleFrame: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").IframeHTMLAttributes<HTMLIFrameElement>, HTMLIFrameElement>, Pick<import("react").ClassAttributes<HTMLIFrameElement> & import("react").IframeHTMLAttributes<HTMLIFrameElement>, keyof import("react").IframeHTMLAttributes<HTMLIFrameElement>>, object>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
export declare const ArticleContentInner: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
|
|
3
|
+
export declare const ArticleContentTitle: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
|
|
4
|
+
export declare const ArticleContentTitleLink: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, Pick<import("react").ClassAttributes<HTMLAnchorElement> & import("react").AnchorHTMLAttributes<HTMLAnchorElement>, keyof import("react").AnchorHTMLAttributes<HTMLAnchorElement>>, object>;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export declare enum BODY_FORMAT_TYPES {
|
|
2
|
+
adf = "adf",
|
|
3
|
+
html = "html"
|
|
4
|
+
}
|
|
5
|
+
export type AdfDoc = {
|
|
6
|
+
type: string;
|
|
7
|
+
version: number;
|
|
8
|
+
content: {
|
|
9
|
+
[fieldName: string]: any;
|
|
10
|
+
}[];
|
|
11
|
+
};
|
|
12
|
+
export type HelpArticle = {
|
|
13
|
+
title?: string;
|
|
14
|
+
body?: string | AdfDoc;
|
|
15
|
+
bodyFormat?: BODY_FORMAT_TYPES;
|
|
16
|
+
titleLinkUrl?: string;
|
|
17
|
+
onArticleRenderBegin?(): void;
|
|
18
|
+
onArticleRenderDone?(): void;
|
|
19
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/help-article",
|
|
3
|
-
"version": "4.1.
|
|
3
|
+
"version": "4.1.3",
|
|
4
4
|
"description": "A cross-product help-article component",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@atlaskit/css-reset": "^6.5.0",
|
|
35
35
|
"@atlaskit/icon": "^21.12.0",
|
|
36
|
-
"@atlaskit/renderer": "^108.
|
|
36
|
+
"@atlaskit/renderer": "^108.1.0",
|
|
37
37
|
"@atlaskit/tokens": "^1.4.0",
|
|
38
38
|
"@babel/runtime": "^7.0.0",
|
|
39
39
|
"@emotion/styled": "^10.0.7",
|