From 294f7a9a6e451586e7d4147485766c72e6a269a1 Mon Sep 17 00:00:00 2001 From: Jason Lee Date: Wed, 7 May 2025 16:09:16 +0800 Subject: [PATCH] doc: Update README for add features. (#835) --- README.md | 58 ++++++++++--------------------------------------------- 1 file changed, 10 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index b12af423..542b5601 100644 --- a/README.md +++ b/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. - -SCR-20250107-kagq -SCR-20250107-kaky -SCR-20250107-kapd -SCR-20250107-kfvk +Image 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.