@yuntijs/ui

Yunti UI

☁️ Yunti UI is an open-source UI component library for building Cloud Native web apps

English ・ 简体中文 ・ Changelog · Report Bug · Request Feature

Table of contents

TOC

• 📦 Installation
  • Compile with NextJS
• ☁️ Usage
• ⌨️ Local Development
• 🤝 Contributing

📦 Installation

[!IMPORTANT]
This package is ESM only.

To install Yunti UI, run the following command:

pnpm add @yuntijs/ui

Compile with NextJS

[!NOTE]
By work correct with nextjs ssr, add transpilePackages: ['@yuntijs/ui'] to next.config.js. For example:

// next.config.js
const nextConfig = {
  // ...other config

  transpilePackages: ['@yuntijs/ui'],
};

☁️ Usage

[!NOTE]
The YuntiUI components are inspired by LobeUI and developed based on Antd, fully compatible with Antd components, and it is recommended to use antd-style as the default css-in-js styling solution.

import { ThemeProvider } from '@yuntijs/ui';
import { Button } from 'antd';

export default () => (
  <ThemeProvider>
    <Button>Hello YuntiUI</Button>
  </ThemeProvider>
);

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

git clone https://github.com/yuntijs/yunti-ui.git
cd yunti-ui
pnpm install
pnpm dev

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub Issues to get stuck in to show us what you’re made of.

---

📝 License

Copyright © 2023 YuntiJS.
This project is MIT licensed.