@atlaskit/help-article 4.1.2 → 4.1.4

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 CHANGED
@@ -1,5 +1,18 @@
1
1
  # @atlaskit/help-article
2
2
 
3
+ ## 4.1.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`fd6bb9c9184`](https://bitbucket.org/atlassian/atlassian-frontend/commits/fd6bb9c9184) - Delete version.json
8
+ - Updated dependencies
9
+
10
+ ## 4.1.3
11
+
12
+ ### Patch Changes
13
+
14
+ - [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
15
+
3
16
  ## 4.1.2
4
17
 
5
18
  ### Patch Changes
@@ -9,6 +9,6 @@ var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/hel
9
9
  var _styled = _interopRequireDefault(require("@emotion/styled"));
10
10
  var _templateObject;
11
11
  /** @jsx jsx */
12
- // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
12
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage
13
13
  var ArticleFrame = _styled.default.iframe(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n display: block;\n width: calc(100% + 10px);\n margin: -5px;\n border: none;\n"])));
14
14
  exports.ArticleFrame = ArticleFrame;
@@ -1,7 +1,7 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
3
 
4
- // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
4
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage
5
5
  export const ArticleFrame = styled.iframe`
6
6
  display: block;
7
7
  width: calc(100% + 10px);
@@ -3,5 +3,5 @@ var _templateObject;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
5
 
6
- // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
6
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage
7
7
  export var ArticleFrame = styled.iframe(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n display: block;\n width: calc(100% + 10px);\n margin: -5px;\n border: none;\n"])));
@@ -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
+ declare const DEFAULT_CSS: string;
2
+ export default DEFAULT_CSS;
@@ -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
+ import type { HelpArticle as HelpArticleType } from '../model/HelpArticle';
3
+ declare const HelpArticle: (props: HelpArticleType) => JSX.Element;
4
+ export default HelpArticle;
@@ -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,3 @@
1
+ export { default } from './components/HelpArticle';
2
+ export { BODY_FORMAT_TYPES } from './model/HelpArticle';
3
+ export type { HelpArticle, AdfDoc } from './model/HelpArticle';
@@ -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.2",
3
+ "version": "4.1.4",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -33,8 +33,8 @@
33
33
  "dependencies": {
34
34
  "@atlaskit/css-reset": "^6.5.0",
35
35
  "@atlaskit/icon": "^21.12.0",
36
- "@atlaskit/renderer": "^108.0.0",
37
- "@atlaskit/tokens": "^1.4.0",
36
+ "@atlaskit/renderer": "^108.11.0",
37
+ "@atlaskit/tokens": "^1.15.0",
38
38
  "@babel/runtime": "^7.0.0",
39
39
  "@emotion/styled": "^10.0.7",
40
40
  "lodash": "^4.17.21"
@@ -44,8 +44,6 @@
44
44
  "react-dom": "^16.8.0"
45
45
  },
46
46
  "devDependencies": {
47
- "@atlaskit/button": "^16.7.0",
48
- "@atlaskit/docs": "*",
49
47
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
50
48
  "enzyme": "^3.10.0",
51
49
  "react-test-renderer": "^16.8.0",
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/help-article",
3
- "version": "4.1.2",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/help-article",
3
- "version": "4.1.2",
4
- "sideEffects": false
5
- }
@@ -1,5 +0,0 @@
1
- {
2
- "name": "@atlaskit/help-article",
3
- "version": "4.1.2",
4
- "sideEffects": false
5
- }