@atlaskit/popper 5.2.10 → 5.2.11
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 +11 -0
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/package.json +7 -13
- package/report.api.md +22 -28
- package/tmp/api-report-tmp.d.ts +61 -0
- package/dist/types-ts4.0/index.d.ts +0 -3
- package/dist/types-ts4.0/popper.d.ts +0 -39
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @atlaskit/popper
|
|
2
2
|
|
|
3
|
+
## 5.2.11
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`dc53dc3201b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/dc53dc3201b) - Add 'productPushConsumption' as a new optional field in package.json.
|
|
8
|
+
|
|
9
|
+
_Note_:
|
|
10
|
+
We want to track the information if the package was moved from the pull into the push model in the product.
|
|
11
|
+
Hence, we extended the `package.json` file by adding a new field e.g.: "atlassian.productPushConsumption": ["jira"]
|
|
12
|
+
This field is optional.
|
|
13
|
+
|
|
3
14
|
## 5.2.10
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/popper",
|
|
3
|
-
"version": "5.2.
|
|
3
|
+
"version": "5.2.11",
|
|
4
4
|
"description": "Wrapper for react-popper with common config and some helpers",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -12,20 +12,14 @@
|
|
|
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
|
-
"dist/types-ts4.0/index.d.ts"
|
|
20
|
-
]
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
15
|
"sideEffects": false,
|
|
24
16
|
"atlaskit:src": "src/index.tsx",
|
|
25
17
|
"atlassian": {
|
|
26
|
-
"
|
|
27
|
-
"
|
|
28
|
-
"
|
|
18
|
+
"team": "UIP: Cycle Time Flex",
|
|
19
|
+
"releaseModel": "continuous",
|
|
20
|
+
"productPushConsumption": [
|
|
21
|
+
"jira"
|
|
22
|
+
],
|
|
29
23
|
"website": {
|
|
30
24
|
"name": "Popper",
|
|
31
25
|
"category": "Components"
|
|
@@ -44,7 +38,7 @@
|
|
|
44
38
|
"react": "^16.8.0"
|
|
45
39
|
},
|
|
46
40
|
"devDependencies": {
|
|
47
|
-
"@atlaskit/button": "^16.
|
|
41
|
+
"@atlaskit/button": "^16.4.0",
|
|
48
42
|
"@atlaskit/docs": "*",
|
|
49
43
|
"@atlaskit/ds-lib": "^2.1.0",
|
|
50
44
|
"@atlaskit/ssr": "*",
|
package/report.api.md
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- API Report Version: 2.3 -->
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## API Report File for "@atlaskit/popper"
|
|
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 { Manager } from 'react-popper';
|
|
@@ -19,32 +28,13 @@ import { ReferenceProps } from 'react-popper';
|
|
|
19
28
|
import { StrictModifier } from 'react-popper';
|
|
20
29
|
import { VirtualElement } from '@popperjs/core';
|
|
21
30
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
* Returns the element to be positioned.
|
|
25
|
-
*/
|
|
31
|
+
// @public (undocumented)
|
|
32
|
+
interface CustomPopperProps<Modifiers> {
|
|
26
33
|
children?: (childrenProps: PopperChildrenProps) => React_2.ReactNode;
|
|
27
|
-
|
|
28
|
-
* Distance the popup should be offset from the reference in the format of [along, away] (units in px).
|
|
29
|
-
* Defaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified
|
|
30
|
-
* by the `placement` prop.
|
|
31
|
-
*/
|
|
34
|
+
modifiers?: PopperProps<Modifiers>['modifiers'];
|
|
32
35
|
offset?: Offset;
|
|
33
|
-
/**
|
|
34
|
-
* Which side of the Reference to show on.
|
|
35
|
-
*/
|
|
36
36
|
placement?: Placement;
|
|
37
|
-
/**
|
|
38
|
-
* Replacement reference element to position popper relative to.
|
|
39
|
-
*/
|
|
40
37
|
referenceElement?: HTMLElement | VirtualElement;
|
|
41
|
-
/**
|
|
42
|
-
* Additional modifiers and modifier overwrites.
|
|
43
|
-
*/
|
|
44
|
-
modifiers?: PopperProps<Modifiers>['modifiers'];
|
|
45
|
-
/**
|
|
46
|
-
* Placement strategy used. Can be 'fixed' or 'absolute'
|
|
47
|
-
*/
|
|
48
38
|
strategy?: PopperProps<Modifiers>['strategy'];
|
|
49
39
|
}
|
|
50
40
|
|
|
@@ -54,13 +44,15 @@ export { ManagerProps };
|
|
|
54
44
|
|
|
55
45
|
export { Modifier };
|
|
56
46
|
|
|
57
|
-
|
|
47
|
+
// @public (undocumented)
|
|
48
|
+
type Offset = [null | number | undefined, null | number | undefined];
|
|
58
49
|
|
|
59
50
|
export { Placement };
|
|
60
51
|
|
|
61
52
|
export { placements };
|
|
62
53
|
|
|
63
|
-
|
|
54
|
+
// @public (undocumented)
|
|
55
|
+
export function Popper<CustomModifiers>({
|
|
64
56
|
children,
|
|
65
57
|
offset,
|
|
66
58
|
placement,
|
|
@@ -81,5 +73,7 @@ export { ReferenceProps };
|
|
|
81
73
|
|
|
82
74
|
export { StrictModifier };
|
|
83
75
|
|
|
84
|
-
|
|
76
|
+
// (No @packageDocumentation comment for this package)
|
|
85
77
|
```
|
|
78
|
+
|
|
79
|
+
<!--SECTION END: Main Entry Types-->
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/popper"
|
|
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 { Manager } from 'react-popper';
|
|
8
|
+
import { ManagerProps } from 'react-popper';
|
|
9
|
+
import { Modifier } from 'react-popper';
|
|
10
|
+
import { Placement } from '@popperjs/core';
|
|
11
|
+
import { placements } from '@popperjs/core';
|
|
12
|
+
import { PopperArrowProps } from 'react-popper';
|
|
13
|
+
import { PopperChildrenProps } from 'react-popper';
|
|
14
|
+
import { PopperProps } from 'react-popper';
|
|
15
|
+
import { default as React_2 } from 'react';
|
|
16
|
+
import { Reference } from 'react-popper';
|
|
17
|
+
import { ReferenceProps } from 'react-popper';
|
|
18
|
+
import { StrictModifier } from 'react-popper';
|
|
19
|
+
import { VirtualElement } from '@popperjs/core';
|
|
20
|
+
|
|
21
|
+
// @public (undocumented)
|
|
22
|
+
interface CustomPopperProps<Modifiers> {
|
|
23
|
+
children?: (childrenProps: PopperChildrenProps) => React_2.ReactNode;
|
|
24
|
+
modifiers?: PopperProps<Modifiers>['modifiers'];
|
|
25
|
+
offset?: Offset;
|
|
26
|
+
placement?: Placement;
|
|
27
|
+
referenceElement?: HTMLElement | VirtualElement;
|
|
28
|
+
strategy?: PopperProps<Modifiers>['strategy'];
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export { Manager }
|
|
32
|
+
|
|
33
|
+
export { ManagerProps }
|
|
34
|
+
|
|
35
|
+
export { Modifier }
|
|
36
|
+
|
|
37
|
+
// @public (undocumented)
|
|
38
|
+
type Offset = [null | number | undefined, null | number | undefined];
|
|
39
|
+
|
|
40
|
+
export { Placement }
|
|
41
|
+
|
|
42
|
+
export { placements }
|
|
43
|
+
|
|
44
|
+
// @public (undocumented)
|
|
45
|
+
export function Popper<CustomModifiers>({ children, offset, placement, referenceElement, modifiers, strategy, }: CustomPopperProps<CustomModifiers>): JSX.Element;
|
|
46
|
+
|
|
47
|
+
export { PopperArrowProps }
|
|
48
|
+
|
|
49
|
+
export { PopperChildrenProps }
|
|
50
|
+
|
|
51
|
+
export { PopperProps }
|
|
52
|
+
|
|
53
|
+
export { Reference }
|
|
54
|
+
|
|
55
|
+
export { ReferenceProps }
|
|
56
|
+
|
|
57
|
+
export { StrictModifier }
|
|
58
|
+
|
|
59
|
+
// (No @packageDocumentation comment for this package)
|
|
60
|
+
|
|
61
|
+
```
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import { Placement, VirtualElement } from '@popperjs/core';
|
|
3
|
-
import { PopperChildrenProps, PopperProps } from 'react-popper';
|
|
4
|
-
export { placements } from '@popperjs/core';
|
|
5
|
-
export type { Placement, VirtualElement } from '@popperjs/core';
|
|
6
|
-
export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, } from 'react-popper';
|
|
7
|
-
declare type Offset = [
|
|
8
|
-
number | null | undefined,
|
|
9
|
-
number | null | undefined
|
|
10
|
-
];
|
|
11
|
-
export interface CustomPopperProps<Modifiers> {
|
|
12
|
-
/**
|
|
13
|
-
* Returns the element to be positioned.
|
|
14
|
-
*/
|
|
15
|
-
children?: (childrenProps: PopperChildrenProps) => React.ReactNode;
|
|
16
|
-
/**
|
|
17
|
-
* Distance the popup should be offset from the reference in the format of [along, away] (units in px).
|
|
18
|
-
* Defaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified
|
|
19
|
-
* by the `placement` prop.
|
|
20
|
-
*/
|
|
21
|
-
offset?: Offset;
|
|
22
|
-
/**
|
|
23
|
-
* Which side of the Reference to show on.
|
|
24
|
-
*/
|
|
25
|
-
placement?: Placement;
|
|
26
|
-
/**
|
|
27
|
-
* Replacement reference element to position popper relative to.
|
|
28
|
-
*/
|
|
29
|
-
referenceElement?: HTMLElement | VirtualElement;
|
|
30
|
-
/**
|
|
31
|
-
* Additional modifiers and modifier overwrites.
|
|
32
|
-
*/
|
|
33
|
-
modifiers?: PopperProps<Modifiers>['modifiers'];
|
|
34
|
-
/**
|
|
35
|
-
* Placement strategy used. Can be 'fixed' or 'absolute'
|
|
36
|
-
*/
|
|
37
|
-
strategy?: PopperProps<Modifiers>['strategy'];
|
|
38
|
-
}
|
|
39
|
-
export declare function Popper<CustomModifiers>({ children, offset, placement, referenceElement, modifiers, strategy, }: CustomPopperProps<CustomModifiers>): JSX.Element;
|