w-design

Documents

Important I'm moving to Tailwind, at slow progress since I'm so busy

Introduction

A React UI toolkit library is built with typescript

Main focus of this libary is styling with css-in-js, small but enough to build a web application. Feel free to use this library, or help us to improve it.

Packages

Published libraries at npm

• Core elements & components

• All needed form, input, box... components and hooks to handle form behaviour

• Masonry component layout with flex box layout

• Upload components with XHR request supports

• React custom hooks

• Utility functions to help to resolve style, object, array, string...

Features

• Written with Typescript to improve dev experience.
• Code splitting built with babel.
• Styled with styled-components and styled-system
• Suitable for web application.
• Supports modern web browsers, included common js & es. If you care about IE, don't use this library.

🐞 Report

For Issues

Please open Issue to report bugs.

Questions

For how-to questions and other non-issues, please use StackOverflow instead of Github issues. Add tag 'w-design' for your question in StackOverflow.

Development

We are using Lerna to manage monorepo packages, please check their document.

At the root directory, do following steps:

1. Pull the repository and install by yarn install
2. Bootstrap all packages lerna bootstrap
3. Build packages yarn build before execute run dev
4. After finished, run yarn dev:es and yarn dev:type at separate terminal. This command will execute watching all packages within lerna parallel mode. You can update the packages now.
5. To add information in the documents, at docs directory, run yarn dev. We are using next.js and

Steps to publish

1. Check update all packages dependencies
2. Run all tests and coverage
3. Build packages
4. Publish

License

MIT © We-mak