mirror of
https://github.com/BetterAndroid/FlexiUI.git
synced 2025-09-05 10:15:27 +08:00
update
This commit is contained in:
82
README-zh-CN.md
Normal file
82
README-zh-CN.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Flexi UI
|
||||
|
||||
[](https://github.com/BetterAndroid/FlexiUI/blob/main/LICENSE)
|
||||
[](https://t.me/BetterAndroid)
|
||||
[](https://t.me/HighCapable_Dev)
|
||||
[](https://qm.qq.com/cgi-bin/qm/qr?k=Pnsc5RY6N2mBKFjOLPiYldbAbprAU3V7&jump_from=webapi&authKey=X5EsOVzLXt1dRunge8ryTxDRrh9/IiW1Pua75eDLh9RE3KXE+bwXIYF5cWri/9lf)
|
||||
|
||||
一个灵活且实用的 UI 组件库。
|
||||
|
||||
[English](README.md) | 简体中文
|
||||
|
||||
| <img src="https://github.com/BetterAndroid/.github/blob/main/img-src/logo.png?raw=true" width = "30" height = "30" alt="LOGO"/> | [BetterAndroid](https://github.com/BetterAndroid) |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
||||
|
||||
这个项目属于上述组织，**点击上方链接关注这个组织**，发现更多好项目。
|
||||
|
||||
## 项目介绍
|
||||
|
||||
一个灵活且实用的 UI 组件库，名称取自英文单词 "flexible"。
|
||||
|
||||
这套 UI 诞生的原因是因为目前在 Android 开发中，除了官方推荐的 Material Design 之外，没有完全能够拿来开箱即用的任何一套令我十分满意的 UI 设计规范。
|
||||
|
||||
这套 UI 不实际依赖于任何 Material 组件，但是它借鉴并重构了部分基础的 Material 风格元素 (例如我们熟悉的进度指示器和水波纹效果等) 和使用了部分 Android 平台的设计规范。
|
||||
|
||||
借助目前主流多平台框架的优势使得这套 UI 能复用不必要的原生 UI 代码在更多的平台上呈现，并可被熟悉开发语言的开发者快速引入并使用。
|
||||
|
||||
这个项目早期在 Android 原生平台已经有了一个初版 [FlexiUI-Preview](https://github.com/BetterAndroid/FlexiUI-Preview)，它在 2022 年就已经初步完工，但是我一直没有将它开源出来，因为项目整体耦合度过高且包含一些与 UI 无关的工具依赖，所以我将很多东西进行了解耦合并发布到了新的项目 [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid) 中。
|
||||
|
||||
Android 原生平台的这个项目我基本上不打算继续维护了，如果你感兴趣，你可以点击页面上述的任何一个 `discussion` 加入对应的群组联系我添加查看权限。
|
||||
|
||||
## 开始使用
|
||||
|
||||
你可以点击下方链接查看对应平台的项目分支。
|
||||
|
||||
> Jetpack Compose 版本目前仍处于开发阶段，预计在本月内 (2024-01) 正式发布第一个测试版。
|
||||
|
||||
| <img src="https://developer.android.com/static/images/spot-icons/jetpack-compose.svg" width = "30" height = "30" alt="LOGO"/> | [Jetpack Compose (Dev)](https://github.com/BetterAndroid/FlexiUI/tree/compose-dev) |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
|
||||
|
||||
| <img src="https://avatars.githubusercontent.com/u/14101776?s=200&v=4" width = "30" height = "30" alt="LOGO"/> | Flutter (敬请期待) |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------ |
|
||||
|
||||
## 设计规范
|
||||
|
||||
正在努力完善，预计近期发布，敬请期待。
|
||||
|
||||
## 效果预览图
|
||||
|
||||
<div style="display: flex">
|
||||
<img src="https://github.com/BetterAndroid/FlexiUI/blob/main/img-src/UI-Day.png?raw=true" width = "200" alt="SCREENSHOT"/>
|
||||
<img src="https://github.com/BetterAndroid/FlexiUI/blob/main/img-src/UI-Night.png?raw=true" width = "200" alt="SCREENSHOT"/>
|
||||
<img src="https://github.com/BetterAndroid/FlexiUI/blob/main/img-src/UI-Dark.png?raw=true" width = "200" alt="SCREENSHOT"/>
|
||||
</div>
|
||||
|
||||
## Star History
|
||||
|
||||
|
||||
|
||||
## 许可证
|
||||
|
||||
- [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
```
|
||||
Apache License Version 2.0
|
||||
|
||||
Copyright (C) 2019-2024 HighCapable
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
```
|
||||
|
||||
版权所有 © 2019-2024 HighCapable
|
||||
63
README.md
63
README.md
@@ -5,68 +5,45 @@
|
||||
[](https://t.me/HighCapable_Dev)
|
||||
[](https://qm.qq.com/cgi-bin/qm/qr?k=Pnsc5RY6N2mBKFjOLPiYldbAbprAU3V7&jump_from=webapi&authKey=X5EsOVzLXt1dRunge8ryTxDRrh9/IiW1Pua75eDLh9RE3KXE+bwXIYF5cWri/9lf)
|
||||
|
||||
A flexible and useful UI component library.
|
||||
|
||||
English | [简体中文](README-zh-CN.md)
|
||||
|
||||
| <img src="https://github.com/BetterAndroid/.github/blob/main/img-src/logo.png?raw=true" width = "30" height = "30" alt="LOGO"/> | [BetterAndroid](https://github.com/BetterAndroid) |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
|
||||
|
||||
This project belongs to the above-mentioned organization, **click the link above to follow this organization** and discover more good projects.
|
||||
|
||||
这个项目属于上述组织，**点击上方链接关注这个组织**，发现更多好项目。
|
||||
## Project Introduction
|
||||
|
||||
## English
|
||||
A library of flexible and practical UI components, named after the word "flexible".
|
||||
|
||||
A flexible and useful UI component library, named after the word "flexible".
|
||||
The reason why this UI was born is that currently in Android development, except for the officially recommended Material Design, there is no set of UI design specifications that I am completely satisfied with that can be used out-of-the-box.
|
||||
|
||||
The reason why this UI was born is that currently in `Jetpack Compose` or `Flutter`, except for the officially recommended Material Design, there is no UI framework that I am completely satisfied with that can be used out of the box.
|
||||
This UI does not actually rely on any Material components, but it borrows and reconstructs some basic Material style elements (such as the familiar progress indicator and ripple effect) and uses some design specifications of the Android platform.
|
||||
|
||||
This UI will not actually depend on any Material components, it uses `Jetpack Compose` and `Flutter` as the basis, uses and integrates some basic Material style elements (such as the familiar progress indicator and click ripple effect, etc), and is completely reconstruct a new UI.
|
||||
Taking advantage of the current mainstream multi-platform frameworks, this UI can reuse unnecessary native UI code to be presented on more platforms, and can be quickly introduced and used by developers who are familiar with development languages.
|
||||
|
||||
The advantage of being a multi-platform framework allows this UI to be presented on more platforms and can be quickly introduced and used by developers who are familiar with development languages.
|
||||
This project already had a first version [FlexiUI-Preview](https://github.com/BetterAndroid/FlexiUI-Preview) on the Android native platform in the early days, it will be initially completed in 2022, but I have never open sourced it, because the overall coupling of the project is too high and contains some tool dependencies that have nothing to do with the UI, so I decoupled a lot of things and published them into a new project [BetterAndroid](https://github.com/BetterAndroid/BetterAndroid).
|
||||
|
||||
The basic structure of the project on the Android native platform has been stable. This UI will be completed on the native version of the Android platform in 2022. However, I have not open sourced it for a long time. I am currently re-implementing the multi-platform and waiting for the multi-platform to be improved, then will be open sourced again.
|
||||
I basically don’t plan to continue to maintain this project on the Android native platform, if you are interested, you can click on any `discussion` above on the page to join the corresponding group and contact me to add viewing permissions.
|
||||
|
||||
There is a preview version [FlexiUI-Preview](https://github.com/BetterAndroid/FlexiUI-Preview) for the Android version. If you are interested, you can [join the Telegram group](https://t.me/BetterAndroid) Contact me to add viewing permissions.
|
||||
## Get Started
|
||||
|
||||
This UI is expected to support `Jetpack Compose`, and `Flutter`.
|
||||
You can click the link below to view the project branch of the corresponding platform.
|
||||
|
||||
Priority will be given to supporting `Jetpack Compose` and publishing it in the `compose` branch.
|
||||
> The Jetpack Compose version is still in the development stage, and the first testing version is expected to be officially released within this month (2024-01).
|
||||
|
||||
The main branch `main` will only provide documentation. Please check other related branches for more information.
|
||||
| <img src="https://developer.android.com/static/images/spot-icons/jetpack-compose.svg" width = "30" height = "30" alt="LOGO"/> | [Jetpack Compose (Dev)](https://github.com/BetterAndroid/FlexiUI/tree/compose-dev) |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
|
||||
If you are interested in this project, you can click `Star` and `Watch` in the upper right corner to follow this project.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> **Development of the Jetpack Compose part is ongoing.**
|
||||
>
|
||||
> You can click on the `main` branch in the upper left corner of this page and switch to the `compose-dev` branch to view the current work progress.
|
||||
| <img src="https://avatars.githubusercontent.com/u/14101776?s=200&v=4" width = "30" height = "30" alt="LOGO"/> | Flutter (Stay tuned) |
|
||||
| ------------------------------------------------------------------------------------------------------------- | -------------------- |
|
||||
|
||||
## 简体中文
|
||||
## Design Specifications
|
||||
|
||||
一个灵活且实用的 UI 组件库，名称取自英文单词 "flexible"。
|
||||
|
||||
这套 UI 诞生的原因是因为目前在 `Jetpack Compose` 或 `Flutter` 中，除了官方推荐的 Material Design 之外，没有完全能够拿来开箱即用的任何一套令我十分满意的 UI 框架。
|
||||
|
||||
这套 UI 将不实际依赖于任何 Material 组件，借助 `Jetpack Compose` 和 `Flutter` 作为基础，使用并集成部分基础的 Material 风格元素 (例如我们熟悉的进度指示器和点按波纹效果等)，完全重构一套全新的 UI。
|
||||
|
||||
作为多平台框架的优势使得这套 UI 能在更多的平台上呈现，并可被熟悉开发语言的开发者快速引入并使用。
|
||||
|
||||
项目在 Android 原生平台的基本架构已经稳定，这套 UI 在 2022 年在 Android 平台的原生版本就已经完工，但是我迟迟没有将它开源出来，目前正在重新实现多平台对接，待多平台完善后将会重新进行开源。
|
||||
|
||||
对于 Android 版本有一个预览版 [FlexiUI-Preview](https://github.com/BetterAndroid/FlexiUI-Preview)，如果你感兴趣，你可以 [加入 Telegram 群组](https://t.me/BetterAndroid) 联系我添加查看权限。
|
||||
|
||||
这套 UI 预计将会支持 `Jetpack Compose`、`Flutter`。
|
||||
|
||||
将会优先支持 `Jetpack Compose` 并发布在 `compose` 分支。
|
||||
|
||||
主分支 `main` 将仅做说明文档，届时更多内容请查看其它相关分支。
|
||||
|
||||
如果你对此项目感兴趣，你可以点击右上角的 `Star` 和 `Watch` 来关注此项目。
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> **Jetpack Compose 部分的开发正在进行。**
|
||||
>
|
||||
> 你可以在此页面左上角点击 `main` 分支，切换到 `compose-dev` 分支来查看当前的工作进度。
|
||||
We are working hard to improve it and it is expected to be released soon, so stay tuned.
|
||||
|
||||
## Design Preview
|
||||
|
||||
|
||||
Reference in New Issue
Block a user