@atlaskit/help-article 4.1.0 → 4.1.2

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,17 @@
1
1
  # @atlaskit/help-article
2
2
 
3
+ ## 4.1.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
8
+
9
+ ## 4.1.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [`7e051bad115`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7e051bad115) - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change.
14
+
3
15
  ## 4.1.0
4
16
 
5
17
  ### Minor Changes
@@ -9,5 +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
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"])));
13
14
  exports.ArticleFrame = ArticleFrame;
@@ -7,12 +7,11 @@ Object.defineProperty(exports, "__esModule", {
7
7
  exports.ArticleContentTitleLink = exports.ArticleContentTitle = exports.ArticleContentInner = void 0;
8
8
  var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
9
9
  var _styled = _interopRequireDefault(require("@emotion/styled"));
10
- var _constants = require("@atlaskit/theme/constants");
11
10
  var _templateObject, _templateObject2, _templateObject3;
12
11
  /** @jsx jsx */
13
- var ArticleContentInner = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding-bottom: ", "px;\n position: relative;\n"])), 2 * (0, _constants.gridSize)());
12
+ var ArticleContentInner = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding-bottom: ", ";\n position: relative;\n"])), "var(--ds-space-200, 16px)");
14
13
  exports.ArticleContentInner = ArticleContentInner;
15
- var ArticleContentTitle = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding-bottom: ", "px;\n"])), 2 * (0, _constants.gridSize)());
14
+ var ArticleContentTitle = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding-bottom: ", ";\n"])), "var(--ds-space-200, 16px)");
16
15
  exports.ArticleContentTitle = ArticleContentTitle;
17
16
  var ArticleContentTitleLink = _styled.default.a(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n &:hover {\n text-decoration: none;\n }\n"])));
18
17
  exports.ArticleContentTitleLink = ArticleContentTitleLink;
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.1.0",
3
+ "version": "4.1.2",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,7 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
+
4
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
3
5
  export const ArticleFrame = styled.iframe`
4
6
  display: block;
5
7
  width: calc(100% + 10px);
@@ -1,12 +1,11 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
- import { gridSize } from '@atlaskit/theme/constants';
4
3
  export const ArticleContentInner = styled.div`
5
- padding-bottom: ${2 * gridSize()}px;
4
+ padding-bottom: ${"var(--ds-space-200, 16px)"};
6
5
  position: relative;
7
6
  `;
8
7
  export const ArticleContentTitle = styled.div`
9
- padding-bottom: ${2 * gridSize()}px;
8
+ padding-bottom: ${"var(--ds-space-200, 16px)"};
10
9
  `;
11
10
  export const ArticleContentTitleLink = styled.a`
12
11
  &:hover {
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.1.0",
3
+ "version": "4.1.2",
4
4
  "sideEffects": false
5
5
  }
@@ -2,4 +2,6 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
2
2
  var _templateObject;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
+
6
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
5
7
  export var ArticleFrame = styled.iframe(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n display: block;\n width: calc(100% + 10px);\n margin: -5px;\n border: none;\n"])));
@@ -2,7 +2,6 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
2
2
  var _templateObject, _templateObject2, _templateObject3;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
- import { gridSize } from '@atlaskit/theme/constants';
6
- export var ArticleContentInner = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding-bottom: ", "px;\n position: relative;\n"])), 2 * gridSize());
7
- export var ArticleContentTitle = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding-bottom: ", "px;\n"])), 2 * gridSize());
5
+ export var ArticleContentInner = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding-bottom: ", ";\n position: relative;\n"])), "var(--ds-space-200, 16px)");
6
+ export var ArticleContentTitle = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding-bottom: ", ";\n"])), "var(--ds-space-200, 16px)");
8
7
  export var ArticleContentTitleLink = styled.a(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n &:hover {\n text-decoration: none;\n }\n"])));
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.1.0",
3
+ "version": "4.1.2",
4
4
  "sideEffects": false
5
5
  }
@@ -2,14 +2,14 @@ export declare enum BODY_FORMAT_TYPES {
2
2
  adf = "adf",
3
3
  html = "html"
4
4
  }
5
- export declare type AdfDoc = {
5
+ export type AdfDoc = {
6
6
  type: string;
7
7
  version: number;
8
8
  content: {
9
9
  [fieldName: string]: any;
10
10
  }[];
11
11
  };
12
- export declare type HelpArticle = {
12
+ export type HelpArticle = {
13
13
  title?: string;
14
14
  body?: string | AdfDoc;
15
15
  bodyFormat?: BODY_FORMAT_TYPES;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.1.0",
3
+ "version": "4.1.2",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,14 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
+ "typesVersions": {
16
+ ">=4.5 <4.9": {
17
+ "*": [
18
+ "dist/types-ts4.5/*",
19
+ "dist/types-ts4.5/index.d.ts"
20
+ ]
21
+ }
22
+ },
15
23
  "sideEffects": false,
16
24
  "atlaskit:src": "src/index.ts",
17
25
  "atlassian": {
@@ -26,7 +34,7 @@
26
34
  "@atlaskit/css-reset": "^6.5.0",
27
35
  "@atlaskit/icon": "^21.12.0",
28
36
  "@atlaskit/renderer": "^108.0.0",
29
- "@atlaskit/theme": "^12.5.0",
37
+ "@atlaskit/tokens": "^1.4.0",
30
38
  "@babel/runtime": "^7.0.0",
31
39
  "@emotion/styled": "^10.0.7",
32
40
  "lodash": "^4.17.21"
@@ -41,7 +49,7 @@
41
49
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
42
50
  "enzyme": "^3.10.0",
43
51
  "react-test-renderer": "^16.8.0",
44
- "typescript": "4.5.5"
52
+ "typescript": "~4.9.5"
45
53
  },
46
54
  "keywords": [
47
55
  "atlaskit",
@@ -52,7 +60,8 @@
52
60
  "techstack": {
53
61
  "@repo/internal": {
54
62
  "design-tokens": [
55
- "color"
63
+ "color",
64
+ "spacing"
56
65
  ]
57
66
  }
58
67
  },
@@ -0,0 +1,42 @@
1
+ ## API Report File for "@atlaskit/help-article"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ /// <reference types="react" />
8
+
9
+ // @public (undocumented)
10
+ export type AdfDoc = {
11
+ type: string;
12
+ version: number;
13
+ content: {
14
+ [fieldName: string]: any;
15
+ }[];
16
+ };
17
+
18
+ // @public (undocumented)
19
+ export enum BODY_FORMAT_TYPES {
20
+ // (undocumented)
21
+ adf = "adf",
22
+ // (undocumented)
23
+ html = "html"
24
+ }
25
+
26
+ // @public (undocumented)
27
+ export type HelpArticle = {
28
+ title?: string;
29
+ body?: AdfDoc | string;
30
+ bodyFormat?: BODY_FORMAT_TYPES;
31
+ titleLinkUrl?: string;
32
+ onArticleRenderBegin?(): void;
33
+ onArticleRenderDone?(): void;
34
+ };
35
+
36
+ // @public (undocumented)
37
+ const HelpArticle_2: (props: HelpArticle) => JSX.Element;
38
+ export default HelpArticle_2;
39
+
40
+ // (No @packageDocumentation comment for this package)
41
+
42
+ ```