@atlaskit/help-article 4.1.0 → 4.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/help-article
 
+## 4.1.1
+
+### Patch Changes
+
+- [`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.
+
 ## 4.1.0
 
 ### Minor Changes

package/dist/cjs/components/ArticleBody/styled.js

@@ -9,5 +9,6 @@ var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/hel
 var _styled = _interopRequireDefault(require("@emotion/styled"));
 var _templateObject;
 /** @jsx jsx */
+// eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
 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"])));
 exports.ArticleFrame = ArticleFrame;

package/dist/cjs/components/styled.js

@@ -7,12 +7,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.ArticleContentTitleLink = exports.ArticleContentTitle = exports.ArticleContentInner = void 0;
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
 var _styled = _interopRequireDefault(require("@emotion/styled"));
-var _constants = require("@atlaskit/theme/constants");
 var _templateObject, _templateObject2, _templateObject3;
 /** @jsx jsx */
-var ArticleContentInner = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n  padding-bottom: ", "px;\n  position: relative;\n"])), 2 * (0, _constants.gridSize)());
+var ArticleContentInner = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n  padding-bottom: ", ";\n  position: relative;\n"])), "var(--ds-space-200, 16px)");
 exports.ArticleContentInner = ArticleContentInner;
-var ArticleContentTitle = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n  padding-bottom: ", "px;\n"])), 2 * (0, _constants.gridSize)());
+var ArticleContentTitle = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n  padding-bottom: ", ";\n"])), "var(--ds-space-200, 16px)");
 exports.ArticleContentTitle = ArticleContentTitle;
 var ArticleContentTitleLink = _styled.default.a(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n  &:hover {\n    text-decoration: none;\n  }\n"])));
 exports.ArticleContentTitleLink = ArticleContentTitleLink;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/help-article",
-	"version": "4.1.0",
+	"version": "4.1.1",
 	"sideEffects": false
 }

package/dist/es2019/components/ArticleBody/styled.js

@@ -1,5 +1,7 @@
 /** @jsx jsx */
 import styled from '@emotion/styled';
+
+// eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
 export const ArticleFrame = styled.iframe`
   display: block;
   width: calc(100% + 10px);

package/dist/es2019/components/styled.js

@@ -1,12 +1,11 @@
 /** @jsx jsx */
 import styled from '@emotion/styled';
-import { gridSize } from '@atlaskit/theme/constants';
 export const ArticleContentInner = styled.div`
-  padding-bottom: ${2 * gridSize()}px;
+  padding-bottom: ${"var(--ds-space-200, 16px)"};
   position: relative;
 `;
 export const ArticleContentTitle = styled.div`
-  padding-bottom: ${2 * gridSize()}px;
+  padding-bottom: ${"var(--ds-space-200, 16px)"};
 `;
 export const ArticleContentTitleLink = styled.a`
   &:hover {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/help-article",
-	"version": "4.1.0",
+	"version": "4.1.1",
 	"sideEffects": false
 }

package/dist/esm/components/ArticleBody/styled.js

@@ -2,4 +2,6 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
 var _templateObject;
 /** @jsx jsx */
 import styled from '@emotion/styled';
+
+// eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
 export var ArticleFrame = styled.iframe(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  display: block;\n  width: calc(100% + 10px);\n  margin: -5px;\n  border: none;\n"])));

package/dist/esm/components/styled.js

@@ -2,7 +2,6 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
 var _templateObject, _templateObject2, _templateObject3;
 /** @jsx jsx */
 import styled from '@emotion/styled';
-import { gridSize } from '@atlaskit/theme/constants';
-export var ArticleContentInner = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  padding-bottom: ", "px;\n  position: relative;\n"])), 2 * gridSize());
-export var ArticleContentTitle = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n  padding-bottom: ", "px;\n"])), 2 * gridSize());
+export var ArticleContentInner = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n  padding-bottom: ", ";\n  position: relative;\n"])), "var(--ds-space-200, 16px)");
+export var ArticleContentTitle = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n  padding-bottom: ", ";\n"])), "var(--ds-space-200, 16px)");
 export var ArticleContentTitleLink = styled.a(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n  &:hover {\n    text-decoration: none;\n  }\n"])));

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/help-article",
-	"version": "4.1.0",
+	"version": "4.1.1",
 	"sideEffects": false
 }

package/dist/types-ts4.0/components/ArticleBody/index.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { BODY_FORMAT_TYPES } from '../../model/HelpArticle';
+import type { AdfDoc } from '../../model/HelpArticle';
+export interface Props {
+    body?: string | AdfDoc;
+    bodyFormat: BODY_FORMAT_TYPES;
+    onArticleRenderBegin?(): void;
+    onArticleRenderDone?(): void;
+}
+export declare const ArticleBody: (props: Props) => JSX.Element | null;
+export default ArticleBody;

package/dist/types-ts4.0/components/ArticleBody/resetCss.d.ts

@@ -0,0 +1,2 @@
+declare const DEFAULT_CSS: string;
+export default DEFAULT_CSS;

package/dist/types-ts4.0/components/ArticleBody/styled.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+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>;

package/dist/types-ts4.0/components/HelpArticle.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import type { HelpArticle as HelpArticleType } from '../model/HelpArticle';
+declare const HelpArticle: (props: HelpArticleType) => JSX.Element;
+export default HelpArticle;

package/dist/types-ts4.0/components/styled.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+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>;
+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>;
+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>;

package/dist/types-ts4.0/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './components/HelpArticle';
+export { BODY_FORMAT_TYPES } from './model/HelpArticle';
+export type { HelpArticle, AdfDoc } from './model/HelpArticle';

package/dist/types-ts4.0/model/HelpArticle.d.ts

@@ -0,0 +1,19 @@
+export declare enum BODY_FORMAT_TYPES {
+    adf = "adf",
+    html = "html"
+}
+export declare type AdfDoc = {
+    type: string;
+    version: number;
+    content: {
+        [fieldName: string]: any;
+    }[];
+};
+export declare type HelpArticle = {
+    title?: string;
+    body?: string | AdfDoc;
+    bodyFormat?: BODY_FORMAT_TYPES;
+    titleLinkUrl?: string;
+    onArticleRenderBegin?(): void;
+    onArticleRenderDone?(): void;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/help-article",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "A cross-product help-article component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -26,7 +26,7 @@
     "@atlaskit/css-reset": "^6.5.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/renderer": "^108.0.0",
-    "@atlaskit/theme": "^12.5.0",
+    "@atlaskit/tokens": "^1.2.19",
     "@babel/runtime": "^7.0.0",
     "@emotion/styled": "^10.0.7",
     "lodash": "^4.17.21"
@@ -52,7 +52,8 @@
   "techstack": {
     "@repo/internal": {
       "design-tokens": [
-        "color"
+        "color",
+        "spacing"
       ]
     }
   },

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,42 @@
+## API Report File for "@atlaskit/help-article"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+// @public (undocumented)
+export type AdfDoc = {
+    type: string;
+    version: number;
+    content: {
+        [fieldName: string]: any;
+    }[];
+};
+
+// @public (undocumented)
+export enum BODY_FORMAT_TYPES {
+    // (undocumented)
+    adf = "adf",
+    // (undocumented)
+    html = "html"
+}
+
+// @public (undocumented)
+export type HelpArticle = {
+    title?: string;
+    body?: AdfDoc | string;
+    bodyFormat?: BODY_FORMAT_TYPES;
+    titleLinkUrl?: string;
+    onArticleRenderBegin?(): void;
+    onArticleRenderDone?(): void;
+};
+
+// @public (undocumented)
+const HelpArticle_2: (props: HelpArticle) => JSX.Element;
+export default HelpArticle_2;
+
+// (No @packageDocumentation comment for this package)
+
+```