@clubmed/trident-icons/README.md

Shared ClubMed Icons library

<div style="text-align: center" align="center">
 <img src="https://ns.clubmed.com/fbs/RWD/branding2023/Logo/MicrosoftTeams-image%20(9).png" width="200" alt="Club Med"/>
</div>

<div align="center">
   <h1>@clubmed/trident-icons</h1>
   <hr />

[![npm version](https://badge.fury.io/js/%40clubmed%2Ftrident-icons.svg)](https://badge.fury.io/js/%40clubmed%2Ftrident-icons)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

</div>

## What it is

Trident Icons is an icons library for Club Med. It provides a set of icons that can be used in any Club Med project.

It supports the following features:

- SVG icons
- SVG-use icons (for better performance)
- SSR and Loaders for Node.js and Webpack/Vike/etc.

## Useful links

- [Figma Trident UI](https://www.figma.com/@clubmed)
- [Board Jira](https://clubmed.atlassian.net/jira/software/c/projects/SCL/boards/122)
- [Storybook stable version](https://latest.trident-icons.pro.clubmed/?path=/docs/introduction--docs)
- [Storybook rc version](https://rc.trident-icons.pro.clubmed/?path=/docs/introduction--docs)
- [Storybook dev version](https://develop.trident-icons.pro.clubmed/?path=/docs/introduction--docs)

## Requirements

- Node.js >= 18
- Optional: React >= 17

## Installation

```sh
npm install --save @clubmed/trident-icons
```

## Library Configuration (React)

you can use the `TridentUIConfigProvider` to configure some option of the Trident UI library:

```tsx
import './index.css';
import App from './App';
import React from 'react';
import { createRoot } from 'react-dom/client';
import { IconsProvider } from '@clubmed/trident-icons';
import Actions from '@clubmed/trident-icons/svg/Actions';

const baseName = (window as any).basename || '/';

createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <IconsProvider icons={[Actions]} locale={'fr-FR'}>
      <App />
    </IconsProvider>
  </React.StrictMode>,
);
```

### Options

- `locale` - The locale to use for the components. Default to `fr-FR`.

## Icons configuration

Trident Icons provide a new way to load icons. You can use the `IconProvider` component to load icons from a specific group.
Currently, there is two icons provider available:

- SvgIconProvider: Use lazy loaded SVG to display icons.
- SvgUseIconProvider: Use native Svg.use property to load and display icons.

For each provider, you have subset of icons split by groups name:

- Actions
- Activities
- Brand
- Covid
- Food
- HappyToCare
- Places
- Resort \* (only available for SVG)
- Room
- Services
- Socials
- Transports
- Utilities

By default, no icons provider is set. You have to import a subset icons in your code as follows:

Svg mode:

```tsx
import Actions from '@clubmed/trident-icons/svg/Actions'; // load only the Actions subset using SVG mode
import { Icon, IconsProvider } from '@clubmed/trident-icons';

function App() {
  return (
    <IconsProvider icons={[Actions]}>
      <Icon name="ArrowDefaultLeft" />
    </IconsProvider>
  );
}
```

You can mix usage of SVG and SVG-use modes:

```tsx
import { IconsProvider } from '@clubmed/trident-icons';
import Actions from '@clubmed/trident-icons/svg-use/Actions'; // load the Actions subset
import Brand from '@clubmed/trident-icons/svg/Brand';

function App() {
  return (
    <IconsProvider icons={[Actions, Brand]}>
      <Icon name="ArrowDefaultLeft" />
      <Icon name="ClubMed" />
    </IconsProvider>
  );
}
```

> In this case, Icon component will automatically use the appropriate IconResolver to load and display the icon.

### Register custom icons

Trident UI provide function to register any external Svg icons without having redevelop
a custom Icon component. Just use `resolver` from `SvgIconResolver` or `SvgUseIconResolver` to add your new icon:

```tsx
import { Icon, IconsProvider } from '@clubmed/trident-icons';
import { resolver } from '@clubmed/trident-icons/svg/SvgIconResolver';

const CustomIcons = resolver([
  {
    name: 'MyCustomIcon',
    group: 'custom',
    element: lazy(() => import('./MyCustomIcon.svg?react')),
    // viewBox: '0 0 30 30', // default '0 0 30 30'
    // aspectRatio: 1, // default '1'
    // orientation: 'left' // apply rotation to the icon
  },
]);

function App() {
  return (
    <IconsProvider icons={[CustomIcons]}>
      <Icon name="MyCustomIcon" />
    </IconsProvider>
  );
}
```

### Node.js + SSR

If you are using Vite with SSR in a Node.js context, you have to register a node.js loader SVG files.
`@clubmed/trident-icons` provides an ESM loader for SVG files. Add the following import your node.js command in your package.json:

```json
{
  "scripts": {
    "start": "node -r @clubmed/trident-icons/esm-loader ./src/server.js"
  }
}
```

If you use a nodemon, you have to add the same loader in the nodemon.json file:

```json
{
  "extensions": ["ts", "js"],
  "delay": 100,
  "execMap": {
    "ts": "node --import @clubmed/trident-icons/loaders/node/svg",
    "js": "node --import @clubmed/trident-icons/loaders/node/svg"
  }
}
```

### Generate fonts from icons (dev)

The project have a builder to compile svg to font. Just add Svg inside `svg` then
run the following command:

```sh
npm run build:fonts
```

## Know issues

### Webfont

Currently, some icons in Font mode aren't correctly rendered because the SVG source aren't correctly
cleaned.

## Contributing

Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## License

Copyright 2024 - Today | Club Med

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.