@atlaskit/inline-dialog
Version:
An inline dialog is a pop-up container for small amounts of information. It can also contain controls.
95 lines (78 loc) • 2.05 kB
Markdown
<!-- API Report Version: 2.3 -->
> 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)
- [Main Entry Types](
- [Peer Dependencies](
<!--SECTION START: Main Entry Types-->
```ts
import { default as React_2 } from 'react';
import { ReactNode } from 'react';
import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
import { WithContextProps } from '@atlaskit/analytics-next';
// @public (undocumented)
const _default: React_2.ForwardRefExoticComponent<
Pick<
Omit<React_2.PropsWithChildren<InlineDialogProps>, keyof WithAnalyticsEventsProps> &
React_2.RefAttributes<any> &
WithContextProps,
| 'analyticsContext'
| 'children'
| 'content'
| 'isOpen'
| 'key'
| 'onClose'
| 'onContentBlur'
| 'onContentClick'
| 'onContentFocus'
| 'placement'
| 'strategy'
| 'testId'
> &
React_2.RefAttributes<any>
>;
export default _default;
// @public (undocumented)
interface InlineDialogProps extends WithAnalyticsEventsProps {
children: ReactNode;
content: ReactNode;
isOpen?: boolean;
onClose?: (obj: { isOpen: boolean; event: Event }) => void;
onContentBlur?: () => void;
onContentClick?: () => void;
onContentFocus?: () => void;
placement?: Placement;
strategy?: 'absolute' | 'fixed';
testId?: string;
}
// @public (undocumented)
export type Placement =
| 'auto'
| 'auto-end'
| 'auto-start'
| 'bottom'
| 'bottom-end'
| 'bottom-start'
| 'left'
| 'left-end'
| 'left-start'
| 'right'
| 'right-end'
| 'right-start'
| 'top'
| 'top-end'
| 'top-start';
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0"
}
```
<!--SECTION END: Peer Dependencies-->