https://github.com/ericlee05/rexon
Rexon is a Virtual CLI for React / React용 가상 CLI 라이브러리입니다
https://github.com/ericlee05/rexon
cli component react theme typescript-library virtual-console
Last synced: about 1 month ago
JSON representation
Rexon is a Virtual CLI for React / React용 가상 CLI 라이브러리입니다
- Host: GitHub
- URL: https://github.com/ericlee05/rexon
- Owner: ericlee05
- Created: 2020-11-01T03:27:50.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-13T09:09:53.000Z (over 5 years ago)
- Last Synced: 2026-03-30T16:16:28.406Z (3 months ago)
- Topics: cli, component, react, theme, typescript-library, virtual-console
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# REXON
> Virtual CLI Component for React / React용 가상 CLI 컴포넌트 라이브러리
[](https://www.npmjs.com/package/rexon) [](https://standardjs.com)
## Install / 설치
```bash
npm i --save rexon
```
## Usage / 사용법
```tsx
import React, { Component } from 'react'
import { Rexon, RexonRuntime, RexonConsole } from 'rexon'
class Example extends Component {
render() {
const Runtime:RexonRuntime = {
onCreate : async (Console:RexonConsole) => {
Console.println("Hello, World!")
}
}
return
}
}
```
### How to try Example Project for debug? / 디버그용 테스트 프로젝트
1. Run `npm run dev` in project root directory / `npm run dev`를 프로젝트 루트 디렉터리에서 실행하세요
2. It's all! / 끝입니다!
## Console API / 콘솔 API
We are trying to implement the APIs of Win32 Console in Rexon, Now we supports these. / Win32 Console API에 있는 대부분의 기능을 구현하기 위해 노력중이며 아래와 같은 기능을 지원합니다.
* `Console.setTitle(Title:string)` : set title text / 타이틀을 변경합니다
* `Console.showTitle(isShow:boolean)` : set visible of title / 타이틀의 가시성 여부를 결정합니다
* `Console.isTitleShowing()` : check visible of title / 타이틀의 가시성 여부를 가져옵니다
* `Console.println(Text:string)` : print text with breakline / 텍스트를 개행과 함께 출력합니다
* `Console.print(Text:string)` : print text / 텍스트를 출력합니다
* `Console.printWithAnimation(Text:string, Speed:number)` : print text with animation / 텍스트를 시간 간격을 두고 출력합니다
* `Console.readln()` : read text / 텍스트를 읽어들입니다
* `Console.clear()` : clear all text / 텍스트 모두 삭제합니다
* `Console.getAllHistory()` : get history of console / 콘솔의 기록을 가져옵니다
* `Console.setColor(Color:string)` : set current color of text / 앞으로 작성할 텍스트의 색상을 변경합니다
* `Console.setBackgroundColor(Color:string)` : set background color / 배경 색을 변경합니다
* `Console.setFontSize(Size:number)` : set font size / 폰트 크기를 변경합니다
* `Console.setBackgroundImage(Image:string)` : set background image / 배경 이미지를 변경합니다
* `Console.setBackgroundImageOpacity(Opacity:number)` : set opacity of background image / 배경 이미지의 투명도를 설정합니다
Also, these may be implemented soon. / 또한, 아래의 기능들은 곧 구현될 수 있습니다.
* Console Progress bar / 콘솔 프로그레스 바
* Console Table Generator(with 2D array) / 콘솔 테이블 생성기(2차원 배열 이용)
* Command-line user interface framework(like [cli-ui](https://github.com/Shopify/cli-ui)) / 커맨드라인 유저 인터페이스 프레임워크([cli-ui](https://github.com/Shopify/cli-ui)와 유사하게 개발할 예정)
* and more.. / 그리고 더 추가될 예정입니다..
## Uses / 활용
* Mud Game / 머드게임
* Console based game(like hacknet) / 콘솔 기반 게임(핵넷같은 게임)
* And more.. / 이외에도 무한합니다..
## Projects that used Rexon / Rexon이 사용된 프로젝트
> You can upload your project here only that your project has stars more than 10.
> 개발자 본인(VINTO1819)의 프로젝트와 Star가 10개 이상인 프로젝트만 등재됩니다.
* ~~Todo~~
## License / 라이선스
MIT © [VINTO1819](https://github.com/VINTO1819)