@atlaskit/empty-state 7.5.0 → 7.5.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/empty-state
 
+## 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
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 7.5.0
 
 ### Minor Changes

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

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

@@ -1,7 +1,7 @@
 /** @jsx jsx */
 import { FC, ReactNode } from 'react';
 import type { Width } from '../index';
-declare type ContainerProps = {
+type ContainerProps = {
     testId?: string;
     width: Width;
     children: ReactNode;

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

@@ -1,6 +1,6 @@
 /** @jsx jsx */
 import { FC } from 'react';
-declare type ImageProps = {
+type ImageProps = {
     height?: number;
     maxHeight: number;
     maxWidth: number;

package/dist/types/types.d.ts

@@ -5,8 +5,8 @@ export interface RenderImageProps {
     imageWidth?: number;
     imageHeight?: number;
 }
-export declare type Sizes = 'narrow' | 'wide';
-export declare type Width = Sizes;
+export type Sizes = 'narrow' | 'wide';
+export type Width = Sizes;
 export interface EmptyStateProps {
     /**
      * Title that briefly describes the page to the user.

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, 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,13 @@
+/** @jsx jsx */
+import { FC } from 'react';
+/**
+ * __Header__
+ *
+ * Header of Empty State.
+ *
+ * @internal
+ */
+declare const EmptyStateHeader: FC<{
+    children: string;
+}>;
+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,76 @@
+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 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.0",
+  "version": "7.5.2",
   "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/"
@@ -13,6 +13,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
@@ -27,7 +35,7 @@
     "@atlaskit/button": "^16.7.0",
     "@atlaskit/spinner": "^15.5.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.3.0",
+    "@atlaskit/tokens": "^1.4.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },
@@ -42,7 +50,7 @@
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",
-    "typescript": "4.5.5",
+    "typescript": "~4.9.5",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {

package/types/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/types.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/types.d.ts"
+        "../dist/types-ts4.5/types.d.ts"
       ]
     }
   }