# Mattermost Shared Package

[![npm version](https://img.shields.io/npm/v/@mattermost/shared?style=flat)](https://www.npmjs.com/package/@mattermost/shared)

This package contains shared components and other utilities for use by the Mattermost web app and its plugins.

> [!CAUTION]
> This is a pre-release package in active development. It is currently for internal use only, and it may change significantly between now and when it is fully released.

## Installation

This package requires a matching version of the `@mattermost/types` package. It also requires [React](https://react.dev/) and [React Intl](https://formatjs.github.io/docs/react-intl/).

```sh
$ npm install @mattermost/shared @mattermost/types
```

Additionally, if you're writing unit tests involving these components, [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) is also required.

```sh
$ npm install @testing-library/react
```

## Usage

TODO

## Development

### Compilation and Packaging

TODO