@arietta-studio/ui

Arietta UI

Arietta UI is an open-source UI component library for building amazing web apps

English ・ Changelog · Report Bug · Request Feature

Table of contents

TOC

• 📦 Installation
  • Compile with NextJS
• 🤯 Usage
• ⌨️ Local Development
• 🤝 Contributing
• 🩷 Sponsor

📦 Installation

[!IMPORTANT]
This package is ESM only.

To install Arietta UI, run the following command:

$ bun add @arietta-studio/ui

Compile with NextJS

[!NOTE]
By work correct with nextjs page router SSR, add transpilePackages: ['@arietta-studio/ui'] to next.config.js. For example:

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

  transpilePackages: ['@arietta-studio/ui'],
};

🤯 Usage

[!NOTE]
The Arietta UI components are 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, Button } from '@arietta-studio/ui'
import { Button } from 'antd'

export default () => (
  <ThemeProvider>
    <Button>Hello Arietta</Button>
  </ThemeProvider>
)

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

$ git clone https://github.com/arietta-studio/arietta-ui.git
$ cd arietta-ui
$ bun install
$ bun start

🤝 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.

🩷 Sponsor

Every bit counts and your one-time donation sparkles in our galaxy of support! You're a shooting star, making a swift and bright impact on our journey. Thank you for believing in us – your generosity guides us toward our mission, one brilliant flash at a time.

📝 License

Copyright © 2024 Arietta Studio.
This project is MIT licensed.