npm package: @robust-ui/use-image-status
Description: React hook to load images
Author: Nahuel Rosas
Latest version: 1.3.0

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Robust](#robust)
  - [Project Stats](#project-stats)
- [Installation](#installation)
  - [Usage](#usage)
  - [Features](#features)
  - [Contributing](#contributing)
  - [License](#license)
- [@robust-ui/use-image-status](#robust-uiuse-image-status)
  - [Table of contents](#table-of-contents)
    - [Type Aliases](#type-aliases)
    - [Functions](#functions)
  - [Type Aliases](#type-aliases-1)
    - [ImageErrorEvent](#imageerrorevent)
    - [ImageLoadEvent](#imageloadevent)
    - [ImageLoaderProps](#imageloaderprops)
  - [Functions](#functions-1)
    - [useImageStatus](#useimagestatus)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<a name="readmemd"></a>

@robust-ui/use-image-status / [Exports](#modulesmd)

# Robust

Robust is a system for generating React components with real-time CSS injection. It is programmed in TypeScript, providing type safety and enhanced developer experience.

## Project Stats

![Alt](https://repobeats.axiom.co/api/embed/57761159b119284992a2370b719d8f8fe9c07e34.svg "Repobeats analytics image")

# Installation

You can install Robust using either npm or pnpm. To do this, run one of the following commands:

Using npm:

```bash
npm install @robust-ui/core
```

Using pnpm:

```bash
pnpm install @robust-ui/core
```

using yarn:

```bash
yarn add @robust-ui/core
```

Alternatively, you can also download Robust from the GitHub repository and manually install the dependencies. The prepare script defined in the package.json file will automatically build all the files within the packages folder.

## Usage

To use Robust, you need to make use of the `Main` component from the `@robust-ui/nextjs-components` repository. Note that the functionality has only been tested with Next.js and may not work in other React environments.

Here's an example of how to use Robust in a Next.js application:

```tsx
import { Main, Header, Text, Icon, Flex } from "@robust-ui/nextjs-components";
import { SideMenu } from "@/components/drawer";
import type { AppProps } from "next/app";
import React from "react";

export default function App({ Component, pageProps }: AppProps) {
  const [open, setOpen] = React.useState(false);

  return (
    <Main color="white" fontFamily="Fira Code">
      <Header backgroundColor="gunMetal">
        <Flex>
          <Text fontWeight="700" fontSize="1.5rem">
            Nahuel
          </Text>
        </Flex>
        <Icon type="menu" onClick={() => setOpen(!open)} />
      </Header>
      <SideMenu open={open} setOpen={setOpen} />
      <Component {...pageProps} />
    </Main>
  );
}
```

In the above example, we import the necessary components from Robust and use them to create a basic application structure. The `Main` component sets the color and font family for the components. The `Header` component represents the application header, including a title and a menu icon that toggles the `open` state. The `SideMenu` component displays a side drawer with links and language options. Finally, we render the `Component` with the `pageProps`.

Please note that this usage example is specific to Next.js, and the functionality may not be tested or supported in other React environments. Make sure to customize the components and their properties based on your specific requirements.

## Features

Robust includes the following features:

- Automatic responsiveness: The components are designed to adapt to different screen sizes and orientations.
- Quick language switching: Easily switch between different languages using the language options provided.
- Dark mode: The system supports a dark mode theme that can be enabled or disabled.
- Global states: Robust provides mechanisms for managing global states and sharing data between components.
- Real-time CSS injection: The system injects CSS in real time, allowing for dynamic styling and theming.
- TypeScript support: Robust is programmed in TypeScript, providing type safety and enhanced developer experience.
- Customizable components: The components can be customized using various properties to suit your specific requirements.
- Easy to use: Robust is designed to be easy to use and integrate with existing React applications.
- Extensible: The system can be extended with additional components and functionality as needed.
- Well-documented: The codebase is well-documented, making it easy to understand and contribute to.
- Active development: Robust is actively developed and maintained, with regular updates and improvements.

## Contributing

Contributions to Robust are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

## License

Robust is released under the [MIT License](https://opensource.org/licenses/MIT).

---

<a name="modulesmd"></a>

[@robust-ui/use-image-status](#readmemd) / Exports

# @robust-ui/use-image-status

## Table of contents

### Type Aliases

- [ImageErrorEvent](#imageerrorevent)
- [ImageLoadEvent](#imageloadevent)
- [ImageLoaderProps](#imageloaderprops)

### Functions

- [useImageStatus](#useimagestatus)

## Type Aliases

### ImageErrorEvent

Ƭ **ImageErrorEvent**: `SyntheticEvent`\<`HTMLImageElement`, `Event`\>

Represents an error event that occurs when an image fails to load.

#### Defined in

[types.ts:12](https://github.com/nahuelRosas/robust-ui/blob/148f787/packages/hooks/use-image-status/src/types.ts#L12)

---

### ImageLoadEvent

Ƭ **ImageLoadEvent**: `SyntheticEvent`\<`HTMLImageElement`, `Event`\>

Represents an event that is triggered when an image is loaded.

**`Template`**

The type of the event target.

**`Template`**

The type of the event.

#### Defined in

[types.ts:8](https://github.com/nahuelRosas/robust-ui/blob/148f787/packages/hooks/use-image-status/src/types.ts#L8)

---

### ImageLoaderProps

Ƭ **ImageLoaderProps**: `Object`

Props for the ImageLoader component.

#### Type declaration

| Name              | Type                                                     | Description                                                   |
| :---------------- | :------------------------------------------------------- | :------------------------------------------------------------ |
| `crossOrigin?`    | `string` \| `null`                                       | -                                                             |
| `delay?`          | `number`                                                 | -                                                             |
| `ignoreFallback?` | `boolean`                                                | -                                                             |
| `onError?`        | `ReactEventHandler`\<`HTMLImageElement`\>                | -                                                             |
| `onLoad?`         | (`event`: [`ImageLoadEvent`](#imageloadevent)) => `void` | Callback function called when the image has finished loading. |
| `sizes?`          | `string`                                                 | -                                                             |
| `src?`            | `string`                                                 | -                                                             |
| `srcSet?`         | \{ `size`: `string` ; `url`: `string` }[]                | -                                                             |

#### Defined in

[types.ts:17](https://github.com/nahuelRosas/robust-ui/blob/148f787/packages/hooks/use-image-status/src/types.ts#L17)

## Functions

### useImageStatus

▸ **useImageStatus**(`options`): `"failed"` \| `"loaded"` \| `"loading"` \| `"pending"`

Custom hook that tracks the loading status of an image.

#### Parameters

| Name      | Type                                    | Description                       |
| :-------- | :-------------------------------------- | :-------------------------------- |
| `options` | [`ImageLoaderProps`](#imageloaderprops) | The options for the image loader. |

#### Returns

`"failed"` \| `"loaded"` \| `"loading"` \| `"pending"`

The current status of the image loading process.

#### Defined in

[index.ts:18](https://github.com/nahuelRosas/robust-ui/blob/148f787/packages/hooks/use-image-status/src/index.ts#L18)