@atlaskit/popper 5.5.2 → 5.5.3
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 +6 -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.5/__tests_external__/index.d.ts +1 -0
- package/dist/types-ts4.5/__tests_external__/page-objects/base-popper.d.ts +5 -0
- package/dist/types-ts4.5/__tests_external__/test-cases/popper.d.ts +2 -0
- package/dist/types-ts4.5/in-product.d.ts +1 -0
- package/dist/types-ts4.5/index.d.ts +3 -0
- package/dist/types-ts4.5/popper.d.ts +39 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { popperRendersTestCase } from './test-cases/popper';
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/// <reference types="cypress" />
|
|
2
|
+
import { InProductTestPageObject } from '@atlaskit/in-product-testing';
|
|
3
|
+
export declare class BasePopperPageObject extends InProductTestPageObject {
|
|
4
|
+
assertPopperStyle(elementSelector: keyof HTMLElementTagNameMap | string): Cypress.Chainable<JQuery<HTMLElement>>;
|
|
5
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { popperRendersTestCase } from './__tests_external__';
|
|
@@ -0,0 +1,39 @@
|
|
|
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
|
+
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;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/popper",
|
|
3
|
-
"version": "5.5.
|
|
3
|
+
"version": "5.5.3",
|
|
4
4
|
"description": "A wrapper for React Popper for situations which require a bespoke popup where other ADS components are deemed unsuitable",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|