<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-ui</h1>
   <hr />

[![npm version](https://badge.fury.io/js/%40clubmed%2Ftrident-ui.svg)](https://badge.fury.io/js/%40clubmed%2Ftrident-ui)
[![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

React UI components is a library of reusable components for building web applications using the Club Med brand guidelines.

## 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-ui.pro.clubmed/?path=/docs/introduction--docs)
- [Storybook dev version](https://develop.trident-ui.pro.clubmed/storybook/index.html?path=/docs/introduction--docs)
- [Documentation](https://develop.trident-ui.pro.clubmed/?path=/docs/introduction--docs)

## Requirements

- React 18
- Tailwind 4

## Installation

```sh
npm install --save @clubmed/trident-icons @clubmed/trident-ui react react-dom
npm install --save-dev tailwindcss @tailwindcss/vite
```

```sh
yarn add @clubmed/trident-icons @clubmed/trident-ui react react-dom
yarn add -D tailwindcss @tailwindcss/vite
```

```sh
pnpm add @clubmed/trident-icons @clubmed/trident-ui react react-dom
pnpm add -D tailwindcss @tailwindcss/vite
```

> If you use vite, you can install `@tailwindcss/vite` instead of using postcss. See [Tailwind vite documentation](https://tailwindcss.com/docs/installation/using-vite)

## Configuration

Add `@tailwindcss/vite` to your `vite.config.ts` plugins:

```ts
import tailwindcss from '@tailwindcss/vite';

export default defineConfig({
  plugins: [react(), tailwindcss()],
});
```

Then, add the styles to your `index.css` file:

```css
@import '@clubmed/trident-ui/style.css';
@source '../node_modules/@clubmed/trident-ui/ui/**/*.js'; /* Important, this line is required to make Tailwind CSS work with Trident UI components */
```

> `@source` must be relative to the file where you import it, and must point to the `ui` directory of the library. This is required to make Tailwind CSS work with Trident UI components, as it needs to scan the source files to generate the correct styles.

## Tailwind Merge configuration

The design tokens shipped with Trident UI use custom `text-*` utilities (`text-b5`, `text-h2`, etc.) that behave like font-size helpers. When consumers rely on [`tailwind-merge`](https://github.com/dcastil/tailwind-merge) to compose classes, these tokens must be registered as typography utilities; otherwise `tailwind-merge` may wrongly treat them as text-color classes and drop valid styles (for example `twMerge('text-b5', 'text-white')` would remove `text-white`).

To get the correct behavior you can reuse the helper we expose:

```ts
import { twMerge } from '@clubmed/trident-ui/helpers/twMerge';

// twMerge('text-b5', 'text-white') -> 'text-b5 text-white'
```

If you need to customize `tailwind-merge` further in your app, extend it with our typography tokens:

```ts
import { extendTailwindMerge } from 'tailwind-merge';

export const twMerge = extendTailwindMerge({
  extend: {
    theme: {
      text: ['b6', 'b5', 'b4', 'b3', 'b2', 'b1', 'b0', 'h5', 'h4', 'h3', 'h2', 'h1', 'h0'],
    },
  },
});
```

Both approaches ensure Trident UI classes merge safely alongside your overrides.

## Usage

You can import any components directly from is directory. For example the Button component can be imported and
used as follows:

```tsx
import { useState } from 'react';
import { Button } from '@clubmed/trident-ui/ui/buttons/Button';

export function App() {
  const [count, setCount] = useState(0);

  return (
    <>
      <Button onClick={() => setCount((count) => count + 1)}>count is {count}</Button>
    </>
  );
}
```

## Library Configuration

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 { TridentUIConfigProvider } from '@clubmed/trident-ui';
import { IconsProvider } from '@clubmed/trident-ui/atoms/Icons/contexts/IconsContext.js';
import Actions from '@clubmed/trident-ui/atoms/Icons/svg/Actions';

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

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

### Options

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

## Icons configuration

Trident UI 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-ui/atoms/Icons/svg/Actions'; // load only the Actions subset using SVG mode
import { Icon } from '@clubmed/trident-ui/atoms/Icons/Icon';

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

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

```tsx
import Actions from '@clubmed/trident-ui/atoms/Icons/svg-use/Actions'; // load the Actions subset
import Brand from '@clubmed/trident-ui/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 { resolver } from '@/atoms/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>
  );
}
```

## Migrate from v1 to v2

1. Update to the latest v1 release of Trident UI before starting the migration.
2. Migrate your code base on Button v2 and Card v2.
3. Replace any import paths containing `atoms` or `molecules` with the `ui` path segment.
4. irectories in paths are now in to lower case. (e.g.: `molecules/Buttons/Button` -> `ui/buttons/button`).
5. Use icons directly from `@clubmed/trident-icons`.
6. Update form callbacks to the unified v2 signature:
   `onChange(event, value)`.
   - v1 patterns like `onChange={(name, value) => ...}` must become
     `onChange={(event, value) => ...}`.
   - When you still need the field name, read it from
     `event.currentTarget.name`.
   - For checkbox-like components, replace direct event reads
     (`event.target.checked`) with the second argument (`value`).

> At this point, check if you haven't any issue with paths and components before moving to the next step.

Now, you can update to Tailwind 4 and Trident UI v2:

- Tailwind 4 no longer reads `tailwind.config.ts` or presets shipped by Trident UI; rename your config to `tailwind.config.legacy.(js|ts)`.
- Adopt the Tailwind 4 syntax updates (for example `@layer`, `@utility`).

Add the styles to your `index.css` file:

```css
@import '@clubmed/trident-ui/style.css';
```

If your `custom.css` file uses Trident UI classes or variables, add this at the very top:

```css
@reference "@clubmed/trident-ui/style.css";

.button {
}
```

It should be enough :)

### Know issues

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

## Jest configuration

if you are using Jest, you can add the following configuration to your `jest.config.js` file:

```js
{
  moduleNameMapper: {
    "^@clubmed/trident-ui/(.*)$": dirname(require.resolve("@clubmed/trident-ui")) + "$1"
  },
  // add also this line can solve issue:
  transformIgnorePatterns: ["/node_modules/(?!@clubmed/trident-ui)/.*"]
}
```

## Accessibility testing

To test accessibility errors (currently in debt in the library), you need to activate the option `parameters.a11y.test` to `error` and run the tests:

```sh
npm run test
```

## 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.
