@atlaskit/empty-state 7.5.1 → 7.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/empty-state
 
+## 7.6.0
+
+### Minor Changes
+
+- [`56d11ec914b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56d11ec914b) - Add a new prop `headingLevel` to set the heading level in the header element.
+
+## 7.5.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 7.5.1
 
 ### Patch Changes

package/dist/cjs/empty-state.js

@@ -34,6 +34,8 @@ var _styled = require("./styled");
 var EmptyState = function EmptyState(_ref) {
   var description = _ref.description,
     header = _ref.header,
+    _ref$headingLevel = _ref.headingLevel,
+    headingLevel = _ref$headingLevel === void 0 ? 4 : _ref$headingLevel,
     imageHeight = _ref.imageHeight,
     imageUrl = _ref.imageUrl,
     imageWidth = _ref.imageWidth,
@@ -66,7 +68,9 @@ var EmptyState = function EmptyState(_ref) {
     maxImageHeight: maxImageHeight,
     imageWidth: imageWidth,
     imageHeight: imageHeight
-  }), /*#__PURE__*/_react.default.createElement(_styled.Header, null, header), description && /*#__PURE__*/_react.default.createElement(_styled.Description, null, description), actionsContainer, tertiaryAction);
+  }), /*#__PURE__*/_react.default.createElement(_styled.Header, {
+    level: headingLevel
+  }, header), description && /*#__PURE__*/_react.default.createElement(_styled.Description, null, description), actionsContainer, tertiaryAction);
 };
 var _default = EmptyState;
 exports.default = _default;

package/dist/cjs/styled/header.js

@@ -8,7 +8,7 @@ var _react = require("@emotion/react");
 var _typography = require("@atlaskit/theme/typography");
 /** @jsx jsx */
 
-// eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
+// eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
 var headerStyles = (0, _react.css)([(0, _typography.h600)(), {
   marginTop: "var(--ds-space-0, 0px)",
   marginBottom: "var(--ds-space-200, 16px)"
@@ -22,8 +22,11 @@ var headerStyles = (0, _react.css)([(0, _typography.h600)(), {
  * @internal
  */
 var EmptyStateHeader = function EmptyStateHeader(_ref) {
-  var children = _ref.children;
-  return (0, _react.jsx)("h4", {
+  var children = _ref.children,
+    _ref$level = _ref.level,
+    level = _ref$level === void 0 ? 4 : _ref$level;
+  var Tag = "h".concat(level > 0 && level < 7 ? level : level > 6 ? 6 : 4);
+  return (0, _react.jsx)(Tag, {
     css: headerStyles
   }, children);
 };

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/empty-state",
-	"version": "7.5.1",
+	"version": "7.6.0",
 	"sideEffects": false
 }

package/dist/es2019/empty-state.js

@@ -27,6 +27,7 @@ import { ActionsContainer, Container, Description, Header, Image, SpinnerContain
 const EmptyState = ({
   description,
   header,
+  headingLevel = 4,
   imageHeight,
   imageUrl,
   imageWidth,
@@ -58,6 +59,8 @@ const EmptyState = ({
     maxImageHeight,
     imageWidth,
     imageHeight
-  }), /*#__PURE__*/React.createElement(Header, null, header), description && /*#__PURE__*/React.createElement(Description, null, description), actionsContainer, tertiaryAction);
+  }), /*#__PURE__*/React.createElement(Header, {
+    level: headingLevel
+  }, header), description && /*#__PURE__*/React.createElement(Description, null, description), actionsContainer, tertiaryAction);
 };
 export default EmptyState;

package/dist/es2019/styled/header.js

@@ -2,7 +2,7 @@
 
 import { css, jsx } from '@emotion/react';
 import { h600 } from '@atlaskit/theme/typography';
-// eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
+// eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
 const headerStyles = css([h600(), {
   marginTop: "var(--ds-space-0, 0px)",
   marginBottom: "var(--ds-space-200, 16px)"
@@ -16,8 +16,12 @@ const headerStyles = css([h600(), {
  * @internal
  */
 const EmptyStateHeader = ({
-  children
-}) => jsx("h4", {
-  css: headerStyles
-}, children);
+  children,
+  level = 4
+}) => {
+  const Tag = `h${level > 0 && level < 7 ? level : level > 6 ? 6 : 4}`;
+  return jsx(Tag, {
+    css: headerStyles
+  }, children);
+};
 export default EmptyStateHeader;

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/empty-state",
-	"version": "7.5.1",
+	"version": "7.6.0",
 	"sideEffects": false
 }

package/dist/esm/empty-state.js

@@ -27,6 +27,8 @@ import { ActionsContainer, Container, Description, Header, Image, SpinnerContain
 var EmptyState = function EmptyState(_ref) {
   var description = _ref.description,
     header = _ref.header,
+    _ref$headingLevel = _ref.headingLevel,
+    headingLevel = _ref$headingLevel === void 0 ? 4 : _ref$headingLevel,
     imageHeight = _ref.imageHeight,
     imageUrl = _ref.imageUrl,
     imageWidth = _ref.imageWidth,
@@ -59,6 +61,8 @@ var EmptyState = function EmptyState(_ref) {
     maxImageHeight: maxImageHeight,
     imageWidth: imageWidth,
     imageHeight: imageHeight
-  }), /*#__PURE__*/React.createElement(Header, null, header), description && /*#__PURE__*/React.createElement(Description, null, description), actionsContainer, tertiaryAction);
+  }), /*#__PURE__*/React.createElement(Header, {
+    level: headingLevel
+  }, header), description && /*#__PURE__*/React.createElement(Description, null, description), actionsContainer, tertiaryAction);
 };
 export default EmptyState;

package/dist/esm/styled/header.js

@@ -2,7 +2,7 @@
 
 import { css, jsx } from '@emotion/react';
 import { h600 } from '@atlaskit/theme/typography';
-// eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
+// eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
 var headerStyles = css([h600(), {
   marginTop: "var(--ds-space-0, 0px)",
   marginBottom: "var(--ds-space-200, 16px)"
@@ -16,8 +16,11 @@ var headerStyles = css([h600(), {
  * @internal
  */
 var EmptyStateHeader = function EmptyStateHeader(_ref) {
-  var children = _ref.children;
-  return jsx("h4", {
+  var children = _ref.children,
+    _ref$level = _ref.level,
+    level = _ref$level === void 0 ? 4 : _ref$level;
+  var Tag = "h".concat(level > 0 && level < 7 ? level : level > 6 ? 6 : 4);
+  return jsx(Tag, {
     css: headerStyles
   }, children);
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/empty-state",
-	"version": "7.5.1",
+	"version": "7.6.0",
 	"sideEffects": false
 }

package/dist/types/empty-state.d.ts

@@ -22,5 +22,5 @@ import type { EmptyStateProps } from './types';
  * };
  * ```
  */
-declare const EmptyState: ({ description, header, imageHeight, imageUrl, imageWidth, isLoading, maxImageHeight, maxImageWidth, primaryAction, renderImage, secondaryAction, width, size, tertiaryAction, testId, }: EmptyStateProps) => JSX.Element;
+declare const EmptyState: ({ description, header, headingLevel, imageHeight, imageUrl, imageWidth, isLoading, maxImageHeight, maxImageWidth, primaryAction, renderImage, secondaryAction, width, size, tertiaryAction, testId, }: EmptyStateProps) => JSX.Element;
 export default EmptyState;

package/dist/types/styled/header.d.ts

@@ -1,5 +1,9 @@
 /** @jsx jsx */
 import { FC } from 'react';
+type HeaderProps = {
+    children: string;
+    level?: number;
+};
 /**
  * __Header__
  *
@@ -7,7 +11,5 @@ import { FC } from 'react';
  *
  * @internal
  */
-declare const EmptyStateHeader: FC<{
-    children: string;
-}>;
+declare const EmptyStateHeader: FC<HeaderProps>;
 export default EmptyStateHeader;

package/dist/types/types.d.ts

@@ -12,6 +12,11 @@ export interface EmptyStateProps {
      * Title that briefly describes the page to the user.
      */
     header: string;
+    /**
+     * The value used to set the heading level of the header element.
+     * Must be in the range of 1 to 6. Defaults to 4.
+     */
+    headingLevel?: number;
     /**
      * The main block of text that holds additional supporting information.
      */

package/dist/types-ts4.5/empty-state.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import type { EmptyStateProps } from './types';
+/**
+ * __Empty state__
+ *
+ * A component used for presenting various empty states.
+ * e.g. (no items, empty search, broken link, welcome screen etc.)
+ *
+ * @example
+ * ```tsx
+ * import EmptyState from '@atlaskit/empty-state';
+ *
+ * // An example of a 404 state
+ * export default () => {
+ *  <EmptyState
+ *   header="Page not found"
+ *   imageUrl="https://cdn.io/images/404"
+ *   description="Looks like you've stumbled off track. Sorry about that! This page either doesn't exist or has been removed."
+ *   primaryAction={<Button appearance="primary">Home Page</Button>}
+ *   secondaryAction={<Button>Report a problem</Button>}
+ *  />;
+ * };
+ * ```
+ */
+declare const EmptyState: ({ description, header, headingLevel, imageHeight, imageUrl, imageWidth, isLoading, maxImageHeight, maxImageWidth, primaryAction, renderImage, secondaryAction, width, size, tertiaryAction, testId, }: EmptyStateProps) => JSX.Element;
+export default EmptyState;

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

@@ -0,0 +1,2 @@
+export { default } from './empty-state';
+export type { Sizes, Width, RenderImageProps, EmptyStateProps } from './types';

package/dist/types-ts4.5/styled/actions-container.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { FC, ReactNode } from 'react';
+/**
+ * __Actions container__
+ *
+ * A container for actions: primary action, secondary action, and tertiary action.
+ *
+ * @internal
+ */
+declare const ActionsContainer: FC<{
+    children: ReactNode;
+}>;
+export default ActionsContainer;

package/dist/types-ts4.5/styled/container.d.ts

@@ -0,0 +1,17 @@
+/** @jsx jsx */
+import { FC, ReactNode } from 'react';
+import type { Width } from '../index';
+type ContainerProps = {
+    testId?: string;
+    width: Width;
+    children: ReactNode;
+};
+/**
+ * __Container__
+ *
+ * Upper level container for Empty State.
+ *
+ * @internal
+ */
+declare const Container: FC<ContainerProps>;
+export default Container;

package/dist/types-ts4.5/styled/description.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { FC, ReactNode } from 'react';
+/**
+ * __Description__
+ *
+ * Description of Empty State.
+ *
+ * @internal
+ */
+declare const Description: FC<{
+    children: ReactNode;
+}>;
+export default Description;

package/dist/types-ts4.5/styled/header.d.ts

@@ -0,0 +1,15 @@
+/** @jsx jsx */
+import { FC } from 'react';
+type HeaderProps = {
+    children: string;
+    level?: number;
+};
+/**
+ * __Header__
+ *
+ * Header of Empty State.
+ *
+ * @internal
+ */
+declare const EmptyStateHeader: FC<HeaderProps>;
+export default EmptyStateHeader;

package/dist/types-ts4.5/styled/image.d.ts

@@ -0,0 +1,18 @@
+/** @jsx jsx */
+import { FC } from 'react';
+type ImageProps = {
+    height?: number;
+    maxHeight: number;
+    maxWidth: number;
+    width?: number;
+    src: string;
+};
+/**
+ * __Image__
+ *
+ * Image in Empty State.
+ *
+ * @internal
+ */
+declare const Image: FC<ImageProps>;
+export default Image;

package/dist/types-ts4.5/styled/index.d.ts

@@ -0,0 +1,6 @@
+export { default as ActionsContainer } from './actions-container';
+export { default as Container } from './container';
+export { default as Description } from './description';
+export { default as Header } from './header';
+export { default as Image } from './image';
+export { default as SpinnerContainer } from './spinner-container';

package/dist/types-ts4.5/styled/spinner-container.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { FC, ReactNode } from 'react';
+/**
+ * __Spinner container__
+ *
+ * A spinner container for loading state of Empty State.
+ *
+ * @internal
+ */
+declare const SpinnerContainer: FC<{
+    children?: ReactNode;
+}>;
+export default SpinnerContainer;

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,81 @@
+import type { ReactNode } from 'react';
+export interface RenderImageProps {
+    maxImageWidth?: number;
+    maxImageHeight?: number;
+    imageWidth?: number;
+    imageHeight?: number;
+}
+export type Sizes = 'narrow' | 'wide';
+export type Width = Sizes;
+export interface EmptyStateProps {
+    /**
+     * Title that briefly describes the page to the user.
+     */
+    header: string;
+    /**
+     * The value used to set the heading level of the header element.
+     * Must be in the range of 1 to 6. Defaults to 4.
+     */
+    headingLevel?: number;
+    /**
+     * The main block of text that holds additional supporting information.
+     */
+    description?: ReactNode;
+    /**
+     * Controls how much horizontal space the component fills. Defaults to "wide".
+     */
+    width?: Width;
+    /**
+     * @deprecated
+     * Duplicates the `width` prop. Use `width instead`.
+     */
+    size?: Width;
+    /**
+     * The url of image that will be shown above the title, fed directly into the `src` prop of an <img> element.
+     * Note, this image will be constrained by the `maxWidth` and `maxHeight` props.
+     */
+    imageUrl?: string;
+    /**
+     * Maximum width (in pixels) of the image, default value is 160.
+     */
+    maxImageWidth?: number;
+    /**
+     * Maximum height (in pixels) of the image, default value is 160.
+     */
+    maxImageHeight?: number;
+    /**
+     * Primary action button for the page, usually it will be something like "Create" (or "Retry" for error pages).
+     */
+    primaryAction?: ReactNode;
+    /**
+     * An alternative API to supply an image using a render prop. Only rendered if no `imageUrl` is supplied.
+     */
+    renderImage?: (props: RenderImageProps) => React.ReactNode;
+    /**
+     * Secondary action button for the page.
+     */
+    secondaryAction?: ReactNode;
+    /**
+     * Button with link to some external resource like documentation or tutorial, it will be opened in a new tab.
+     */
+    tertiaryAction?: ReactNode;
+    /**
+     * A hook for automated testing
+     */
+    testId?: string;
+    /**
+     * Used to indicate a loading state. Will show a spinner next to the action buttons when true.
+     */
+    isLoading?: boolean;
+    /**
+     * Width of the image that is rendered in EmptyState component.
+     * Useful when you want image to be of exact width to stop it bouncing around when loading in.
+     */
+    imageWidth?: number;
+    /**
+     * Height of the image that is rendered in EmptyState component.
+     * Useful when you want image to be of exact height to stop it bouncing around when loading in.
+     * Only set `height` if you want the image to resize down on smaller devices.
+     */
+    imageHeight?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/empty-state",
-  "version": "7.5.1",
+  "version": "7.6.0",
   "description": "An empty state appears when there is no data to display and describes what the user can do next.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,17 +25,17 @@
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
     "team": "Design System Team",
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
     "website": {
       "name": "Empty state",
       "category": "Components"
     }
   },
   "dependencies": {
-    "@atlaskit/button": "^16.7.0",
+    "@atlaskit/button": "^16.8.0",
     "@atlaskit/spinner": "^15.5.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.4.0",
+    "@atlaskit/tokens": "^1.9.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },
@@ -49,6 +49,7 @@
     "@atlaskit/visual-regression": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@testing-library/react": "^12.1.5",
+    "jest-axe": "^4.0.0",
     "react-dom": "^16.8.0",
     "typescript": "~4.9.5",
     "wait-for-expect": "^1.2.0"

package/report.api.md

@@ -8,6 +8,7 @@
 ### Table of contents
 
 - [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
 
 ### Main Entry Types
 
@@ -22,6 +23,7 @@ import type { ReactNode } from 'react';
 const EmptyState: ({
   description,
   header,
+  headingLevel,
   imageHeight,
   imageUrl,
   imageWidth,
@@ -42,6 +44,7 @@ export default EmptyState;
 export interface EmptyStateProps {
   description?: ReactNode;
   header: string;
+  headingLevel?: number;
   imageHeight?: number;
   imageUrl?: string;
   imageWidth?: number;
@@ -80,3 +83,15 @@ export type Width = Sizes;
 ```
 
 <!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

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

@@ -0,0 +1,56 @@
+## API Report File for "@atlaskit/empty-state"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import type { ReactNode } from 'react';
+
+// @public
+const EmptyState: ({ description, header, headingLevel, imageHeight, imageUrl, imageWidth, isLoading, maxImageHeight, maxImageWidth, primaryAction, renderImage, secondaryAction, width, size, tertiaryAction, testId, }: EmptyStateProps) => JSX.Element;
+export default EmptyState;
+
+// @public (undocumented)
+export interface EmptyStateProps {
+    description?: ReactNode;
+    header: string;
+    headingLevel?: number;
+    imageHeight?: number;
+    imageUrl?: string;
+    imageWidth?: number;
+    isLoading?: boolean;
+    maxImageHeight?: number;
+    maxImageWidth?: number;
+    primaryAction?: ReactNode;
+    renderImage?: (props: RenderImageProps) => React.ReactNode;
+    secondaryAction?: ReactNode;
+    // @deprecated (undocumented)
+    size?: Width;
+    tertiaryAction?: ReactNode;
+    testId?: string;
+    width?: Width;
+}
+
+// @public (undocumented)
+export interface RenderImageProps {
+    // (undocumented)
+    imageHeight?: number;
+    // (undocumented)
+    imageWidth?: number;
+    // (undocumented)
+    maxImageHeight?: number;
+    // (undocumented)
+    maxImageWidth?: number;
+}
+
+// @public (undocumented)
+export type Sizes = 'narrow' | 'wide';
+
+// @public (undocumented)
+export type Width = Sizes;
+
+// (No @packageDocumentation comment for this package)
+
+```