Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
- Add a concept section
- Rewrite the features description
  • Loading branch information
kitsuyui committed Dec 26, 2023
1 parent 48ea946 commit 6c27186
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 70 deletions.
40 changes: 32 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ It only deals with content that is closed to React. It does not handle Next.js,
For Next.js, see https://github.com/kitsuyui/nextjs-playground/ .
For TypeScript, see https://github.com/kitsuyui/ts-playground/ .

# Concept

## Wrapping

If you know how to use raw HTML, you know how to use it, so wrap it as it is as much as possible.

## Style specification

Basically, do not specify the style as much as possible. The style specification should be specified by the user of the component.
As an exception, `packages/style-{name}` contains a CSS framework with specific styles.

## Block elements

If there is a size specification, display it with that size. If there is no size specification, it is interpreted as width: auto, height: auto

## Inline elements

The size is determined by the font size specification.

## Demo & Documentations

- [x] [Storybook](https://react-playground.docs.kitsuyui.com/storybook/)
Expand All @@ -25,14 +44,19 @@ For TypeScript, see https://github.com/kitsuyui/ts-playground/ .

## Features

- [x] `@kitsuyui/react-components` ... [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-components.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-components)
- [x] `@kitsuyui/react-clock` ... [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-clock.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-clock)
- [x] `@kitsuyui/react-timer` ... [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-timer.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-timer)
- [x] `@kitsuyui/react-stopwatch` ... [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-stopwatch.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-stopwatch)
- [x] `@kitsuyui/react-dekamoji` ... [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-dekamoji.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-dekamoji)
- [x] `@kitsuyui/react-wavebox` ... [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-wavebox.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-wavebox)
- [ ] Alarm
- [ ] Dice
- [x] `@kitsuyui/react-components` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-components.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-components)
- [x] `@kitsuyui/react-clock` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-clock.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-clock) ... Clock
- [x] `@kitsuyui/react-timer` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-timer.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-timer) ... Pomodoro timer
- [x] `@kitsuyui/react-stopwatch` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-stopwatch.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-stopwatch) ... Stopwatch
- [x] `@kitsuyui/react-dekamoji` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-dekamoji.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-dekamoji) ... Display big text whole screen
- [x] `@kitsuyui/react-wavebox` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-wavebox.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-wavebox) ... Variable size box (for debug)
- [x] `@kitsuyui/react-treemap` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-treemap.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-treemap) ... Put the box in the box like as marimekko chart
- [x] `@kitsuyui/react-measure` [![npm version](https://badge.fury.io/js/@kitsuyui%2Freact-measure.svg)](https://badge.fury.io/js/@kitsuyui%2Freact-measure) ... Display size of the box (for debug)
- [x] `@kitsuyui/react-textfield` [![npm version](https://badge.fury.io/js/%40kitsuyui%2Freact-textfield.svg)](https://badge.fury.io/js/%40kitsuyui%2Freact-textfield) ... Text field with IME support
- [x] `@kitsuyui/react-editablelabel` [![npm version](https://badge.fury.io/js/%40kitsuyui%2Freact-editablelabel.svg)](https://badge.fury.io/js/%40kitsuyui%2Freact-editablelabel) ... Editable label with IME support
- [ ] Alarm
- [ ] Dice
- [x] `@kitsuyui/react-style-bulma` [![npm version](https://badge.fury.io/js/%40kitsuyui%2Freact-style-bulma.svg)](https://badge.fury.io/js/%40kitsuyui%2Freact-style-bulma) ... Bulma CSS framework with `@kitsuyui/react-components`

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"@types/node": "^20.10.5",
"@types/react": "^18.2.45",
"@types/react-dom": "^18.2.18",
"@typescript-eslint/eslint-plugin": "^6.15.0",
"@typescript-eslint/eslint-plugin": "^6.16.0",
"concurrently": "^8.2.2",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
Expand Down
2 changes: 2 additions & 0 deletions packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@
"dependencies": {
"@kitsuyui/react-clock": "workspace:latest",
"@kitsuyui/react-dekamoji": "workspace:latest",
"@kitsuyui/react-editablelabel": "workspace:latest",
"@kitsuyui/react-measure": "workspace:latest",
"@kitsuyui/react-stopwatch": "workspace:latest",
"@kitsuyui/react-textfield": "workspace:latest",
"@kitsuyui/react-timer": "workspace:latest",
"@kitsuyui/react-treemap": "workspace:latest",
"react": "^18.2.0",
Expand Down
2 changes: 2 additions & 0 deletions packages/style-bulma/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@
"dependencies": {
"@kitsuyui/react-clock": "workspace:latest",
"@kitsuyui/react-dekamoji": "workspace:latest",
"@kitsuyui/react-editablelabel": "workspace:latest",
"@kitsuyui/react-measure": "workspace:latest",
"@kitsuyui/react-stopwatch": "workspace:latest",
"@kitsuyui/react-textfield": "workspace:latest",
"@kitsuyui/react-timer": "workspace:latest",
"@kitsuyui/react-treemap": "workspace:latest",
"bulma": "^0.9.4",
Expand Down
Loading

0 comments on commit 6c27186

Please sign in to comment.