@hyperlane-xyz/widgets/README.md

Common react components for Hyperlane projects

# Hyperlane Widgets

Common react components for projects using Hyperlane.

## Installation

```sh
# Install with npm
npm install @hyperlane-xyz/widgets

# Or install with yarn
yarn add @hyperlane-xyz/widgets
```

### Peer dependencies

This package requires `@hyperlane-xyz/sdk`, `react`, and `react-dom`.

## Contents

### Components

- `ChainLogo`: A logo icon for a given chain ID
- `MessageTimeline`: A timeline showing stages of message delivery
- `WideChevron`: A customizable version of Hyperlane's chevron logo

### Hooks

- `useMessage`: Fetch data about a message from the Hyperlane Explorer
- `useMessageStage`: Fetch and compute message delivery stage and timings
- `useMessageTimeline`: Fetch message data for use with `MessageTimeline`

## Learn more

For more information, see the [Hyperlane documentation](https://docs.hyperlane.xyz/docs/intro).