https://github.com/internxt/ui
Library containing the UI components
https://github.com/internxt/ui
Last synced: 28 days ago
JSON representation
Library containing the UI components
- Host: GitHub
- URL: https://github.com/internxt/ui
- Owner: internxt
- Created: 2024-03-20T09:54:14.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-05-27T06:55:55.000Z (29 days ago)
- Last Synced: 2026-05-27T08:25:16.359Z (29 days ago)
- Language: TypeScript
- Size: 7.82 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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, use yarn:
```bash
yarn add @internxt/internxtui
```
## Usage/Examples
You can import the components from @internxt/internxtui in your React application as follows:
```javascript
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