@univerjs/base-ui

base-ui

English| 简体中文

Introduction

UniverSheet official UI component library

Features

• Pure tsx components, which can be easily integrated into vue/react
• Import on demand, don’t worry about affecting the package size

Usage

Install

npm i @univerjs/base-ui

Import

import baseUI from '@univerjs/base-ui';
universheet.install(baseUI);
universheet.create({
    plugins: ['base-ui'],
});

Local development

Requirements

• Node.js Version >= 10
• npm Version >= 7

Installation

npm i

Development

# Current directory ./packages/base-ui/
npm run dev

# Or project root directory ./
npm run dev -w @univerjs/base-ui

Package

# Current directory ./packages/base-ui/
npm run build

# Or root directory ./
npm run build -w @univerjs/base-ui

Doc Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

# root folder
npm i

Development

# base-ui folder
npm run start

# or root folder
npm run start -w @univerjs/base-ui

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

# base-ui folder
npm run build:doc

# or root folder
npm run build:doc -w @univerjs/base-ui

This command generates static content into the build directory and can be served using any static contents hosting service.