@atlaskit/inline-message/report.api.md

An inline message lets users know when important information is available or when an action is required.

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

## API Report File for "@atlaskit/inline-message"

> 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 { FC } from 'react';
import { ReactNode } from 'react';

// @public (undocumented)
type IconAppearance = 'confirmation' | 'connectivity' | 'error' | 'info' | 'warning';

// @public (undocumented)
type InlineDialogPlacement =
	| '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';

// @public
const InlineMessage: FC<InlineMessageProps>;
export default InlineMessage;

// @public (undocumented)
interface InlineMessageProps {
	appearance?: IconAppearance;
	children?: ReactNode;
	iconLabel?: string;
	placement?: InlineDialogPlacement;
	secondaryText?: ReactNode;
	testId?: string;
	title?: ReactNode;
	// @deprecated (undocumented)
	type?: IconAppearance;
}

// (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-->