@atlaskit/editor-plugin-connectivity/README.md

Connectivity plugin for @atlaskit/editor-core

# Editor Plugin Connectivity

Connectivity plugin for @atlaskit/editor-core

**Note:** This component is designed for internal Atlassian development.
External contributors will be able to use this component but will not be able to submit issues.

## Overview

The Connectivity plugin provides online and offline connectivity detection and management for the Atlassian Editor. It tracks network connectivity status using browser events and exposes commands to override or customize the connectivity mode.

## Key features

- **Automatic connectivity detection** - Monitors network status using browser online/offline events
- **Multiple connectivity modes** - Supports online, offline, collab-offline, and internet-offline modes
- **Custom mode override** - Programmatically set connectivity mode via the setMode command
- **Shared state access** - Provides current connectivity mode through plugin shared state
- **Mode helper utility** - Includes isOfflineMode utility for checking offline states

## Install

- **Install** - *yarn add @atlaskit/editor-plugin-connectivity*
- **npm** - [@atlaskit/editor-plugin-connectivity](https://www.npmjs.com/package/@atlaskit/editor-plugin-connectivity)
- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-connectivity)
- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-connectivity/dist/)

## Usage

**Internal use only**

@atlaskit/editor-plugin-connectivity is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.

Direct use of this component is not supported.

Please see [Atlaskit - Editor plugin connectivity](https://atlaskit.atlassian.com/packages/editor/editor-plugin-connectivity) for documentation and examples for this package.

## Support

For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.

## License

Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.