@atlaskit/popper/report.api.md

A wrapper for React Popper for situations which require a bespoke popup where other ADS components are deemed unsuitable

<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/popper"

> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)

### Table of contents

- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)

### Main Entry Types

<!--SECTION START: Main Entry Types-->

```ts
import { Manager } from 'react-popper';
import { ManagerProps } from 'react-popper';
import { Modifier } from 'react-popper';
import { Placement } from '@popperjs/core';
import { placements } from '@popperjs/core';
import { PopperArrowProps } from 'react-popper';
import { PopperChildrenProps } from 'react-popper';
import { PopperProps } from 'react-popper';
import { default as React_2 } from 'react';
import { Reference } from 'react-popper';
import { ReferenceProps } from 'react-popper';
import { StrictModifier } from 'react-popper';
import { VirtualElement } from '@popperjs/core';

// @public (undocumented)
interface CustomPopperProps<Modifiers> {
	children?: (childrenProps: PopperChildrenProps) => React_2.ReactNode;
	modifiers?: PopperProps<Modifiers>['modifiers'];
	offset?: Offset;
	placement?: Placement;
	referenceElement?: HTMLElement | VirtualElement;
	strategy?: PopperProps<Modifiers>['strategy'];
}

export { Manager };

export { ManagerProps };

export { Modifier };

// @public (undocumented)
type Offset = [null | number | undefined, null | number | undefined];

export { Placement };

export { placements };

// @public (undocumented)
export function Popper<CustomModifiers>({
	children,
	offset,
	placement,
	referenceElement,
	modifiers,
	strategy,
}: CustomPopperProps<CustomModifiers>): JSX.Element;

export { PopperArrowProps };

export { PopperChildrenProps };

export { PopperProps };

export { Reference };

export { ReferenceProps };

export { StrictModifier };

// (No @packageDocumentation comment for this package)
```

<!--SECTION END: Main Entry Types-->

### Peer Dependencies

<!--SECTION START: Peer Dependencies-->

```json
{
	"react": "^16.8.0"
}
```

<!--SECTION END: Peer Dependencies-->