@axelor/ui

Axelor-UI

React components by Axelor.

Prerequisite

• node >= v20
• pnpm >= 8

# Nodejs
$ curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -
$ sudo apt-get install -y nodejs

# Alternatively, `nvm` can be used as a Node Version Manager
$ curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
$ source ~/.profile
$ nvm install 18

# pnpm
$ corepack enable
$ corepack prepare pnpm@latest-8 --activate

Quick start

Install the library :

$ pnpm add @axelor/ui

You can import from the main bundle:

import { Button } from '@axelor/ui';

Only core components are available from the main bundle.

For others components (grid, kanban, gantt, ...), you have to import the component directly :

import Grid from '@axelor/ui/grid';

import Kanban from '@axelor/ui/kanban';

Development

Before any command, install dependencies running following command:

$ pnpm install

Storybook

Run following commands to build storybook :

$ pnpm build-storybook

This build Storybook as a static web application capable of being served by any web server. Default build files are located under storybook-static/*

To run storybook locally :

$ pnpm storybook

the storybook will be served on http://localhost:6006

Build

Run following command to build components :

$ pnpm build

components are generated under dist/.