Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 2.31 KB

README.md

File metadata and controls

62 lines (49 loc) · 2.31 KB
Raw

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 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 with predictable static types to enhance code maintainability and readability.
  • 📝 Interactive documentation built with Storybook, allowing you to quickly learn how to use each component and its properties.
  • 🎨 Powerful theme customization based on Sass to easily customize your component library styles.
  • 🐞 Tested with Jest and React Testing Library to ensure every component works as expected.
  • 🧹 Ensuring code cleanliness with the use of ESLint, Prettier, and Husky pre-commit check.
  • 🤖 The above content is automatically generated by ChatGPT based on the introduction of ant-design.

📦 Install

npm i russell-react-ui

🚀 Quick Start

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 (
    <div>
      <Select {...args}>
        <Option value="first option" />
        <Option value="second option" />
        <Option value="third option" />
        <Option value="fourth option" />
        <Option value="fifth option" />
        <Option value="sixth option" />
        <Option value="seventh option" />
        <Option value="eighth option" />
      </Select>
    </div>
  )
}

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🕊️......