@atlaskit/page-header 12.1.16 → 12.1.18
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 +13 -0
- package/dist/cjs/PageHeader/actions-wrapper.compiled.css +8 -0
- package/dist/cjs/PageHeader/actions-wrapper.js +27 -0
- package/dist/cjs/PageHeader/bottom-bar.compiled.css +1 -0
- package/dist/cjs/PageHeader/bottom-bar.js +30 -0
- package/dist/cjs/PageHeader/index.js +10 -5
- package/dist/cjs/PageHeader/outer-wrapper.compiled.css +4 -0
- package/dist/cjs/PageHeader/outer-wrapper.js +28 -0
- package/dist/cjs/PageHeader/title-container.compiled.css +7 -0
- package/dist/cjs/PageHeader/title-container.js +33 -0
- package/dist/cjs/PageHeader/title-wrapper.compiled.css +3 -0
- package/dist/cjs/PageHeader/title-wrapper.js +33 -0
- package/dist/cjs/PageHeader/title.compiled.css +11 -0
- package/dist/cjs/PageHeader/title.js +38 -0
- package/dist/es2019/PageHeader/actions-wrapper.compiled.css +8 -0
- package/dist/es2019/PageHeader/actions-wrapper.js +20 -0
- package/dist/es2019/PageHeader/bottom-bar.compiled.css +1 -0
- package/dist/es2019/PageHeader/bottom-bar.js +23 -0
- package/dist/es2019/PageHeader/index.js +8 -3
- package/dist/es2019/PageHeader/outer-wrapper.compiled.css +4 -0
- package/dist/es2019/PageHeader/outer-wrapper.js +21 -0
- package/dist/es2019/PageHeader/title-container.compiled.css +7 -0
- package/dist/es2019/PageHeader/title-container.js +26 -0
- package/dist/es2019/PageHeader/title-wrapper.compiled.css +3 -0
- package/dist/es2019/PageHeader/title-wrapper.js +26 -0
- package/dist/es2019/PageHeader/title.compiled.css +11 -0
- package/dist/es2019/PageHeader/title.js +32 -0
- package/dist/esm/PageHeader/actions-wrapper.compiled.css +8 -0
- package/dist/esm/PageHeader/actions-wrapper.js +19 -0
- package/dist/esm/PageHeader/bottom-bar.compiled.css +1 -0
- package/dist/esm/PageHeader/bottom-bar.js +22 -0
- package/dist/esm/PageHeader/index.js +8 -3
- package/dist/esm/PageHeader/outer-wrapper.compiled.css +4 -0
- package/dist/esm/PageHeader/outer-wrapper.js +20 -0
- package/dist/esm/PageHeader/title-container.compiled.css +7 -0
- package/dist/esm/PageHeader/title-container.js +25 -0
- package/dist/esm/PageHeader/title-wrapper.compiled.css +3 -0
- package/dist/esm/PageHeader/title-wrapper.js +25 -0
- package/dist/esm/PageHeader/title.compiled.css +11 -0
- package/dist/esm/PageHeader/title.js +31 -0
- package/dist/types/PageHeader/actions-wrapper.d.ts +15 -0
- package/dist/types/PageHeader/bottom-bar.d.ts +15 -0
- package/dist/types/PageHeader/outer-wrapper.d.ts +16 -0
- package/dist/types/PageHeader/title-container.d.ts +17 -0
- package/dist/types/PageHeader/title-wrapper.d.ts +17 -0
- package/dist/types/PageHeader/title.d.ts +19 -0
- package/dist/types-ts4.5/PageHeader/actions-wrapper.d.ts +15 -0
- package/dist/types-ts4.5/PageHeader/bottom-bar.d.ts +15 -0
- package/dist/types-ts4.5/PageHeader/outer-wrapper.d.ts +16 -0
- package/dist/types-ts4.5/PageHeader/title-container.d.ts +17 -0
- package/dist/types-ts4.5/PageHeader/title-wrapper.d.ts +17 -0
- package/dist/types-ts4.5/PageHeader/title.d.ts +19 -0
- package/package.json +10 -9
- package/page-header.docs.tsx +47 -0
- package/dist/cjs/PageHeader/styled.compiled.css +0 -30
- package/dist/cjs/PageHeader/styled.js +0 -114
- package/dist/es2019/PageHeader/styled.compiled.css +0 -30
- package/dist/es2019/PageHeader/styled.js +0 -113
- package/dist/esm/PageHeader/styled.compiled.css +0 -30
- package/dist/esm/PageHeader/styled.js +0 -107
- package/dist/types/PageHeader/styled.d.ts +0 -65
- package/dist/types-ts4.5/PageHeader/styled.d.ts +0 -65
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/* title-container.tsx generated by @compiled/babel-plugin v0.39.1 */
|
|
2
|
+
// TODO: Remove this eslint-disable when prop names have been renamed.
|
|
3
|
+
// This rule is here as prop name changes are a major as they are used
|
|
4
|
+
// by our consumers. The prop name concerned here is truncateTitle.
|
|
5
|
+
// This can be done in the next lite-mode conversion.
|
|
6
|
+
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention */
|
|
7
|
+
import "./title-container.compiled.css";
|
|
8
|
+
import * as React from 'react';
|
|
9
|
+
import { ax, ix } from "@compiled/react/runtime";
|
|
10
|
+
var titleContainerStyles = null;
|
|
11
|
+
var titleContainerTruncateStyles = null;
|
|
12
|
+
/**
|
|
13
|
+
* Title container.
|
|
14
|
+
*
|
|
15
|
+
* A title container is a container that wraps around the title and its styles (if applied).
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
var TitleContainer = function TitleContainer(_ref) {
|
|
19
|
+
var children = _ref.children,
|
|
20
|
+
truncateTitle = _ref.truncateTitle;
|
|
21
|
+
return /*#__PURE__*/React.createElement("div", {
|
|
22
|
+
className: ax(["_16jlkb7n _1o9zkb7n _i0dl1wug _1ul9idpf _p12f1osq _6rthu2gc _1i4q1hna", truncateTitle && "_1o9zkb7n"])
|
|
23
|
+
}, children);
|
|
24
|
+
};
|
|
25
|
+
export default TitleContainer;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/* title-wrapper.tsx generated by @compiled/babel-plugin v0.39.1 */
|
|
2
|
+
// TODO: Remove this eslint-disable when prop names have been renamed.
|
|
3
|
+
// This rule is here as prop name changes are a major as they are used
|
|
4
|
+
// by our consumers. The prop name concerned here is truncateTitle.
|
|
5
|
+
// This can be done in the next lite-mode conversion.
|
|
6
|
+
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention */
|
|
7
|
+
import "./title-wrapper.compiled.css";
|
|
8
|
+
import * as React from 'react';
|
|
9
|
+
import { ax, ix } from "@compiled/react/runtime";
|
|
10
|
+
var titleWrapperStyles = null;
|
|
11
|
+
var titleWrapperTruncateStyles = null;
|
|
12
|
+
/**
|
|
13
|
+
* __Title wrapper__.
|
|
14
|
+
*
|
|
15
|
+
* A title wrapper is a wrapper around the title and the actions.
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
var TitleWrapper = function TitleWrapper(_ref) {
|
|
19
|
+
var children = _ref.children,
|
|
20
|
+
truncateTitle = _ref.truncateTitle;
|
|
21
|
+
return /*#__PURE__*/React.createElement("div", {
|
|
22
|
+
className: ax(["_1e0c1txw _4cvr1y6m _1n261q9c", truncateTitle && "_1n261q9c"])
|
|
23
|
+
}, children);
|
|
24
|
+
};
|
|
25
|
+
export default TitleWrapper;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
._11c810sd{font:var(--ds-font-heading-large,normal 653 24px/28px "Atlassian Sans",ui-sans-serif,-apple-system,BlinkMacSystemFont,"Segoe UI",Ubuntu,"Helvetica Neue",sans-serif)}
|
|
2
|
+
._12ji1r31{outline-color:currentColor}
|
|
3
|
+
._12y31o36{outline-width:medium}
|
|
4
|
+
._18m915vq{overflow-y:hidden}
|
|
5
|
+
._1bto1l2s{text-overflow:ellipsis}
|
|
6
|
+
._1dyz4jg8{letter-spacing:normal}
|
|
7
|
+
._1pfhidpf{margin-block-start:0}
|
|
8
|
+
._1qu2glyw{outline-style:none}
|
|
9
|
+
._1reo15vq{overflow-x:hidden}
|
|
10
|
+
._o5721q9c{white-space:nowrap}
|
|
11
|
+
._syazi7uo{color:var(--ds-text,#292a2e)}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/* title.tsx generated by @compiled/babel-plugin v0.39.1 */
|
|
2
|
+
// TODO: Remove this eslint-disable when prop names have been renamed.
|
|
3
|
+
// This rule is here as prop name changes are a major as they are used
|
|
4
|
+
// by our consumers. The prop name concerned here is truncateTitle.
|
|
5
|
+
// This can be done in the next lite-mode conversion.
|
|
6
|
+
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention */
|
|
7
|
+
import "./title.compiled.css";
|
|
8
|
+
import { ax, ix } from "@compiled/react/runtime";
|
|
9
|
+
import React from 'react';
|
|
10
|
+
var truncateStyles = null;
|
|
11
|
+
var titleStyles = null;
|
|
12
|
+
/**
|
|
13
|
+
* __Styled title wrapper__.
|
|
14
|
+
*
|
|
15
|
+
* A styled title wrapper is a wrapper around the title that controls its the styles exclusively.
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
var Title = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
|
|
19
|
+
var children = _ref.children,
|
|
20
|
+
id = _ref.id,
|
|
21
|
+
truncateTitle = _ref.truncateTitle,
|
|
22
|
+
testId = _ref.testId;
|
|
23
|
+
return /*#__PURE__*/React.createElement("h1", {
|
|
24
|
+
ref: ref,
|
|
25
|
+
tabIndex: -1,
|
|
26
|
+
id: id,
|
|
27
|
+
"data-testid": testId && "".concat(testId, "--title"),
|
|
28
|
+
className: ax(["_11c810sd _12ji1r31 _1qu2glyw _12y31o36 _syazi7uo _1dyz4jg8 _1pfhidpf", truncateTitle && "_1reo15vq _18m915vq _1bto1l2s _o5721q9c"])
|
|
29
|
+
}, children);
|
|
30
|
+
});
|
|
31
|
+
export default Title;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
/**
|
|
7
|
+
* __Actions wrapper__.
|
|
8
|
+
*
|
|
9
|
+
* An actions wrapper is a wrapper for the actions, which appear on the top right of the PageHeader component.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
declare const ActionsWrapper: ({ children }: {
|
|
13
|
+
children: ReactNode;
|
|
14
|
+
}) => JSX.Element;
|
|
15
|
+
export default ActionsWrapper;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
/**
|
|
7
|
+
* __Bottom bar__.
|
|
8
|
+
*
|
|
9
|
+
* A bottom bar is a wrapper for the bottom bar, which appears at the bottom of the PageHeader component.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
declare const BottomBar: ({ children }: {
|
|
13
|
+
children: ReactNode;
|
|
14
|
+
}) => JSX.Element;
|
|
15
|
+
export default BottomBar;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
/**
|
|
7
|
+
* __Outer wrapper__.
|
|
8
|
+
*
|
|
9
|
+
* An outer wrapper that is the outermost component of the PageHeader component. It wraps around the PageHeader, its Actions,
|
|
10
|
+
* the BottomBar and its Breadcrumbs.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
declare const OuterWrapper: ({ children }: {
|
|
14
|
+
children: ReactNode;
|
|
15
|
+
}) => JSX.Element;
|
|
16
|
+
export default OuterWrapper;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
interface TitleProps {
|
|
7
|
+
truncateTitle?: boolean;
|
|
8
|
+
children?: ReactNode;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Title container.
|
|
12
|
+
*
|
|
13
|
+
* A title container is a container that wraps around the title and its styles (if applied).
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
declare const TitleContainer: ({ children, truncateTitle }: TitleProps) => JSX.Element;
|
|
17
|
+
export default TitleContainer;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
interface TitleProps {
|
|
7
|
+
truncateTitle?: boolean;
|
|
8
|
+
children?: ReactNode;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* __Title wrapper__.
|
|
12
|
+
*
|
|
13
|
+
* A title wrapper is a wrapper around the title and the actions.
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
declare const TitleWrapper: ({ children, truncateTitle }: TitleProps) => JSX.Element;
|
|
17
|
+
export default TitleWrapper;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import React from 'react';
|
|
6
|
+
interface TitleProps {
|
|
7
|
+
children?: React.ReactNode;
|
|
8
|
+
id?: string;
|
|
9
|
+
truncateTitle?: boolean;
|
|
10
|
+
testId?: string;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* __Styled title wrapper__.
|
|
14
|
+
*
|
|
15
|
+
* A styled title wrapper is a wrapper around the title that controls its the styles exclusively.
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
declare const Title: React.ForwardRefExoticComponent<React.PropsWithoutRef<TitleProps> & React.RefAttributes<HTMLHeadingElement>>;
|
|
19
|
+
export default Title;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
/**
|
|
7
|
+
* __Actions wrapper__.
|
|
8
|
+
*
|
|
9
|
+
* An actions wrapper is a wrapper for the actions, which appear on the top right of the PageHeader component.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
declare const ActionsWrapper: ({ children }: {
|
|
13
|
+
children: ReactNode;
|
|
14
|
+
}) => JSX.Element;
|
|
15
|
+
export default ActionsWrapper;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
/**
|
|
7
|
+
* __Bottom bar__.
|
|
8
|
+
*
|
|
9
|
+
* A bottom bar is a wrapper for the bottom bar, which appears at the bottom of the PageHeader component.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
declare const BottomBar: ({ children }: {
|
|
13
|
+
children: ReactNode;
|
|
14
|
+
}) => JSX.Element;
|
|
15
|
+
export default BottomBar;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
/**
|
|
7
|
+
* __Outer wrapper__.
|
|
8
|
+
*
|
|
9
|
+
* An outer wrapper that is the outermost component of the PageHeader component. It wraps around the PageHeader, its Actions,
|
|
10
|
+
* the BottomBar and its Breadcrumbs.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
declare const OuterWrapper: ({ children }: {
|
|
14
|
+
children: ReactNode;
|
|
15
|
+
}) => JSX.Element;
|
|
16
|
+
export default OuterWrapper;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
interface TitleProps {
|
|
7
|
+
truncateTitle?: boolean;
|
|
8
|
+
children?: ReactNode;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Title container.
|
|
12
|
+
*
|
|
13
|
+
* A title container is a container that wraps around the title and its styles (if applied).
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
declare const TitleContainer: ({ children, truncateTitle }: TitleProps) => JSX.Element;
|
|
17
|
+
export default TitleContainer;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import { type ReactNode } from 'react';
|
|
6
|
+
interface TitleProps {
|
|
7
|
+
truncateTitle?: boolean;
|
|
8
|
+
children?: ReactNode;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* __Title wrapper__.
|
|
12
|
+
*
|
|
13
|
+
* A title wrapper is a wrapper around the title and the actions.
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
declare const TitleWrapper: ({ children, truncateTitle }: TitleProps) => JSX.Element;
|
|
17
|
+
export default TitleWrapper;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
import React from 'react';
|
|
6
|
+
interface TitleProps {
|
|
7
|
+
children?: React.ReactNode;
|
|
8
|
+
id?: string;
|
|
9
|
+
truncateTitle?: boolean;
|
|
10
|
+
testId?: string;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* __Styled title wrapper__.
|
|
14
|
+
*
|
|
15
|
+
* A styled title wrapper is a wrapper around the title that controls its the styles exclusively.
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
declare const Title: React.ForwardRefExoticComponent<React.PropsWithoutRef<TitleProps> & React.RefAttributes<HTMLHeadingElement>>;
|
|
19
|
+
export default Title;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/page-header",
|
|
3
|
-
"version": "12.1.
|
|
3
|
+
"version": "12.1.18",
|
|
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/"
|
|
@@ -25,10 +25,10 @@
|
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
27
|
"@atlaskit/css": "^0.19.0",
|
|
28
|
-
"@atlaskit/primitives": "^
|
|
29
|
-
"@atlaskit/tokens": "^
|
|
28
|
+
"@atlaskit/primitives": "^18.1.0",
|
|
29
|
+
"@atlaskit/tokens": "^11.4.0",
|
|
30
30
|
"@babel/runtime": "^7.0.0",
|
|
31
|
-
"@compiled/react": "^0.
|
|
31
|
+
"@compiled/react": "^0.20.0"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"react": "^18.2.0",
|
|
@@ -38,17 +38,18 @@
|
|
|
38
38
|
"@af/accessibility-testing": "workspace:^",
|
|
39
39
|
"@af/integration-testing": "workspace:^",
|
|
40
40
|
"@af/visual-regression": "workspace:^",
|
|
41
|
-
"@atlaskit/breadcrumbs": "^
|
|
42
|
-
"@atlaskit/button": "^23.
|
|
43
|
-
"@atlaskit/docs": "^11.
|
|
44
|
-
"@atlaskit/ds-lib": "^
|
|
41
|
+
"@atlaskit/breadcrumbs": "^16.0.0",
|
|
42
|
+
"@atlaskit/button": "^23.10.0",
|
|
43
|
+
"@atlaskit/docs": "^11.7.0",
|
|
44
|
+
"@atlaskit/ds-lib": "^6.0.0",
|
|
45
45
|
"@atlaskit/inline-edit": "^15.6.0",
|
|
46
46
|
"@atlaskit/link": "^3.3.0",
|
|
47
47
|
"@atlaskit/page": "^14.0.0",
|
|
48
48
|
"@atlaskit/section-message": "^8.12.0",
|
|
49
|
-
"@atlaskit/select": "^21.
|
|
49
|
+
"@atlaskit/select": "^21.8.0",
|
|
50
50
|
"@atlaskit/textfield": "^8.2.0",
|
|
51
51
|
"@atlassian/ssr-tests": "workspace:^",
|
|
52
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
52
53
|
"@testing-library/react": "^16.3.0",
|
|
53
54
|
"react-dom": "^18.2.0"
|
|
54
55
|
},
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
4
|
+
|
|
5
|
+
const documentation: ComponentStructuredContentSource[] = [
|
|
6
|
+
{
|
|
7
|
+
name: 'PageHeader',
|
|
8
|
+
description: 'A component for page headers.',
|
|
9
|
+
status: 'general-availability',
|
|
10
|
+
import: {
|
|
11
|
+
name: 'PageHeader',
|
|
12
|
+
package: '@atlaskit/page-header',
|
|
13
|
+
type: 'default',
|
|
14
|
+
packagePath: path.resolve(__dirname),
|
|
15
|
+
packageJson: require('./package.json'),
|
|
16
|
+
},
|
|
17
|
+
usageGuidelines: [
|
|
18
|
+
'Use for consistent page header layout',
|
|
19
|
+
'Include breadcrumbs for navigation context',
|
|
20
|
+
'Provide relevant page actions',
|
|
21
|
+
'Use appropriate header hierarchy',
|
|
22
|
+
],
|
|
23
|
+
contentGuidelines: [
|
|
24
|
+
'Use clear, descriptive page titles',
|
|
25
|
+
'Provide meaningful breadcrumb labels',
|
|
26
|
+
'Use action-oriented button text',
|
|
27
|
+
'Keep header content focused',
|
|
28
|
+
],
|
|
29
|
+
accessibilityGuidelines: [
|
|
30
|
+
'Provide clear page titles',
|
|
31
|
+
'Use appropriate heading hierarchy',
|
|
32
|
+
'Ensure breadcrumb navigation is accessible',
|
|
33
|
+
'Provide clear action labels',
|
|
34
|
+
],
|
|
35
|
+
examples: [
|
|
36
|
+
{
|
|
37
|
+
name: 'Page Header',
|
|
38
|
+
description: 'Page Header example',
|
|
39
|
+
source: path.resolve(__dirname, './examples/ai/page-header.tsx'),
|
|
40
|
+
},
|
|
41
|
+
],
|
|
42
|
+
keywords: ['page', 'header', 'title', 'breadcrumbs', 'actions'],
|
|
43
|
+
categories: ['layout'],
|
|
44
|
+
},
|
|
45
|
+
];
|
|
46
|
+
|
|
47
|
+
export default documentation;
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
._11c810sd{font:var(--ds-font-heading-large,normal 653 24px/28px "Atlassian Sans",ui-sans-serif,-apple-system,BlinkMacSystemFont,"Segoe UI",Ubuntu,"Helvetica Neue",sans-serif)}
|
|
2
|
-
._12ji1r31{outline-color:currentColor}
|
|
3
|
-
._12l2idpf{margin-inline-end:0}
|
|
4
|
-
._12y31o36{outline-width:medium}
|
|
5
|
-
._16jlidpf{flex-grow:0}
|
|
6
|
-
._16jlkb7n{flex-grow:1}
|
|
7
|
-
._18m915vq{overflow-y:hidden}
|
|
8
|
-
._1bto1l2s{text-overflow:ellipsis}
|
|
9
|
-
._1dyz4jg8{letter-spacing:normal}
|
|
10
|
-
._1e0c1txw{display:flex}
|
|
11
|
-
._1i4q1hna{overflow-wrap:break-word}
|
|
12
|
-
._1n261q9c{flex-wrap:nowrap}
|
|
13
|
-
._1o9zidpf{flex-shrink:0}
|
|
14
|
-
._1o9zkb7n{flex-shrink:1}
|
|
15
|
-
._1pfh1ejb{margin-block-start:var(--ds-space-300,24px)}
|
|
16
|
-
._1pfhidpf{margin-block-start:0}
|
|
17
|
-
._1pfhpxbi{margin-block-start:var(--ds-space-200,1pc)}
|
|
18
|
-
._1qu2glyw{outline-style:none}
|
|
19
|
-
._1reo15vq{overflow-x:hidden}
|
|
20
|
-
._1ul9idpf{min-width:0}
|
|
21
|
-
._4cvr1y6m{align-items:flex-start}
|
|
22
|
-
._6rthpxbi{margin-block-end:var(--ds-space-200,1pc)}
|
|
23
|
-
._6rthu2gc{margin-block-end:var(--ds-space-100,8px)}
|
|
24
|
-
._ahbq1wug{margin-inline-start:auto}
|
|
25
|
-
._ahbqidpf{margin-inline-start:0}
|
|
26
|
-
._bozgxy5q{padding-inline-start:var(--ds-space-400,2pc)}
|
|
27
|
-
._i0dl1wug{flex-basis:auto}
|
|
28
|
-
._o5721q9c{white-space:nowrap}
|
|
29
|
-
._p12f1osq{max-width:100%}
|
|
30
|
-
._syazi7uo{color:var(--ds-text,#292a2e)}
|
|
@@ -1,114 +0,0 @@
|
|
|
1
|
-
/* styled.tsx generated by @compiled/babel-plugin v0.38.1 */
|
|
2
|
-
// TODO: Remove this eslint-disable when prop names have been renamed.
|
|
3
|
-
// This rule is here as prop name changes are a major as they are used
|
|
4
|
-
// by our consumers. The prop name concerned here is truncateTitle.
|
|
5
|
-
// This can be done in the next lite-mode conversion.
|
|
6
|
-
/* eslint-disable @repo/internal/react/boolean-prop-naming-convention */
|
|
7
|
-
"use strict";
|
|
8
|
-
|
|
9
|
-
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
10
|
-
Object.defineProperty(exports, "__esModule", {
|
|
11
|
-
value: true
|
|
12
|
-
});
|
|
13
|
-
exports.TitleWrapper = exports.TitleContainer = exports.StyledTitleWrapper = exports.OuterWrapper = exports.BottomBarWrapper = exports.ActionsWrapper = void 0;
|
|
14
|
-
require("./styled.compiled.css");
|
|
15
|
-
var _runtime = require("@compiled/react/runtime");
|
|
16
|
-
var _react = _interopRequireDefault(require("react"));
|
|
17
|
-
var _compiled = require("@atlaskit/primitives/compiled");
|
|
18
|
-
var styles = {
|
|
19
|
-
bottomBar: "_1pfhpxbi"
|
|
20
|
-
};
|
|
21
|
-
var truncateStyles = null;
|
|
22
|
-
var outerStyles = null;
|
|
23
|
-
var titleStyles = null;
|
|
24
|
-
var titleWrapperStyles = null;
|
|
25
|
-
var titleWrapperTruncateStyles = null;
|
|
26
|
-
var titleContainerStyles = null;
|
|
27
|
-
var actionStyles = null;
|
|
28
|
-
var titleContainerTruncateStyles = null;
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* __Outer wrapper__.
|
|
32
|
-
*
|
|
33
|
-
* An outer wrapper that is the outermost component of the PageHeader component. It wraps around the PageHeader, its Actions,
|
|
34
|
-
* the BottomBar and its Breadcrumbs.
|
|
35
|
-
*
|
|
36
|
-
*/
|
|
37
|
-
var OuterWrapper = exports.OuterWrapper = function OuterWrapper(_ref) {
|
|
38
|
-
var children = _ref.children;
|
|
39
|
-
return /*#__PURE__*/_react.default.createElement("div", {
|
|
40
|
-
className: (0, _runtime.ax)(["_6rthpxbi _1pfh1ejb _12l2idpf _ahbqidpf"])
|
|
41
|
-
}, children);
|
|
42
|
-
};
|
|
43
|
-
/**
|
|
44
|
-
* __Styled title wrapper__.
|
|
45
|
-
*
|
|
46
|
-
* A styled title wrapper is a wrapper around the title that controls its the styles exclusively.
|
|
47
|
-
*
|
|
48
|
-
*/
|
|
49
|
-
var StyledTitleWrapper = exports.StyledTitleWrapper = /*#__PURE__*/_react.default.forwardRef(function (_ref2, ref) {
|
|
50
|
-
var children = _ref2.children,
|
|
51
|
-
id = _ref2.id,
|
|
52
|
-
truncateTitle = _ref2.truncateTitle,
|
|
53
|
-
testId = _ref2.testId;
|
|
54
|
-
return /*#__PURE__*/_react.default.createElement("h1", {
|
|
55
|
-
ref: ref,
|
|
56
|
-
tabIndex: -1,
|
|
57
|
-
id: id,
|
|
58
|
-
"data-testid": testId && "".concat(testId, "--title"),
|
|
59
|
-
className: (0, _runtime.ax)(["_11c810sd _12ji1r31 _1qu2glyw _12y31o36 _syazi7uo _1dyz4jg8 _1pfhidpf", truncateTitle && "_1reo15vq _18m915vq _1bto1l2s _o5721q9c"])
|
|
60
|
-
}, children);
|
|
61
|
-
});
|
|
62
|
-
/**
|
|
63
|
-
* __Title wrapper__.
|
|
64
|
-
*
|
|
65
|
-
* A title wrapper is a wrapper around the title and the actions.
|
|
66
|
-
*
|
|
67
|
-
*/
|
|
68
|
-
var TitleWrapper = exports.TitleWrapper = function TitleWrapper(_ref3) {
|
|
69
|
-
var children = _ref3.children,
|
|
70
|
-
truncateTitle = _ref3.truncateTitle;
|
|
71
|
-
return /*#__PURE__*/_react.default.createElement("div", {
|
|
72
|
-
className: (0, _runtime.ax)(["_1e0c1txw _4cvr1y6m _1n261q9c", truncateTitle && "_1n261q9c"])
|
|
73
|
-
}, children);
|
|
74
|
-
};
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
* Title container.
|
|
78
|
-
*
|
|
79
|
-
* A title container is a container that wraps around the title and its styles (if applied).
|
|
80
|
-
*
|
|
81
|
-
*/
|
|
82
|
-
var TitleContainer = exports.TitleContainer = function TitleContainer(_ref4) {
|
|
83
|
-
var children = _ref4.children,
|
|
84
|
-
truncateTitle = _ref4.truncateTitle;
|
|
85
|
-
return /*#__PURE__*/_react.default.createElement("div", {
|
|
86
|
-
className: (0, _runtime.ax)(["_16jlkb7n _1o9zkb7n _i0dl1wug _1ul9idpf _p12f1osq _6rthu2gc _1i4q1hna", truncateTitle && "_1o9zkb7n"])
|
|
87
|
-
}, children);
|
|
88
|
-
};
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* __Actions wrapper__.
|
|
92
|
-
*
|
|
93
|
-
* An actions wrapper is a wrapper for the actions, which appear on the top right of the PageHeader component.
|
|
94
|
-
*
|
|
95
|
-
*/
|
|
96
|
-
var ActionsWrapper = exports.ActionsWrapper = function ActionsWrapper(_ref5) {
|
|
97
|
-
var children = _ref5.children;
|
|
98
|
-
return /*#__PURE__*/_react.default.createElement("div", {
|
|
99
|
-
className: (0, _runtime.ax)(["_16jlidpf _1o9zidpf _i0dl1wug _p12f1osq _6rthu2gc _ahbq1wug _bozgxy5q _o5721q9c"])
|
|
100
|
-
}, children);
|
|
101
|
-
};
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* __Bottom bar wrapper__.
|
|
105
|
-
*
|
|
106
|
-
* A bottom bar wrapper is a wrapper for the bottom bar, which appears at the bottom of the PageHeader component.
|
|
107
|
-
*
|
|
108
|
-
*/
|
|
109
|
-
var BottomBarWrapper = exports.BottomBarWrapper = function BottomBarWrapper(_ref6) {
|
|
110
|
-
var children = _ref6.children;
|
|
111
|
-
return /*#__PURE__*/_react.default.createElement(_compiled.Box, {
|
|
112
|
-
xcss: styles.bottomBar
|
|
113
|
-
}, children);
|
|
114
|
-
};
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
._11c810sd{font:var(--ds-font-heading-large,normal 653 24px/28px "Atlassian Sans",ui-sans-serif,-apple-system,BlinkMacSystemFont,"Segoe UI",Ubuntu,"Helvetica Neue",sans-serif)}
|
|
2
|
-
._12ji1r31{outline-color:currentColor}
|
|
3
|
-
._12l2idpf{margin-inline-end:0}
|
|
4
|
-
._12y31o36{outline-width:medium}
|
|
5
|
-
._16jlidpf{flex-grow:0}
|
|
6
|
-
._16jlkb7n{flex-grow:1}
|
|
7
|
-
._18m915vq{overflow-y:hidden}
|
|
8
|
-
._1bto1l2s{text-overflow:ellipsis}
|
|
9
|
-
._1dyz4jg8{letter-spacing:normal}
|
|
10
|
-
._1e0c1txw{display:flex}
|
|
11
|
-
._1i4q1hna{overflow-wrap:break-word}
|
|
12
|
-
._1n261q9c{flex-wrap:nowrap}
|
|
13
|
-
._1o9zidpf{flex-shrink:0}
|
|
14
|
-
._1o9zkb7n{flex-shrink:1}
|
|
15
|
-
._1pfh1ejb{margin-block-start:var(--ds-space-300,24px)}
|
|
16
|
-
._1pfhidpf{margin-block-start:0}
|
|
17
|
-
._1pfhpxbi{margin-block-start:var(--ds-space-200,1pc)}
|
|
18
|
-
._1qu2glyw{outline-style:none}
|
|
19
|
-
._1reo15vq{overflow-x:hidden}
|
|
20
|
-
._1ul9idpf{min-width:0}
|
|
21
|
-
._4cvr1y6m{align-items:flex-start}
|
|
22
|
-
._6rthpxbi{margin-block-end:var(--ds-space-200,1pc)}
|
|
23
|
-
._6rthu2gc{margin-block-end:var(--ds-space-100,8px)}
|
|
24
|
-
._ahbq1wug{margin-inline-start:auto}
|
|
25
|
-
._ahbqidpf{margin-inline-start:0}
|
|
26
|
-
._bozgxy5q{padding-inline-start:var(--ds-space-400,2pc)}
|
|
27
|
-
._i0dl1wug{flex-basis:auto}
|
|
28
|
-
._o5721q9c{white-space:nowrap}
|
|
29
|
-
._p12f1osq{max-width:100%}
|
|
30
|
-
._syazi7uo{color:var(--ds-text,#292a2e)}
|