internxt/ui

Library containing the UI components

InternxtUI

Overview

This repository contains the library of Internxt components, named @internxt/internxtui. It offers a collection of reusable UI components for use within Internxt projects.

Installation

To install the library, you can use npm or yarn:

npm install @internxt/internxtui

or

yarn add @internxt/internxtui

Usage/Examples

You can import the components from @internxt/internxtui in your React application as follows:

import { Button } from '@internxt/internxtui';

Replace Button with the specific component you want to use.

Scripts

yarn sb

Starts Storybook server.

yarn build-storybook

Builds Storybook for production.

yarn build

Builds the library using TypeScript and Vite.

yarn format

Formats TypeScript files using Prettier.

yarn lint

Lints the project using ESLint.

yarn test

Runs tests using Vitest.

yarn test-update

Runs tests and updates snapshots.

yarn test-watch

Runs tests in watch mode.

yarn test:ui

Runs UI tests.

yarn coverage

Generates test coverage reports.

yarn deploy

Deploy Storybook to GitHub Pages. This is the url: https://internxt.github.io/ui