@atlaskit/empty-state 7.3.11 → 7.3.12

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/empty-state
 
+## 7.3.12
+
+### Patch Changes
+
+- [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
+
 ## 7.3.11
 
 ### Patch Changes

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@atlaskit/empty-state",
-  "version": "7.3.11",
+  "version": "7.3.12",
   "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/"
   },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
   "homepage": "https://atlassian.design/components/empty-state/",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -19,7 +19,8 @@
     "team": "Design System Team",
     "releaseModel": "scheduled",
     "website": {
-      "name": "Empty state"
+      "name": "Empty state",
+      "category": "Components"
     }
   },
   "dependencies": {
@@ -41,7 +42,7 @@
     "@testing-library/react": "^8.0.1",
     "enzyme": "^3.10.0",
     "react-dom": "^16.8.0",
-    "typescript": "4.2.4",
+    "typescript": "4.3.5",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {
@@ -49,6 +50,7 @@
       "import-structure": "atlassian-conventions"
     },
     "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
       "analytics": "analytics-next",
       "theming": "tokens",
       "styling": [

package/report.api.md

@@ -0,0 +1,131 @@
+## 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';
+
+/**
+ * __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;
+
+export declare 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;
+}
+
+export declare interface RenderImageProps {
+  maxImageWidth?: number;
+  maxImageHeight?: number;
+  imageWidth?: number;
+  imageHeight?: number;
+}
+
+export declare type Sizes = 'narrow' | 'wide';
+
+export declare type Width = Sizes;
+
+export {};
+````