@clubmed/trident-ui NPM

What it is

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

Requirements

React 18
Tailwind 3

Installation

npm install --save @clubmed/trident-ui react react-dom
npm install --save-dev tailwindcss postcss autoprefixer

Tailwind configuration

This package exports a tailwind.preset file that you can use to extend your own configuration.

Edit your tailwind.config.js file and add the following line:

import type { Config } from 'tailwindcss';
import { tailwindPreset } from '@clubmed/trident-ui/tailwind'; // add this line

const config = {
  presets: [tailwindPreset],
  content: [
    './doc/**/*.mdx',
    './lib/**/*.{ts,tsx,mdx}',
    '**/node_modules/@clubmed/trident-ui/**/*.js',
  ],
} satisfies Config;

export default config;

Note: If you have a TypeScript issue when you import the tailwind.preset file, you can add the following line in your tsconfig.json file:

{
  "include": ["src", "."]
}

Then you have to configure your postcss.config.js file to use the tailwind.config.ts file:

export default {
  plugins: {
    tailwindcss: {},
    autoprefixer: {},
  },
};

Then add the styles to your index.css file:

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

or in your main.tsx file:

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

Usage

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

import { useState } from 'react';
import { Button } from '@clubmed/trident-ui/molecules/Buttons/Button';

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

  return (
    <>
      <h1>Vite + React</h1>
      <div class="card">
        <button onClick={() => setCount((count) => count + 1)}>count is {count}</button>
      </div>
    </>
  );
}

Library Configuration

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

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.
FontIconProvider: Use font icons to 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:

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>
  );
}

Fonts mode:

import Actions from '@clubmed/trident-ui/atoms/Icons/fonts/Actions'; // load the Actions subset
import '@clubmed/trident-ui/fonts/tui-actions.css'; // load css rules for Actions
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 fonts mode:

import Actions from '@clubmed/trident-ui/atoms/Icons/fonts/Actions'; // load the Actions subset
import '@clubmed/trident-ui/fonts/tui-actions.css'; // load css rules for Actions
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.

Extra configuration for Svg use

If you are using the SvgUseIconProvider, you have to instrument your bundler tool to resolve the url of the icons:

The configuration depends on your bundler, but it should something like this:

const config = {
  resolve: {
    alias: {
      '@/assets/icons/(.*).svg$': join(
        path.dirname(path.resolve('@clubmed/trident-ui')),
        '/assets/icons/$1.svg',
      ),
    },
  },
};

Register custom icons

Trident UI provide function to register any external Svg icons (or font) without having redevelop a custom Icon component. Just use registerSvgIcon or registerFontIcon to add your new icon:

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>
  );
}

Generate fonts from icons (dev)

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

npm run build:fonts

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:

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

Contributing

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

License

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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.