@atlaskit/mobile-header 5.0.10 → 5.0.12
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/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/dist/types-ts4.0/components/MobileHeader.d.ts +35 -0
- package/dist/types-ts4.0/index.d.ts +1 -0
- package/dist/types-ts4.0/styled.d.ts +18 -0
- package/package.json +12 -5
- package/report.api.md +53 -23
- package/styled/package.json +8 -1
- package/tmp/api-report-tmp.d.ts +72 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# @atlaskit/mobile-header
|
|
2
2
|
|
|
3
|
+
## 5.0.12
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`522a27e6119`](https://bitbucket.org/atlassian/atlassian-frontend/commits/522a27e6119) - Remove `isOpen` prop from @atlaskit/banner, it is now open by default.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
|
|
10
|
+
## 5.0.11
|
|
11
|
+
|
|
12
|
+
### Patch Changes
|
|
13
|
+
|
|
14
|
+
- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
|
|
15
|
+
|
|
3
16
|
## 5.0.10
|
|
4
17
|
|
|
5
18
|
### Patch Changes
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import React, { PureComponent, ReactNode } from 'react';
|
|
2
|
+
interface MobileHeaderProps {
|
|
3
|
+
navigation?: (isOpen: boolean) => ReactNode;
|
|
4
|
+
sidebar?: (isOpen: boolean) => ReactNode;
|
|
5
|
+
onNavigationOpen?: () => void;
|
|
6
|
+
onDrawerClose?: () => void;
|
|
7
|
+
drawerState: 'navigation' | 'sidebar' | 'none' | string;
|
|
8
|
+
secondaryContent?: ReactNode;
|
|
9
|
+
pageHeading: ReactNode;
|
|
10
|
+
menuIconLabel: string;
|
|
11
|
+
customMenu?: ReactNode;
|
|
12
|
+
topOffset?: number;
|
|
13
|
+
}
|
|
14
|
+
interface MobileHeaderState {
|
|
15
|
+
isAnimatingSidebar: boolean;
|
|
16
|
+
isAnimatingNavigation: boolean;
|
|
17
|
+
}
|
|
18
|
+
declare class MobileHeader extends PureComponent<MobileHeaderProps, MobileHeaderState> {
|
|
19
|
+
state: {
|
|
20
|
+
isAnimatingNavigation: boolean;
|
|
21
|
+
isAnimatingSidebar: boolean;
|
|
22
|
+
};
|
|
23
|
+
static defaultProps: {
|
|
24
|
+
topOffset: number;
|
|
25
|
+
pageHeading: string;
|
|
26
|
+
menuIconLabel: string;
|
|
27
|
+
drawerState: string;
|
|
28
|
+
};
|
|
29
|
+
UNSAFE_componentWillReceiveProps(nextProps: MobileHeaderProps): void;
|
|
30
|
+
handleNavSlideFinish: () => void;
|
|
31
|
+
handleSidebarSlideFinish: () => void;
|
|
32
|
+
renderSlider: (isOpen: boolean, isAnimating: boolean, onTransitionEnd: ((event: React.TransitionEvent<HTMLDivElement>) => void) | undefined, side: string, renderFn?: ((isOpen: boolean) => ReactNode) | undefined, topOffset?: number | undefined) => JSX.Element;
|
|
33
|
+
render(): JSX.Element;
|
|
34
|
+
}
|
|
35
|
+
export default MobileHeader;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { default } from './components/MobileHeader';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
export declare const MobileNavSlider: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & {
|
|
3
|
+
topOffset: number | undefined;
|
|
4
|
+
isOpen: boolean;
|
|
5
|
+
side: string;
|
|
6
|
+
}, any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & {
|
|
7
|
+
topOffset: number | undefined;
|
|
8
|
+
isOpen: boolean;
|
|
9
|
+
side: string;
|
|
10
|
+
}>;
|
|
11
|
+
export declare const MobilePageHeader: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLElement> & import("react").HTMLAttributes<HTMLElement>, any, import("react").ClassAttributes<HTMLElement> & import("react").HTMLAttributes<HTMLElement>>;
|
|
12
|
+
export declare const MobilePageHeaderContent: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & (import("@atlaskit/theme").ThemeProps | undefined), any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & (import("@atlaskit/theme").ThemeProps | undefined)>;
|
|
13
|
+
export declare const FakeBlanket: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & {
|
|
14
|
+
isOpen: boolean;
|
|
15
|
+
}, any, import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement> & {
|
|
16
|
+
isOpen: boolean;
|
|
17
|
+
}>;
|
|
18
|
+
export declare const PageHeading: import("styled-components").StyledComponentClass<import("react").ClassAttributes<HTMLHeadingElement> & import("react").HTMLAttributes<HTMLHeadingElement> & (import("@atlaskit/theme").ThemeProps | undefined), any, import("react").ClassAttributes<HTMLHeadingElement> & import("react").HTMLAttributes<HTMLHeadingElement> & (import("@atlaskit/theme").ThemeProps | undefined)>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/mobile-header",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.12",
|
|
4
4
|
"description": "A React component rendering a mobile header",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -12,6 +12,13 @@
|
|
|
12
12
|
"module": "dist/esm/index.js",
|
|
13
13
|
"module:es2019": "dist/es2019/index.js",
|
|
14
14
|
"types": "dist/types/index.d.ts",
|
|
15
|
+
"typesVersions": {
|
|
16
|
+
">=4.0 <4.5": {
|
|
17
|
+
"*": [
|
|
18
|
+
"dist/types-ts4.0/*"
|
|
19
|
+
]
|
|
20
|
+
}
|
|
21
|
+
},
|
|
15
22
|
"atlaskit:src": "src/index.ts",
|
|
16
23
|
"atlassian": {
|
|
17
24
|
"team": "Bitbucket: CoreX",
|
|
@@ -23,8 +30,8 @@
|
|
|
23
30
|
},
|
|
24
31
|
"dependencies": {
|
|
25
32
|
"@atlaskit/button": "^16.3.0",
|
|
26
|
-
"@atlaskit/icon": "^21.
|
|
27
|
-
"@atlaskit/theme": "^12.
|
|
33
|
+
"@atlaskit/icon": "^21.11.0",
|
|
34
|
+
"@atlaskit/theme": "^12.2.0",
|
|
28
35
|
"@babel/runtime": "^7.0.0"
|
|
29
36
|
},
|
|
30
37
|
"peerDependencies": {
|
|
@@ -32,14 +39,14 @@
|
|
|
32
39
|
"styled-components": "^3.2.6"
|
|
33
40
|
},
|
|
34
41
|
"devDependencies": {
|
|
35
|
-
"@atlaskit/banner": "^
|
|
42
|
+
"@atlaskit/banner": "^12.0.0",
|
|
36
43
|
"@atlaskit/docs": "*",
|
|
37
44
|
"@atlaskit/navigation": "^37.0.0",
|
|
38
45
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|
|
39
46
|
"enzyme": "^3.10.0",
|
|
40
47
|
"react-dom": "^16.8.0",
|
|
41
48
|
"react-test-renderer": "^16.8.0",
|
|
42
|
-
"typescript": "4.
|
|
49
|
+
"typescript": "4.5.5"
|
|
43
50
|
},
|
|
44
51
|
"techstack": {
|
|
45
52
|
"@atlassian/frontend": {
|
package/report.api.md
CHANGED
|
@@ -1,31 +1,39 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- API Report Version: 2.2 -->
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## API Report File for "@atlaskit/mobile-header"
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
|
|
6
|
+
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
7
|
+
|
|
8
|
+
### Table of contents
|
|
9
|
+
|
|
10
|
+
- [Main Entry Types](#main-entry-types)
|
|
11
|
+
|
|
12
|
+
### Main Entry Types
|
|
13
|
+
|
|
14
|
+
<!--SECTION START: Main Entry Types-->
|
|
6
15
|
|
|
7
16
|
```ts
|
|
8
17
|
import { PureComponent } from 'react';
|
|
9
18
|
import { default as React_2 } from 'react';
|
|
10
19
|
import { ReactNode } from 'react';
|
|
11
20
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
> {
|
|
16
|
-
state: {
|
|
17
|
-
isAnimatingNavigation: boolean;
|
|
18
|
-
isAnimatingSidebar: boolean;
|
|
19
|
-
};
|
|
21
|
+
// @public (undocumented)
|
|
22
|
+
class MobileHeader extends PureComponent<MobileHeaderProps, MobileHeaderState> {
|
|
23
|
+
// (undocumented)
|
|
20
24
|
static defaultProps: {
|
|
21
25
|
topOffset: number;
|
|
22
26
|
pageHeading: string;
|
|
23
27
|
menuIconLabel: string;
|
|
24
28
|
drawerState: string;
|
|
25
29
|
};
|
|
26
|
-
|
|
30
|
+
// (undocumented)
|
|
27
31
|
handleNavSlideFinish: () => void;
|
|
32
|
+
// (undocumented)
|
|
28
33
|
handleSidebarSlideFinish: () => void;
|
|
34
|
+
// (undocumented)
|
|
35
|
+
render(): JSX.Element;
|
|
36
|
+
// (undocumented)
|
|
29
37
|
renderSlider: (
|
|
30
38
|
isOpen: boolean,
|
|
31
39
|
isAnimating: boolean,
|
|
@@ -36,27 +44,49 @@ declare class MobileHeader extends PureComponent<
|
|
|
36
44
|
renderFn?: ((isOpen: boolean) => ReactNode) | undefined,
|
|
37
45
|
topOffset?: number | undefined,
|
|
38
46
|
) => JSX.Element;
|
|
39
|
-
|
|
47
|
+
// (undocumented)
|
|
48
|
+
state: {
|
|
49
|
+
isAnimatingNavigation: boolean;
|
|
50
|
+
isAnimatingSidebar: boolean;
|
|
51
|
+
};
|
|
52
|
+
// (undocumented)
|
|
53
|
+
UNSAFE_componentWillReceiveProps(nextProps: MobileHeaderProps): void;
|
|
40
54
|
}
|
|
41
55
|
export default MobileHeader;
|
|
42
56
|
|
|
43
|
-
|
|
57
|
+
// @public (undocumented)
|
|
58
|
+
interface MobileHeaderProps {
|
|
59
|
+
// (undocumented)
|
|
60
|
+
customMenu?: ReactNode;
|
|
61
|
+
// (undocumented)
|
|
62
|
+
drawerState: 'navigation' | 'none' | 'sidebar' | string;
|
|
63
|
+
// (undocumented)
|
|
64
|
+
menuIconLabel: string;
|
|
65
|
+
// (undocumented)
|
|
44
66
|
navigation?: (isOpen: boolean) => ReactNode;
|
|
45
|
-
|
|
46
|
-
onNavigationOpen?: () => void;
|
|
67
|
+
// (undocumented)
|
|
47
68
|
onDrawerClose?: () => void;
|
|
48
|
-
|
|
49
|
-
|
|
69
|
+
// (undocumented)
|
|
70
|
+
onNavigationOpen?: () => void;
|
|
71
|
+
// (undocumented)
|
|
50
72
|
pageHeading: ReactNode;
|
|
51
|
-
|
|
52
|
-
|
|
73
|
+
// (undocumented)
|
|
74
|
+
secondaryContent?: ReactNode;
|
|
75
|
+
// (undocumented)
|
|
76
|
+
sidebar?: (isOpen: boolean) => ReactNode;
|
|
77
|
+
// (undocumented)
|
|
53
78
|
topOffset?: number;
|
|
54
79
|
}
|
|
55
80
|
|
|
56
|
-
|
|
57
|
-
|
|
81
|
+
// @public (undocumented)
|
|
82
|
+
interface MobileHeaderState {
|
|
83
|
+
// (undocumented)
|
|
58
84
|
isAnimatingNavigation: boolean;
|
|
85
|
+
// (undocumented)
|
|
86
|
+
isAnimatingSidebar: boolean;
|
|
59
87
|
}
|
|
60
88
|
|
|
61
|
-
|
|
89
|
+
// (No @packageDocumentation comment for this package)
|
|
62
90
|
```
|
|
91
|
+
|
|
92
|
+
<!--SECTION END: Main Entry Types-->
|
package/styled/package.json
CHANGED
|
@@ -3,5 +3,12 @@
|
|
|
3
3
|
"main": "../dist/cjs/styled.js",
|
|
4
4
|
"module": "../dist/esm/styled.js",
|
|
5
5
|
"module:es2019": "../dist/es2019/styled.js",
|
|
6
|
-
"types": "../dist/types/styled.d.ts"
|
|
6
|
+
"types": "../dist/types/styled.d.ts",
|
|
7
|
+
"typesVersions": {
|
|
8
|
+
">=4.0 <4.5": {
|
|
9
|
+
"*": [
|
|
10
|
+
"../dist/types-ts4.0/styled.d.ts"
|
|
11
|
+
]
|
|
12
|
+
}
|
|
13
|
+
}
|
|
7
14
|
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/mobile-header"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { PureComponent } from 'react';
|
|
8
|
+
import { default as React_2 } from 'react';
|
|
9
|
+
import { ReactNode } from 'react';
|
|
10
|
+
|
|
11
|
+
// @public (undocumented)
|
|
12
|
+
class MobileHeader extends PureComponent<MobileHeaderProps, MobileHeaderState> {
|
|
13
|
+
// (undocumented)
|
|
14
|
+
static defaultProps: {
|
|
15
|
+
topOffset: number;
|
|
16
|
+
pageHeading: string;
|
|
17
|
+
menuIconLabel: string;
|
|
18
|
+
drawerState: string;
|
|
19
|
+
};
|
|
20
|
+
// (undocumented)
|
|
21
|
+
handleNavSlideFinish: () => void;
|
|
22
|
+
// (undocumented)
|
|
23
|
+
handleSidebarSlideFinish: () => void;
|
|
24
|
+
// (undocumented)
|
|
25
|
+
render(): JSX.Element;
|
|
26
|
+
// (undocumented)
|
|
27
|
+
renderSlider: (isOpen: boolean, isAnimating: boolean, onTransitionEnd: ((event: React_2.TransitionEvent<HTMLDivElement>) => void) | undefined, side: string, renderFn?: ((isOpen: boolean) => ReactNode) | undefined, topOffset?: number | undefined) => JSX.Element;
|
|
28
|
+
// (undocumented)
|
|
29
|
+
state: {
|
|
30
|
+
isAnimatingNavigation: boolean;
|
|
31
|
+
isAnimatingSidebar: boolean;
|
|
32
|
+
};
|
|
33
|
+
// (undocumented)
|
|
34
|
+
UNSAFE_componentWillReceiveProps(nextProps: MobileHeaderProps): void;
|
|
35
|
+
}
|
|
36
|
+
export default MobileHeader;
|
|
37
|
+
|
|
38
|
+
// @public (undocumented)
|
|
39
|
+
interface MobileHeaderProps {
|
|
40
|
+
// (undocumented)
|
|
41
|
+
customMenu?: ReactNode;
|
|
42
|
+
// (undocumented)
|
|
43
|
+
drawerState: 'navigation' | 'none' | 'sidebar' | string;
|
|
44
|
+
// (undocumented)
|
|
45
|
+
menuIconLabel: string;
|
|
46
|
+
// (undocumented)
|
|
47
|
+
navigation?: (isOpen: boolean) => ReactNode;
|
|
48
|
+
// (undocumented)
|
|
49
|
+
onDrawerClose?: () => void;
|
|
50
|
+
// (undocumented)
|
|
51
|
+
onNavigationOpen?: () => void;
|
|
52
|
+
// (undocumented)
|
|
53
|
+
pageHeading: ReactNode;
|
|
54
|
+
// (undocumented)
|
|
55
|
+
secondaryContent?: ReactNode;
|
|
56
|
+
// (undocumented)
|
|
57
|
+
sidebar?: (isOpen: boolean) => ReactNode;
|
|
58
|
+
// (undocumented)
|
|
59
|
+
topOffset?: number;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
// @public (undocumented)
|
|
63
|
+
interface MobileHeaderState {
|
|
64
|
+
// (undocumented)
|
|
65
|
+
isAnimatingNavigation: boolean;
|
|
66
|
+
// (undocumented)
|
|
67
|
+
isAnimatingSidebar: boolean;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// (No @packageDocumentation comment for this package)
|
|
71
|
+
|
|
72
|
+
```
|