Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ZhUyU1997/MEUI
Modern embedded UI 现代嵌入式用户界面
https://github.com/ZhUyU1997/MEUI
embedded gui meui preact preactjs quickjs react react-spring reactjs
Last synced: 29 days ago
JSON representation
Modern embedded UI 现代嵌入式用户界面
- Host: GitHub
- URL: https://github.com/ZhUyU1997/MEUI
- Owner: ZhUyU1997
- License: mit
- Created: 2022-04-19T12:33:48.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T16:23:13.000Z (almost 2 years ago)
- Last Synced: 2024-11-09T07:42:06.555Z (about 1 month ago)
- Topics: embedded, gui, meui, preact, preactjs, quickjs, react, react-spring, reactjs
- Language: C
- Homepage: https://zhuyu1997.github.io/MEUI/
- Size: 5.59 MB
- Stars: 54
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-x - MEUI
README
MEUI
A modern embedded UI library giving your extraordinary development experience
现代嵌入式用户界面库，非凡的开发体验
`MEUI` is a modern ui library for embedded platform based on `quickjs` and `React.js`
## [Example](examples/hello/index.jsx)
```jsx
import { createRoot } from "@meui-js/preact"
import { useState } from "preact/compat"
import { animated, useSpring } from "@meui-js/spring"
function App() {
const styles = useSpring({
loop: true,
from: { rotateZ: 0 },
to: { rotateZ: 360 },
})
const [text, setText] = useState("Hello MEUI!")
return (
{
setText("Hello MEUI!\nHello React!")
}}
>
{text}
)
}
createRoot(300, 300).render()
```
## [Browser Demo](https://zhuyu1997.github.io/MEUI/)
## Features
- Support `React.js` to build UI
- Support `flex` layout
- Support partical `css` style
- Support `Material Design Icons`
- Support `React Spring` to build animation
- Support `ES2020`
- Support `canvas` api
## Getting Started
### [Install Xmake](https://xmake.io/#/getting_started?id=installation)
### Windows
- #### Download and Install below packages
[Nodejs 16.x](https://nodejs.org/en/)
[MinGW-w64 x86_64-posix-seh-rt](https://github.com/niXman/mingw-builds-binaries/releases)
[SDL2-devel-mingw](https://github.com/libsdl-org/SDL/releases/)
- #### Add `MinGW` into Environment Variables
- #### Copy the `SDL2` files to `MinGW`
```
[path to SDL2]\x86_64-w64-mingw32 => [path to MinGW]\x86_64-w64-mingw32
```
### Ubuntu/WSLg
- #### Install `Node.js`
```sh
cd ~
curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -
sudo apt -y install nodejs
node -v
```
- #### Install `GCC` & `Make`
```sh
sudo apt install gcc make
```
### Mac OS
- #### [Install NVM](https://github.com/nvm-sh/nvm)
- #### Install `Node.js`
```sh
nvm install node
node -v
```
### Build & Run MEUI
```sh
corepack enable
xmake f --backend=sdl2-core # Only for windows/macos
pnpm add -g pnpm # install the latest pnpm
pnpm install
pnpm build:all
pnpm run:examples
```
Run other examples
```sh
pnpm build:examples src/2048/index.tsx
pnpm run:examples
```
## API References
### CSS Style
```typescript
export interface MeuiStyle {
borderRadius?: [number, number, number, number] | number
borderColor?: string
backgroundColor?: Property.BackgroundColor
fontColor?: Property.Color
text?: string
fontSize?: number
fontFamily?: string
textAlign?:
| "center-left"
| "center-right"
| "center"
| "top-left"
| "top-right"
| "top-center"
| "bottom-left"
| "bottom-right"
| "bottom-center"
backgroundImage?: string
contentImage?: string
transform?: string
transformOrigin?:
| [number, number]
| ["left" | "center" | "right", "top" | "center" | "bottom"]
flexWrap?: "nowrap" | "wrap" | "wrap-reverse"
flexDirection?: "row" | "column" | "row-reverse" | "column-reverse"
alignItems?: "stretch" | "flex-start" | "center" | "flex-end" | "baseline"
alignSelf?:
| "auto"
| "stretch"
| "flex-start"
| "center"
| "flex-end"
| "baseline"
alignContent?:
| "stretch"
| "flex-start"
| "center"
| "flex-end"
| "space-between"
| "space-around"
justifyContent?:
| "flex-start"
| "center"
| "flex-end"
| "space-between"
| "space-around"
margin?: [number, number, number, number] | number
border?: [number, number, number, number] | number
padding?: [number, number, number, number] | number
overflow?: "visible" | "hidden" | "scroll" | "auto"
flexBasis?: number
flexGrow?: number
flexShrink?: number
width?: Length
height?: Length
minWidth?: Length
minHeight?: Length
maxWidth?: Length
maxHeight?: Length
marginLeft?: Length
marginTop?: Length
marginBottom?: Length
marginRight?: Length
marginStart?: Length
marginEnd?: Length
paddingLeft?: Length
paddingTop?: Length
paddingBottom?: Length
paddingRight?: Length
paddingStart?: Length
paddingEnd?: Length
borderLeft?: number
borderTop?: number
borderBottom?: number
borderRight?: number
borderStart?: number
borderEnd?: number
borderTopLeftRadius?: number
borderTopRightRadius?: number
borderBottomRightRadius?: number
borderBottomLeftRadius?: number
left?: Length
right?: Length
top?: Length
bottom?: Length
zIndex?: number
FOCUS?: MeuiStyle
ACTIVE?: MeuiStyle
HOVER?: MeuiStyle
SELECT?: MeuiStyle
DISABLE?: MeuiStyle
CHECK?: MeuiStyle
}
```
## Canvas API
`arc` `arcTo` `beiginPath` `bezierCurveTo` `createRadialGradient` `createLinearGradient` `clearRect` `clip` `closePath` `ellipse` `fill` `fillRect` `fillText` `font` `getImageData` `getTransform` `lineCap` `lineDashOffset` `lineJoin` `lineWidth` `measureText` `Path2D` `putImageData` `quadraticCurveTo` `resetTransform` `rotate` `save` `scale` `setLineDash` `setTransform` `strokeRect` `strokeText` `textAlign` `textBaseline` `transform` `translate`
## Discussion Group
Tencent QQ Group: [765228998](https://jq.qq.com/?_wv=1027&k=LjX7RmEe)
## References
- QuickJS Javascript Engine. Available at:
https://bellard.org/quickjs/
- PlutoVG is a standalone 2D vector graphics library in C. Available at:
https://github.com/sammycage/plutovg
- React: A JavaScript library for building user interfaces. Available at:
https://reactjs.org/
- react-spring: A spring-physics first animation library. Available at:
https://react-spring.io/
- `FlexLayout` is an `C` implementation of `Flexible Box` layout. Available at:
https://github.com/Sleen/FlexLayout
- single-file public domain (or MIT licensed) libraries for C/C++. Available at:
https://github.com/nothings/stb
- Templated type-safe hashmap implementation in C. Available at:
https://github.com/DavidLeeds/hashmap
- `libpqueue` is a generic priority queue (heap) implementation. Available at:
https://github.com/vy/libpqueue