@atlaskit/help-article 6.0.13 → 6.0.15

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
+ ## 6.0.15
4
+
5
+ ### Patch Changes
6
+
7
+ - [`bc7821de4d118`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bc7821de4d118) -
8
+ Sorted type and interface props to improve Atlaskit docs
9
+
10
+ ## 6.0.14
11
+
12
+ ### Patch Changes
13
+
14
+ - Updated dependencies
15
+
3
16
  ## 6.0.13
4
17
 
5
18
  ### Patch Changes
@@ -14,7 +14,13 @@
14
14
  "exclude": [
15
15
  "../src/**/__tests__/*",
16
16
  "../src/**/*.test.*",
17
- "../src/**/test.*"
17
+ "../src/**/test.*",
18
+ "../src/**/examples.*",
19
+ "../src/**/examples/*",
20
+ "../src/**/examples/**/*",
21
+ "../src/**/*.stories.*",
22
+ "../src/**/stories/*",
23
+ "../src/**/stories/**/*"
18
24
  ],
19
25
  "references": [
20
26
  {
@@ -2,7 +2,6 @@
2
2
  * @jsxRuntime classic
3
3
  * @jsx jsx
4
4
  */
5
- /// <reference types="react" />
6
5
  export declare const ArticleFrame: ({ id, name, onLoad, sandbox, }: {
7
6
  id: string;
8
7
  name: string;
@@ -10,7 +10,7 @@ export declare const ArticleContentTitle: ({ children }: {
10
10
  children: React.ReactNode;
11
11
  }) => JSX.Element;
12
12
  export declare const ArticleContentTitleLink: ({ href, target, children, }: {
13
+ children: React.ReactNode;
13
14
  href: string;
14
15
  target: string;
15
- children: React.ReactNode;
16
16
  }) => JSX.Element;
@@ -3,17 +3,17 @@ export declare enum BODY_FORMAT_TYPES {
3
3
  html = "html"
4
4
  }
5
5
  export type AdfDoc = {
6
- type: string;
7
- version: number;
8
6
  content: {
9
7
  [fieldName: string]: any;
10
8
  }[];
9
+ type: string;
10
+ version: number;
11
11
  };
12
12
  export type HelpArticle = {
13
- title?: string;
14
13
  body?: string | AdfDoc;
15
14
  bodyFormat?: BODY_FORMAT_TYPES;
16
- titleLinkUrl?: string;
17
15
  onArticleRenderBegin?(): void;
18
16
  onArticleRenderDone?(): void;
17
+ title?: string;
18
+ titleLinkUrl?: string;
19
19
  };
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  /**
3
2
  * @jsxRuntime classic
4
3
  * @jsx jsx
@@ -10,7 +10,7 @@ export declare const ArticleContentTitle: ({ children }: {
10
10
  children: React.ReactNode;
11
11
  }) => JSX.Element;
12
12
  export declare const ArticleContentTitleLink: ({ href, target, children, }: {
13
+ children: React.ReactNode;
13
14
  href: string;
14
15
  target: string;
15
- children: React.ReactNode;
16
16
  }) => JSX.Element;
@@ -3,17 +3,17 @@ export declare enum BODY_FORMAT_TYPES {
3
3
  html = "html"
4
4
  }
5
5
  export type AdfDoc = {
6
- type: string;
7
- version: number;
8
6
  content: {
9
7
  [fieldName: string]: any;
10
8
  }[];
9
+ type: string;
10
+ version: number;
11
11
  };
12
12
  export type HelpArticle = {
13
- title?: string;
14
13
  body?: string | AdfDoc;
15
14
  bodyFormat?: BODY_FORMAT_TYPES;
16
- titleLinkUrl?: string;
17
15
  onArticleRenderBegin?(): void;
18
16
  onArticleRenderDone?(): void;
17
+ title?: string;
18
+ titleLinkUrl?: string;
19
19
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "6.0.13",
3
+ "version": "6.0.15",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -36,9 +36,9 @@
36
36
  "dependencies": {
37
37
  "@atlaskit/css-reset": "^7.3.0",
38
38
  "@atlaskit/heading": "^5.2.0",
39
- "@atlaskit/icon": "^27.9.0",
39
+ "@atlaskit/icon": "^28.0.0",
40
40
  "@atlaskit/primitives": "^14.11.0",
41
- "@atlaskit/renderer": "^120.3.0",
41
+ "@atlaskit/renderer": "^120.4.0",
42
42
  "@atlaskit/tokens": "^6.0.0",
43
43
  "@babel/runtime": "^7.0.0",
44
44
  "@compiled/react": "^0.18.3",
@@ -50,8 +50,7 @@
50
50
  },
51
51
  "devDependencies": {
52
52
  "enzyme": "^3.10.0",
53
- "react-test-renderer": "^18.2.0",
54
- "typescript": "~5.4.2"
53
+ "react-test-renderer": "^18.2.0"
55
54
  },
56
55
  "keywords": [
57
56
  "atlaskit",