@atlaskit/help-article 4.0.38 → 4.1.1

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,21 @@
1
1
  # @atlaskit/help-article
2
2
 
3
+ ## 4.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - [`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.
8
+
9
+ ## 4.1.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [`56507598609`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56507598609) - Skip minor dependency bump
14
+
15
+ ### Patch Changes
16
+
17
+ - Updated dependencies
18
+
3
19
  ## 4.0.38
4
20
 
5
21
  ### Patch 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;
@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.BODY_FORMAT_TYPES = void 0;
7
- var BODY_FORMAT_TYPES;
8
- exports.BODY_FORMAT_TYPES = BODY_FORMAT_TYPES;
9
- (function (BODY_FORMAT_TYPES) {
7
+ var BODY_FORMAT_TYPES = /*#__PURE__*/function (BODY_FORMAT_TYPES) {
10
8
  BODY_FORMAT_TYPES["adf"] = "adf";
11
9
  BODY_FORMAT_TYPES["html"] = "html";
12
- })(BODY_FORMAT_TYPES || (exports.BODY_FORMAT_TYPES = BODY_FORMAT_TYPES = {}));
10
+ return BODY_FORMAT_TYPES;
11
+ }({});
12
+ exports.BODY_FORMAT_TYPES = BODY_FORMAT_TYPES;
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.38",
3
+ "version": "4.1.1",
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
- export let BODY_FORMAT_TYPES;
2
- (function (BODY_FORMAT_TYPES) {
1
+ export let BODY_FORMAT_TYPES = /*#__PURE__*/function (BODY_FORMAT_TYPES) {
3
2
  BODY_FORMAT_TYPES["adf"] = "adf";
4
3
  BODY_FORMAT_TYPES["html"] = "html";
5
- })(BODY_FORMAT_TYPES || (BODY_FORMAT_TYPES = {}));
4
+ return BODY_FORMAT_TYPES;
5
+ }({});
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.38",
3
+ "version": "4.1.1",
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
- export var BODY_FORMAT_TYPES;
2
- (function (BODY_FORMAT_TYPES) {
1
+ export var BODY_FORMAT_TYPES = /*#__PURE__*/function (BODY_FORMAT_TYPES) {
3
2
  BODY_FORMAT_TYPES["adf"] = "adf";
4
3
  BODY_FORMAT_TYPES["html"] = "html";
5
- })(BODY_FORMAT_TYPES || (BODY_FORMAT_TYPES = {}));
4
+ return BODY_FORMAT_TYPES;
5
+ }({});
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-article",
3
- "version": "4.0.38",
3
+ "version": "4.1.1",
4
4
  "sideEffects": false
5
5
  }
@@ -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 declare type AdfDoc = {
6
+ type: string;
7
+ version: number;
8
+ content: {
9
+ [fieldName: string]: any;
10
+ }[];
11
+ };
12
+ export declare 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.0.38",
3
+ "version": "4.1.1",
4
4
  "description": "A cross-product help-article component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -23,10 +23,10 @@
23
23
  }
24
24
  },
25
25
  "dependencies": {
26
- "@atlaskit/css-reset": "^6.3.0",
27
- "@atlaskit/icon": "^21.11.0",
28
- "@atlaskit/renderer": "^107.3.0",
29
- "@atlaskit/theme": "^12.4.0",
26
+ "@atlaskit/css-reset": "^6.5.0",
27
+ "@atlaskit/icon": "^21.12.0",
28
+ "@atlaskit/renderer": "^108.0.0",
29
+ "@atlaskit/tokens": "^1.2.19",
30
30
  "@babel/runtime": "^7.0.0",
31
31
  "@emotion/styled": "^10.0.7",
32
32
  "lodash": "^4.17.21"
@@ -36,7 +36,7 @@
36
36
  "react-dom": "^16.8.0"
37
37
  },
38
38
  "devDependencies": {
39
- "@atlaskit/button": "^16.6.0",
39
+ "@atlaskit/button": "^16.7.0",
40
40
  "@atlaskit/docs": "*",
41
41
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
42
42
  "enzyme": "^3.10.0",
@@ -52,7 +52,8 @@
52
52
  "techstack": {
53
53
  "@repo/internal": {
54
54
  "design-tokens": [
55
- "color"
55
+ "color",
56
+ "spacing"
56
57
  ]
57
58
  }
58
59
  },