English | 简体中文

@ray-js/smart-ui

Introduction

@ray-js/smart-ui is a React component library based on the Ray framework and @tuya-miniapp/smart-ui, designed to provide lightweight and reliable UI components that meet the mobile design specifications of Tuya MiniApp. By combining Ray's specification adaptation middleware and built-in complete TS types, we offer a full set of React components suitable for Tuya MiniApp, enabling developers to quickly build mobile applications that comply with design specifications.

Preview

Scan the QR code below to experience the component library examples.

Before Using

Before using Smart UI, make sure you have studied the official Tuya MiniApp Ray Development Overview and Ray Component Introduction.

Installation

# Install via yarn (recommended)
yarn add @ray-js/smart-ui

# Install via npm
npm i @ray-js/smart-ui

Using Components

Take the Button component as an example

import { Button } from '@ray-js/smart-ui';

export default function Demo() {
  return <Button type="info">Info Button</Button>;
}

Dynamic On-Demand Import (Recommended)

Considering the project's on-demand introduction and overall size issues, the above import method will lead to some component style file residuals affecting the package size. Therefore, we recommend using the on-demand import plugin, which will automatically parse import { Button } from '@ray-js/smart-ui'; into import { Button } from '@ray-js/smart-ui/es/button';.

1. Environment Requirements

   • >= @ray-js/[email protected]
   • esbuild build mode (does not support webpack mode)
   • Use ESModule import syntax for import
   • SmartUI version 2.4.0 and above

2. Simply introduce SmartUIAutoImport in the project file ray.config.ts:

import { RayConfig } from '@ray-js/types';
import SmartUIAutoImport from '@ray-js/smart-ui/lib/auto-import';

const config: RayConfig = {
  ...
  importTransformer: [SmartUIAutoImport],
};
module.exports = config;

The on-demand import plugin will not parse content inside node_modules, so if you reference or develop SmartUI secondary encapsulation npm packages, you need on-demand import resources internally; otherwise, it will cause a full import of the SmartUI component library!
You can use Ray version 1.8.0-beta.12, which adds the Ray doctor command to check the health of project dependencies!

Preview in Developer Tools

# Install project dependencies
$ yarn

Open Tuya MiniApp Tools and add the example directory to preview the examples.

Basic Library Version

@ray-js/smart-ui provides stable support starting from Tuya MiniApp basic library version 2.19.0, @ray-js/ray@^1.5.1, and IDE 0.6.5.

Related Links

SmartUI Component Library Official Website
SmartUI GitHub
MiniApp SmartUI GitHub
MiniApp Community Forum
Ray Official Website
Ray Material Market
Public Source Collection of Materials and Templates

Changelog

This project follows the Angular Style Commit Message Conventions. For the update log, please refer to Release (starting from version 2.5.1)

Official Website Changelog

License

This project is licensed under the MIT license. Please feel free to enjoy and participate in open-source.