npm package: @ilo-org/brand-assets
Description: Brand assets from ILO's Design System
Latest version: 1.0.1

# ILO Design System - Brand Assets

Static brand assets for use in digital and software products using the ILO Design System.

## Installation

```bash
npm i @ilo-org/brand-assets
```

## Basic Usage

### 1. Import the image directly

This assumes that you're using a module bundler like [Webpack](https://webpack.js.org/) that will allow you to import the image into a JavaScript file and then include it in a production bundle where the import will be interpolated into a file path.

In this example, we're importing a logo from the from `@ilo-org/brand-assets` package and providing it to a [React](https://www.reactjs.com) component.

```jsx
import ilo_logo from "@ilo-org/brand-assets/logo_en_horizontal_blue.svg";

export const Logo = (props) => <img src={ilo_logo} {...props} />;
```

If you're using [Next.js](https://nextjs.org/), you should use its [`next/image`](https://nextjs.org/docs/api-reference/next/image) component to do this.

### 2. Import the image URL

```jsx
import { logo_en_horizontal_blue } from "@ilo-org/brand-assets";

export const Logo = (props) => <img src={logo_en_horizontal_blue} {...props} />;
```

This will give you a [URL object](https://developer.mozilla.org/en-US/docs/Web/API/URL) with normalized path to the file's location in the package. This is the easiest solution if you're able to serve them directly from the `node_modules` folder.

Conversely, it will not work in build systems that wont't serve assets from `node_modules` and that need to bundle them directly.

## List of Assets

Additional assets will be added to this package in future versions.

### ILO Logo

| Image                                                               | Language   | Filetype | Exported as                    | Filename                       |
| ------------------------------------------------------------------- | ---------- | -------- | ------------------------------ | ------------------------------ |
| <img src="./src/assets/logo_en_horizontal_blue.png" width="200" />  | English    | png      | `logo_en_horizontal_blue_png`  | `logo_en_horizontal_blue.png`  |
| <img src="./src/assets/logo_en_horizontal_blue.svg" width="200" />  | English    | svg      | `logo_en_horizontal_blue_svg`  | `logo_en_horizontal_blue.svg`  |
| <img src="./src/assets/logo_en_horizontal_white.png" width="200" /> | English    | png      | `logo_en_horizontal_white_png` | `logo_en_horizontal_white.png` |
| <img src="./src/assets/logo_en_horizontal_white.svg" width="200" /> | English    | svg      | `logo_en_horizontal_white_svg` | `logo_en_horizontal_white.svg` |
| <img src="./src/assets/logo_fr_horizontal_blue.png" width="200" />  | French     | png      | `logo_fr_horizontal_blue_png`  | `logo_fr_horizontal_blue.png`  |
| <img src="./src/assets/logo_fr_horizontal_blue.svg" width="200" />  | French     | svg      | `logo_fr_horizontal_blue_svg`  | `logo_fr_horizontal_blue.svg`  |
| <img src="./src/assets/logo_fr_horizontal_white.png" width="200" /> | French     | png      | `logo_fr_horizontal_white_png` | `logo_fr_horizontal_white.png` |
| <img src="./src/assets/logo_fr_horizontal_white.svg" width="200" /> | French     | svg      | `logo_fr_horizontal_white_svg` | `logo_fr_horizontal_white.svg` |
| <img src="./src/assets/logo_es_horizontal_blue.png" width="200" />  | Spanish    | png      | `logo_es_horizontal_blue_png`  | `logo_es_horizontal_blue.png`  |
| <img src="./src/assets/logo_es_horizontal_blue.svg" width="200" />  | Spanish    | svg      | `logo_es_horizontal_blue_svg`  | `logo_es_horizontal_blue.svg`  |
| <img src="./src/assets/logo_es_horizontal_white.png" width="200" /> | Spanish    | png      | `logo_es_horizontal_white_png` | `logo_es_horizontal_white.png` |
| <img src="./src/assets/logo_es_horizontal_white.svg" width="200" /> | Spanish    | svg      | `logo_es_horizontal_white_svg` | `logo_es_horizontal_white.svg` |
| <img src="./src/assets/logo_ar_horizontal_blue.png" width="200" />  | Arabic     | png      | `logo_ar_horizontal_blue_png`  | `logo_ar_horizontal_blue.png`  |
| <img src="./src/assets/logo_ar_horizontal_blue.svg" width="200" />  | Arabic     | svg      | `logo_ar_horizontal_blue_svg`  | `logo_ar_horizontal_blue.svg`  |
| <img src="./src/assets/logo_ar_horizontal_white.png" width="200" /> | Arabic     | png      | `logo_ar_horizontal_white_png` | `logo_ar_horizontal_white.png` |
| <img src="./src/assets/logo_ar_horizontal_white.svg" width="200" /> | Arabic     | svg      | `logo_ar_horizontal_white_svg` | `logo_ar_horizontal_white.svg` |
| <img src="./src/assets/logo_zh_horizontal_blue.png" width="200" />  | Chinese    | png      | `logo_zh_horizontal_blue_png`  | `logo_zh_horizontal_blue.png`  |
| <img src="./src/assets/logo_zh_horizontal_blue.svg" width="200" />  | Chinese    | svg      | `logo_zh_horizontal_blue_svg`  | `logo_zh_horizontal_blue.svg`  |
| <img src="./src/assets/logo_zh_horizontal_white.png" width="200" /> | Chinese    | png      | `logo_zh_horizontal_white_png` | `logo_zh_horizontal_white.png` |
| <img src="./src/assets/logo_zh_horizontal_white.svg" width="200" /> | Chinese    | svg      | `logo_zh_horizontal_white_svg` | `logo_zh_horizontal_white.svg` |
| <img src="./src/assets/logo_nl_horizontal_blue.png" width="200" />  | Dutch      | png      | `logo_nl_horizontal_blue_png`  | `logo_nl_horizontal_blue.png`  |
| <img src="./src/assets/logo_nl_horizontal_blue.svg" width="200" />  | Dutch      | svg      | `logo_nl_horizontal_blue_svg`  | `logo_nl_horizontal_blue.svg`  |
| <img src="./src/assets/logo_nl_horizontal_white.png" width="200" /> | Dutch      | png      | `logo_nl_horizontal_white_png` | `logo_nl_horizontal_white.png` |
| <img src="./src/assets/logo_nl_horizontal_white.svg" width="200" /> | Dutch      | svg      | `logo_nl_horizontal_white_svg` | `logo_nl_horizontal_white.svg` |
| <img src="./src/assets/logo_de_horizontal_blue.png" width="200" />  | German     | png      | `logo_de_horizontal_blue_png`  | `logo_de_horizontal_blue.png`  |
| <img src="./src/assets/logo_de_horizontal_blue.svg" width="200" />  | German     | svg      | `logo_de_horizontal_blue_svg`  | `logo_de_horizontal_blue.svg`  |
| <img src="./src/assets/logo_de_horizontal_white.png" width="200" /> | German     | png      | `logo_de_horizontal_white_png` | `logo_de_horizontal_white.png` |
| <img src="./src/assets/logo_de_horizontal_white.svg" width="200" /> | German     | svg      | `logo_de_horizontal_white_svg` | `logo_de_horizontal_white.svg` |
| <img src="./src/assets/logo_it_horizontal_blue.png" width="200" />  | Italian    | png      | `logo_it_horizontal_blue_png`  | `logo_it_horizontal_blue.png`  |
| <img src="./src/assets/logo_it_horizontal_blue.svg" width="200" />  | Italian    | svg      | `logo_it_horizontal_blue_svg`  | `logo_it_horizontal_blue.svg`  |
| <img src="./src/assets/logo_it_horizontal_white.png" width="200" /> | Italian    | png      | `logo_it_horizontal_white_png` | `logo_it_horizontal_white.png` |
| <img src="./src/assets/logo_it_horizontal_white.svg" width="200" /> | Italian    | svg      | `logo_it_horizontal_white_svg` | `logo_it_horizontal_white.svg` |
| <img src="./src/assets/logo_ja_horizontal_blue.png" width="200" />  | Japanese   | png      | `logo_ja_horizontal_blue_png`  | `logo_ja_horizontal_blue.png`  |
| <img src="./src/assets/logo_ja_horizontal_blue.svg" width="200" />  | Japanese   | svg      | `logo_ja_horizontal_blue_svg`  | `logo_ja_horizontal_blue.svg`  |
| <img src="./src/assets/logo_ja_horizontal_white.png" width="200" /> | Japanese   | png      | `logo_ja_horizontal_white_png` | `logo_ja_horizontal_white.png` |
| <img src="./src/assets/logo_ja_horizontal_white.svg" width="200" /> | Japanese   | svg      | `logo_ja_horizontal_white_svg` | `logo_ja_horizontal_white.svg` |
| <img src="./src/assets/logo_pt_horizontal_blue.png" width="200" />  | Portuguese | png      | `logo_pt_horizontal_blue_png`  | `logo_pt_horizontal_blue.png`  |
| <img src="./src/assets/logo_pt_horizontal_blue.svg" width="200" />  | Portuguese | svg      | `logo_pt_horizontal_blue_svg`  | `logo_pt_horizontal_blue.svg`  |
| <img src="./src/assets/logo_pt_horizontal_white.png" width="200" /> | Portuguese | png      | `logo_pt_horizontal_white_png` | `logo_pt_horizontal_white.png` |
| <img src="./src/assets/logo_pt_horizontal_white.svg" width="200" /> | Portuguese | svg      | `logo_pt_horizontal_white_svg` | `logo_pt_horizontal_white.svg` |
| <img src="./src/assets/logo_ru_horizontal_blue.png" width="200" />  | Russian    | png      | `logo_ru_horizontal_blue_png`  | `logo_ru_horizontal_blue.png`  |
| <img src="./src/assets/logo_ru_horizontal_blue.svg" width="200" />  | Russian    | svg      | `logo_ru_horizontal_blue_svg`  | `logo_ru_horizontal_blue.svg`  |
| <img src="./src/assets/logo_ru_horizontal_white.png" width="200" /> | Russian    | png      | `logo_ru_horizontal_white_png` | `logo_ru_horizontal_white.png` |
| <img src="./src/assets/logo_ru_horizontal_white.svg" width="200" /> | Russian    | svg      | `logo_ru_horizontal_white_svg` | `logo_ru_horizontal_white.svg` |
| <img src="./src/assets/logo_tr_horizontal_blue.png" width="200" />  | Turkish    | png      | `logo_tr_horizontal_blue_png`  | `logo_tr_horizontal_blue.png`  |
| <img src="./src/assets/logo_tr_horizontal_blue.svg" width="200" />  | Turkish    | svg      | `logo_tr_horizontal_blue_svg`  | `logo_tr_horizontal_blue.svg`  |
| <img src="./src/assets/logo_tr_horizontal_white.png" width="200" /> | Turkish    | png      | `logo_tr_horizontal_white_png` | `logo_tr_horizontal_white.png` |
| <img src="./src/assets/logo_tr_horizontal_white.svg" width="200" /> | Turkish    | svg      | `logo_tr_horizontal_white_svg` | `logo_tr_horizontal_white.svg` |
| <img src="./src/assets/logo_vi_horizontal_blue.png" width="200" />  | Vietnamese | png      | `logo_vi_horizontal_blue_png`  | `logo_vi_horizontal_blue.png`  |
| <img src="./src/assets/logo_vi_horizontal_blue.svg" width="200" />  | Vietnamese | svg      | `logo_vi_horizontal_blue_svg`  | `logo_vi_horizontal_blue.svg`  |
| <img src="./src/assets/logo_vi_horizontal_white.png" width="200" /> | Vietnamese | png      | `logo_vi_horizontal_white_png` | `logo_vi_horizontal_white.png` |
| <img src="./src/assets/logo_vi_horizontal_white.svg" width="200" /> | Vietnamese | svg      | `logo_vi_horizontal_white_svg` | `logo_vi_horizontal_white.svg` |

### Favicon

Various different favicon formats are available in the package. They are exported from the `/dist/favicon` directory. The following table lists the available formats and their dimensions.

| Image                                                                         | Description                        | Dimensions | Filetype |
|-------------------------------------------------------------------------------|------------------------------------|------------|----------|
| <img src="./src/assets/favicon/favicon.ico" width="32">                       | `favicon.ico`                      | 32x32      | .ico     |
| <img src="./src/assets/favicon/mstile-270x270.png" width="150">               | `mstile-270x270x.png`              | 270x270    | .png     |
| <img src="./src/assets/favicon/apple-touch-icon.png" width="180">             | `apple-touch-icon.png`             | 180x180    | .png     |
| <img src="./src/assets/favicon/apple-touch-icon-precomposed.png" width="180"> | `apple-touch-icon-precomposed.png` | 180x180    | .png     |
| <img src="./src/assets/favicon/android-chrome-192x192.png" width="150">       | `android-chrome-192x192.png`       | 192x192    | .png     |
| <img src="./src/assets/favicon/android-chrome-512x512.png" width="150">       | `android-chrome-512x512.png`       | 512x512    | .png     |
| <img src="./src/assets/favicon/safari-pinned-tab.svg" width="150">            | `safari-pinned-tab.svg`            | -          | .svg     |
| <img src="./src/assets/favicon/maskable-icon-192x192.png" width="192">        | `maskable-icon-192x192.png`        | 192x192    | .png     |
| <img src="./src/assets/favicon/maskable-icon-512x512.png" width="512">        | `maskable-icon-512x512.png`        | 512x512    | .png     |

## Contributing

ILO Design System is an open-source project and we welcome your contributions! Before submitting a pull request, please take a moment to review the [contribution guidelines](./contributing.md).