https://github.com/russellwzr/russell-react-ui

A Toy React Components Library Built by TypeScript. Just for personal practice~
https://github.com/russellwzr/russell-react-ui

react reactjs

Last synced: about 1 month ago
JSON representation

A Toy React Components Library Built by TypeScript. Just for personal practice~

• Host: GitHub
• URL: https://github.com/russellwzr/russell-react-ui
• Owner: Russellwzr
• Created: 2023-05-31T06:23:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-25T12:23:54.000Z (over 1 year ago)
• Last Synced: 2024-10-29T21:48:20.474Z (4 months ago)
• Topics: react, reactjs
• Language: TypeScript
• Homepage: https://russellwzr.github.io/russell-react-ui/
• Size: 5.73 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Russell-React-UI 👋

Welcome to Russell-React-UI, a toy component library powered by React and TypeScript~

## ✨ Features

- 📦 A set of out-of-box [React](https://react.dev/) components, allowing you to easily build beautiful and user-friendly interfaces.

- 🧩 Most of the components support custom rendering by the user, providing a certain degree of flexibility.

- 🛡️ Written in [TypeScript](https://www.typescriptlang.org/) with predictable static types to enhance code maintainability and readability.

- 📝 Interactive documentation built with [Storybook](https://storybook.js.org/), allowing you to quickly learn how to use each component and its properties.

- 🎨 Powerful theme customization based on [Sass](https://sass-lang.com/) to easily customize your component library styles.

- 🐞 Tested with [Jest](https://jestjs.io/) and [React Testing Library](https://testing-library.com/) to ensure every component works as expected.

- 🧹 Ensuring code cleanliness with the use of [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), and [Husky](https://typicode.github.io/husky) pre-commit check.

- 🤖 The above content is automatically generated by [ChatGPT](https://chat.openai.com/) based on the introduction of [ant-design](https://github.com/ant-design/ant-design).

## 📦 Install

```

npm i russell-react-ui

```

## 🚀 Quick Start

```javascript

import React from 'react'

import 'russell-react-ui/dist/index.css'

import { Select } from 'russell-react-ui'

const Option = Select.Option

function App() {

  const args = {

    multiple: true,

    placeholder: 'Multiple Select',

    maxTagCount: 2,

    defaultValue: ['first option', 'second option', 'third option', 'fourth option'],

  }

  return (

    


      

        

        

        

        

        

        

        

        

      

    

  )

}


export default App

```

## 🌐 Online Demo

https://russellwzr.github.io/russell-react-ui/

## 🕊️ Future Work

Will continue adding new components and updating existing ones, if there's free time and no gugugu🕊️......