doc: Update README for add features. (#835)
This commit is contained in:
parent
6514aec22a
commit
294f7a9a6e
1 changed files with 10 additions and 48 deletions
58
README.md
58
README.md
|
|
@ -1,55 +1,23 @@
|
|||
# GPUI Component
|
||||
|
||||
> This is still an early stage of development, we may change API frequently.
|
||||
> But the features is ok to use, you must keep tracking our changes.
|
||||
|
||||
UI components for building fantastic desktop application by using [GPUI](https://gpui.rs).
|
||||
|
||||
## Features
|
||||
|
||||
- Accordion
|
||||
- Alert
|
||||
- Badge
|
||||
- Breadcrumb
|
||||
- Button, Link
|
||||
- Checkbox, Radio, Switch
|
||||
- ColorPicker
|
||||
- DatePicker, DateRangePicker, Calendar
|
||||
- Dock, Tiles
|
||||
- Drawer
|
||||
- Dropdown
|
||||
- Icon
|
||||
- Label
|
||||
- List
|
||||
- Menu
|
||||
- Modal
|
||||
- Notification
|
||||
- Popover
|
||||
- Progress & Indicator
|
||||
- Resizable
|
||||
- Sidebar
|
||||
- Skeleton
|
||||
- Slider
|
||||
- Table
|
||||
- Tabs
|
||||
- TextInput, TextArea, OtpInput
|
||||
- TextView (Markdown, Simple HTML) to native rendering, syntax highlighting.
|
||||
- Theming
|
||||
- TitleBar
|
||||
- Toggle, ToggleGroup
|
||||
- Tooltip
|
||||
- WebView
|
||||
- **Richness**: 40+ cross-platform desktop UI components.
|
||||
- **Native**: Inspired by macOS and Windows controls, combined with shadcn/ui design for a modern experience.
|
||||
- **Ease of Use**: Stateless `RenderOnce` components, simple and user-friendly.
|
||||
- **Customizable**: Built-in `Theme` and `ThemeColor`, supporting multi-theme and variable-based configurations.
|
||||
- **Versatile**: Supports sizes like `xs`, `sm`, `md`, and `lg`.
|
||||
- **Flexible Layout**: Dock layout for panel arrangements, resizing, and freeform (Tiles) layouts.
|
||||
- **High Performance**: Virtualized Table and List components for smooth large-data rendering.
|
||||
- **Content Rendering**: Native support for Markdown and simple HTML.
|
||||
|
||||
## Showcase
|
||||
|
||||
Here is the first application: [Longbridge](https://longbridge.com) that is built by using GPUI Component.
|
||||
Here is the first application: [Longbridge Pro](https://longbridge.com/desktop) that is built by using GPUI Component.
|
||||
|
||||
> It still under development, not published yet.
|
||||
|
||||
<img width="2017" alt="SCR-20250107-kagq" src="https://github.com/user-attachments/assets/55f9e012-34ce-44d1-908f-768f8d2c8abf" />
|
||||
<img width="2017" alt="SCR-20250107-kaky" src="https://github.com/user-attachments/assets/a56995ca-1c54-43bb-9a27-bc9023a169dd" />
|
||||
<img width="2017" alt="SCR-20250107-kapd" src="https://github.com/user-attachments/assets/ecdfe8cd-f8d8-4df4-bafe-ab2d8517f8db" />
|
||||
<img width="2017" alt="SCR-20250107-kfvk" src="https://github.com/user-attachments/assets/ccc4f25f-16c2-4140-a2ad-d194aadaa544" />
|
||||
<img width="1763" alt="Image" src="https://github.com/user-attachments/assets/3e2f4eb7-fd27-4343-b6dc-184465599e99" />
|
||||
|
||||
We build multi-themes support in application, this feature is not including in GPUI Component. It is based on `Theme` feature, so it easy to do.
|
||||
|
||||
|
|
@ -83,12 +51,6 @@ GPUI Component have `Icon` element, but it does not include SVG files by default
|
|||
The example is using [Lucide](https://lucide.dev) icons, but you can use any icons you like, just named the svg files like [IconName](https://github.com/longbridge/gpui-component/blob/main/crates/ui/src/icon.rs#L86) defined the path name.
|
||||
You can add icons that you need in your project.
|
||||
|
||||
## Demo
|
||||
|
||||
If you want to see the demo, here is a some demo applications.
|
||||
|
||||
- [gallery-app-windows.zip](https://github.com/user-attachments/files/19796209/gallery.zip) - Updated at 2025/04/17
|
||||
|
||||
## Development
|
||||
|
||||
We have a gallery of applications built with GPUI Component.
|
||||
|
|
|
|||
Loading…
Reference in a new issue