@atlaskit/page-header 10.4.0 → 10.4.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/page-header
 
+## 10.4.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
+## 10.4.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 10.4.0
 
 ### Minor Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/page-header",
-	"version": "10.4.0",
+	"version": "10.4.2",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/page-header",
-	"version": "10.4.0",
+	"version": "10.4.2",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/page-header",
-	"version": "10.4.0",
+	"version": "10.4.2",
 	"sideEffects": false
 }

package/dist/types/PageHeader/index.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement, ReactNode } from 'react';
-export declare type PageHeaderProps = {
+export type PageHeaderProps = {
     /**
      * Contents of the action bar to be rendered next to the page title.
      */

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

@@ -0,0 +1,47 @@
+import { ReactElement, ReactNode } from 'react';
+export type PageHeaderProps = {
+    /**
+     * Contents of the action bar to be rendered next to the page title.
+     */
+    actions?: ReactElement;
+    /**
+     * Contents of the action bar to be rendered next to the page title. Typically a button group.
+     */
+    bottomBar?: ReactElement;
+    /**
+     * Page breadcrumbs to be rendered above the title.
+     */
+    breadcrumbs?: ReactElement;
+    /**
+     * Contents of the bottom bar to be rendered below the page title. Typically contains a search bar and/or filters.
+     */
+    children?: ReactNode;
+    /**
+     * Content of the page title. The text wraps by default.
+     */
+    disableTitleStyles?: boolean;
+    /**
+     * Returns the inner ref to the DOM element of the title. This is exposed so the focus can be set.
+     */
+    innerRef?: (element: HTMLElement) => void;
+    /**
+     * Prevent the title from wrapping across lines. This should be avoided.
+     */
+    truncateTitle?: boolean;
+    /**
+     * Used as id of inner h1 tag. This is exposed so the header text can be used as label of other element by aria-labeledby
+     */
+    id?: string;
+};
+/**
+ * __Page header__
+ *
+ * A page header defines the top of a page. It contains a title and can be optionally combined with
+ * breadcrumbs buttons, search, and filters.
+ *
+ * - [Examples](https://atlassian.design/components/page-header/examples)
+ * - [Code](https://atlassian.design/components/page-header/code)
+ * - [Usage](https://atlassian.design/components/page-header/usage)
+ */
+declare const PageHeader: ({ innerRef, breadcrumbs, actions, bottomBar, children, id, disableTitleStyles, truncateTitle, }: PageHeaderProps) => JSX.Element;
+export default PageHeader;

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

@@ -0,0 +1,61 @@
+/** @jsx jsx */
+import React, { ReactNode } from 'react';
+/**
+ * __Outer wrapper__
+ *
+ * An outer wrapper that is the outermost component of the PageHeader component. It wraps around the PageHeader, its Actions,
+ * the BottomBar and its Breadcrumbs.
+ *
+ */
+export declare const OuterWrapper: React.FC<{
+    children: ReactNode;
+}>;
+interface StyledTitleWrapperProps {
+    children?: React.ReactNode;
+    id?: string;
+    truncateTitle?: boolean;
+}
+/**
+ * __Styled title wrapper__
+ *
+ * A styled title wrapper is a wrapper around the title that controls its the styles exclusively.
+ *
+ */
+export declare const StyledTitleWrapper: React.ForwardRefExoticComponent<StyledTitleWrapperProps & React.RefAttributes<HTMLHeadingElement>>;
+interface TitleProps {
+    truncateTitle?: boolean;
+    children?: ReactNode;
+}
+/**
+ * __Title wrapper__
+ *
+ * A title wrapper is a wrapper around the title and the actions.
+ *
+ */
+export declare const TitleWrapper: React.FC<TitleProps>;
+/**
+ * Title container
+ *
+ * A title container is a container that wraps around the title and its styles (if applied).
+ *
+ */
+export declare const TitleContainer: React.FC<TitleProps>;
+/**
+ * __Actions wrapper__
+ *
+ * An actions wrapper is a wrapper for the actions, which appear on the top right of the PageHeader component.
+ *
+ */
+export declare const ActionsWrapper: React.FC<{
+    children: ReactNode;
+}>;
+/**
+ * __Bottom bar wrapper__
+ *
+ * A bottom bar wrapper is a wrapper for the bottom bar, which appears at the bottom of the PageHeader component.
+ *
+ */
+export declare const BottomBarWrapper: React.FC<{
+    children: ReactNode;
+}>;
+export {};

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

@@ -0,0 +1 @@
+export { default } from './PageHeader';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/page-header",
-  "version": "10.4.0",
+  "version": "10.4.2",
   "description": "A page header defines the top of a page. It contains a title and can be optionally combined with breadcrumbs buttons, search, and filters.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,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",
   "homepage": "https://atlassian.design/components/page-header",
@@ -28,7 +36,7 @@
   },
   "dependencies": {
     "@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"
   },
@@ -52,7 +60,7 @@
     "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",
     "react-test-renderer": "^16.8.0",
-    "typescript": "4.5.5"
+    "typescript": "~4.9.5"
   },
   "keywords": [
     "atlaskit",

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

@@ -0,0 +1,28 @@
+## API Report File for "@atlaskit/page-header"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ReactElement } from 'react';
+import { ReactNode } from 'react';
+
+// @public
+const PageHeader: ({ innerRef, breadcrumbs, actions, bottomBar, children, id, disableTitleStyles, truncateTitle, }: PageHeaderProps) => JSX.Element;
+export default PageHeader;
+
+// @public (undocumented)
+type PageHeaderProps = {
+    actions?: ReactElement;
+    bottomBar?: ReactElement;
+    breadcrumbs?: ReactElement;
+    children?: ReactNode;
+    disableTitleStyles?: boolean;
+    innerRef?: (element: HTMLElement) => void;
+    truncateTitle?: boolean;
+    id?: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```