@atlaskit/page-header 10.2.3 → 10.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @atlaskit/page-header
2
2
 
3
+ ## 10.2.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`8d4228767b0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8d4228767b0) - Upgrade Typescript from `4.2.4` to `4.3.5`.
8
+
3
9
  ## 10.2.3
4
10
 
5
11
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/page-header",
3
- "version": "10.2.3",
3
+ "version": "10.2.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/page-header",
3
- "version": "10.2.3",
3
+ "version": "10.2.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/page-header",
3
- "version": "10.2.3",
3
+ "version": "10.2.4",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@atlaskit/page-header",
3
- "version": "10.2.3",
3
+ "version": "10.2.4",
4
4
  "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.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
7
7
  },
8
- "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
8
+ "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
9
9
  "author": "Atlassian Pty Ltd",
10
10
  "license": "Apache-2.0",
11
11
  "main": "dist/cjs/index.js",
@@ -19,7 +19,8 @@
19
19
  "team": "Design System Team",
20
20
  "releaseModel": "scheduled",
21
21
  "website": {
22
- "name": "Page header"
22
+ "name": "Page header",
23
+ "category": "Components"
23
24
  }
24
25
  },
25
26
  "dependencies": {
@@ -32,13 +33,13 @@
32
33
  "react-dom": "^16.8.0"
33
34
  },
34
35
  "devDependencies": {
35
- "@atlaskit/breadcrumbs": "^11.5.0",
36
+ "@atlaskit/breadcrumbs": "^11.6.0",
36
37
  "@atlaskit/button": "^16.3.0",
37
38
  "@atlaskit/docs": "*",
38
39
  "@atlaskit/inline-edit": "^12.1.0",
39
40
  "@atlaskit/page": "^12.1.0",
40
41
  "@atlaskit/section-message": "^6.1.0",
41
- "@atlaskit/select": "^15.0.0",
42
+ "@atlaskit/select": "^15.6.0",
42
43
  "@atlaskit/ssr": "*",
43
44
  "@atlaskit/textfield": "^5.1.0",
44
45
  "@atlaskit/visual-regression": "*",
@@ -46,7 +47,7 @@
46
47
  "enzyme": "^3.10.0",
47
48
  "react-dom": "^16.8.0",
48
49
  "react-test-renderer": "^16.8.0",
49
- "typescript": "4.2.4"
50
+ "typescript": "4.3.5"
50
51
  },
51
52
  "keywords": [
52
53
  "atlaskit",
@@ -58,6 +59,7 @@
58
59
  "import-structure": "atlassian-conventions"
59
60
  },
60
61
  "@repo/internal": {
62
+ "dom-events": "use-bind-event-listener",
61
63
  "analytics": "analytics-next",
62
64
  "theming": [
63
65
  "react-context",
package/report.api.md ADDED
@@ -0,0 +1,67 @@
1
+ ## API Report File for "@atlaskit/page-header"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+ import { ReactElement } from 'react';
7
+ import { ReactNode } from 'react';
8
+
9
+ /**
10
+ * __Page header__
11
+ *
12
+ * A page header defines the top of a page. It contains a title and can be optionally combined with
13
+ * breadcrumbs buttons, search, and filters.
14
+ *
15
+ * - [Examples](https://atlassian.design/components/page-header/examples)
16
+ * - [Code](https://atlassian.design/components/page-header/code)
17
+ * - [Usage](https://atlassian.design/components/page-header/usage)
18
+ */
19
+ declare const PageHeader: ({
20
+ innerRef,
21
+ breadcrumbs,
22
+ actions,
23
+ bottomBar,
24
+ children,
25
+ id,
26
+ disableTitleStyles,
27
+ truncateTitle,
28
+ }: PageHeaderProps) => JSX.Element;
29
+ export default PageHeader;
30
+
31
+ declare type PageHeaderProps = {
32
+ /**
33
+ * Contents of the action bar to be rendered next to the page title.
34
+ */
35
+ actions?: ReactElement;
36
+ /**
37
+ * Contents of the action bar to be rendered next to the page title. Typically a button group.
38
+ */
39
+ bottomBar?: ReactElement;
40
+ /**
41
+ * Page breadcrumbs to be rendered above the title.
42
+ */
43
+ breadcrumbs?: ReactElement;
44
+ /**
45
+ * Contents of the bottom bar to be rendered below the page title. Typically contains a search bar and/or filters.
46
+ */
47
+ children?: ReactNode;
48
+ /**
49
+ * Content of the page title. The text wraps by default.
50
+ */
51
+ disableTitleStyles?: boolean;
52
+ /**
53
+ * Returns the inner ref to the DOM element of the title. This is exposed so the focus can be set.
54
+ */
55
+ innerRef?: (element: HTMLElement) => void;
56
+ /**
57
+ * Prevent the title from wrapping across lines. This should be avoided.
58
+ */
59
+ truncateTitle?: boolean;
60
+ /**
61
+ * 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
62
+ */
63
+ id?: string;
64
+ };
65
+
66
+ export {};
67
+ ```