SurrealismUI V0.3.0

[syf20020816]

SurrealismUI

• author：[email protected]
• createDate：20230908
• updateDate：20231225
• version：0.3.0
• email：[email protected]

SurrealismUI is a third-party component library built entirely using Slint

Install

use Slimk

1. Install Slimk : https://github.com/Surrealism-All/slimk
2. run slimk create hello --template slimk

Github

1. GoTo ：https://github.com/Surrealism-All/SurrealismUI/releases
2. Find the latest release

QuickStart

Config SurrealismUI as Library (optional)

1. Open VsCode and choose Settings , then search Slint:Library Paths
2. Choose edit in settings.json
3. Find slint.libraryPaths and add "SurrealismUI":"parent_file_path\\surrealism-ui\\index.slint"❗

  "slint.libraryPaths": {
    "SurrealismUI":"E:\\test_try\\test-surrealism\\ui\\modules\\surrealism-ui\\index.slint"
  },

Import and Use

import { STag,SCard,SInput,SText,SButton  } from "./modules/surrealism-ui/index.slint";

export component App inherits Window {
  height: 600px;
  width: 800px;
  title: "Surrealism";
  Rectangle {
    VerticalLayout {
      padding: 20px;
      spacing: 60px;
      SText {
        height: 3rem;
        text: "SurrealismUI";
      }
      SButton {
        text: "Try SurrealismUI";
      }
      SCard {
        STag{
          theme: Warning;
          text:"test tag";
        }
      }
      Rectangle {
        SInput{
          theme: Primary;
          placeholder :"please enter your username";
          card-width:300px;
          clearable: true;
          text:"SurrealismUI - input";
          accepted(res)=>{
            debug("content in input:" + res);
          }
          changed(change-res)=>{
            debug(change-res);
          }
        }
      }
    }
  }
}

What SurrealismUI Do？

			  default
————————————————————————————————————
|  logic control layer (Rust|C++)  |
————————————————————————————————————
				⇕
————————————————————————————————————
|    UI layer (write components)   |
————————————————————————————————————

		   SurrealismUI
————————————————————————————————————
|  logic control layer (Rust|C++)  |
————————————————————————————————————
				⇕
————————————————————————————————————
|      UI Styles Wrapper layer     |   <-- What SurrealismUI do , see ①
————————————————————————————————————
|   UI layer (write components)    |
————————————————————————————————————

①：define a lot replaceable theme styles and binding styles use theme property , can be customized in slint file or logic control layer , means: all system components are wrapped (Customizing themes in third-party component libraries is very affordable as it acts on the UI layer. slint is like an integration of HTML and CSS, so I use this way)(By binding global singleton variables to styles, any component that uses variables can change styles simultaneously)

				System support (like iced)
————————————————————————————————————      ————————————————
|           logic control          | -->  | Theme::Light |
————————————————————————————————————      ————————————————
|             UI layer             |     		  ↓
———————————————————————————————————— 	    |————————————|
						 ↑			     ↓            ↓
				import	  ← Light_Theme Styles   Dark_Theme Styles

## Diff
Slint differs from other GUI frameworks in that the UI layer is completed through. slint, which I believe is good and brings many advantages (compatibility with different platforms, instant preview, maintainability, parallel development, etc.). But this also leads to SLIT being unable to easily customize the theme of the component. Theme customization and switching are dynamic to static processes, which require a lot of logical processing, and this is also same as (HTML+CSS+js | ts)

Themes

Built in 7 theme colors in SurrealismUI

themes-color

Wiki

https://github.com/Surrealism-All/SurrealismUI/wiki

I will try my best to update wiki 😂 (please waiting...)

Components

• SText ：It is the simplest and most common component in SurrealismUI
• SButton ：SButton is a button component that you can freely perform regular attribute operations on
• SIcon ：this is a icon container , better than Image
• SInput ：This is a basic input box, often used in forms, divided into two types: text and password
• SCard ：A very simple universal card without any layout or restrictions ， you can add anything you want to the card
• SStar ： SStar is a scoring component
• SSelect ：SSelect is a selector that provides three types of optional input parameter values
• STag ：A small tag used to display data
• SHeader ：SHeader is a simple header component that is generated based on routing information
• STable ：This is the outter of the Table, and the column data of the table is separated from the outter . The outter only serves as a standard layout , this is a zero cost construction
• STableColumn ：STableColumn is a component of STable, and each STableColumn forms a complete column of the table . If it's gone, the table will become a card with a horizontal layout
• SCollapse ：SCollapse is a foldable panel. This is the outter of the Collapse, what really works is SCollapseItem. The outter only serves as a standard layout , this is a zero cost construction
• SCollapseItem ：SCollapseItem is a component of SCollapse, without which SCollapse will not work , You can customize the components or use the default text display method in it
• SResult ：SResult helps you easily build a quick prompt , you can build it in popup window
• SAvatar ：SAvatar is a avatar component that defaults to Icons.Avatar when there are no images available
• SLink ：SLink is commonly used to represent text connections or sharing
• SDivider ：A divider groups sections of content to create visual rhythm and hierarchy. Use dividers along with spacing and headers to organize content in your layout.
• SPopup ：A masked pop-up layer appears in the current window . And users will not be able to use the pop-up layer to cover the components under it. Clicking on the pop-up layer again will close it
• SCollection ：SCollection is an expandable box that can be zoomed in or out by clicking (internal can also be used)
• SRadio ：Radio let people select a single item
• SBadge ：SBadge is a quick way to display user status or events
• SPersona ：This component is used to display simple user introduction information
• SProgress ：SProgress is commonly used to display download progress or event processing progress . And you can fully control it through the progress property
• STip ：A tip provides supplemental, contextual information elevated near its target component
• SLoading ： This is a loading component that you can embed anywhere you want to add a loading animation
• SDialog ：SDialogs are used to confirm messages or events and display text
• SMenu ：SMenu is a menu bar located on the left side that you can quickly generate through the menu-data property
• SSwitch ：SSwitch is a switch used for simple judgment scenarios
• SDrawer ：Sometimes, the Dialogue component does not meet our needs , such as your form being too long, or if you need to temporarily display some documents, please use the SDrawer
• SAlert ：SAlert is used to display important prompt information on the page
• SSwitchGroup ：SSwitchGroup switch group can contain more switch cases
• STree ：STree can be used to display directory structure, forming a parent-child relationship, and can be easily displayed
• SFile ：SFile can help users present file selectors GUI

Updates

中文

V0.3.0版本是一个重大变更的版本，几乎所有的组件都经历了一次重构，优化了所有组件的结构，对整体项目目录进行了调整，处理了在之前版本中的不合理问题（组件名字，组件属性，方法，回调，内置方法，内置属性，内置Global等）。本次大更新更探索了类似于VNode的可能性（但目前并没有完美的方案）。将所有组件属性进行提取并使用结构体进行管理，这使得对组件样式的控制更加彻底，并使得使用rust，c++，js动态控制组件更加容易，动态生成组件这一需求也得到了解决。

在本次大型更新后，SurrealismUI中属性的写法与原生属性更加接近，这不仅减少了学习成本，更有利于使用者的理解。在后续0.3.x的版本中将会持续优化(每个版本的更新周期约2周)。此外0.3.0版本后可能不再涉及如此大范围的更新，该项目的稳定性将会持续提升。

感谢各位的阅读，如果您有任何问题，请发送邮件到[email protected]或在SurrealismUI仓库的讨论或issue中提出

---

English

V0.3.0 is a major change version. Almost all components have undergone a rebuiding, optimizing the structure of all components, adjusting the overall project directory, and dealing with unreasonable problems in the previous version (component name, component properties, functions, callbacks, built-in functions, built-in properties, built-in Global, ...). This big update explores the possibility of something similar to VNode (but there is no perfect solution at present). All component attributes are extracted and managed by using struct, which makes the control of component style more thorough, and makes it easier to use Rust, C + +, JS to dynamically control components, and the requirement of dynamically generating components is also solved.

After this major update, the writing of attributes in SurrealismUI is closer to the native attributes, which not only reduces the learning cost, but also is more conducive to the user's understanding. Optimization will continue in subsequent 0.3.x releases (approximately 2 weeks per release). In addition, the 0.3.0 version may no longer involve such a wide range of updates, and the stability of the project will continue to improve.

Thank you for reading, and if you have any questions, please send an email to [email protected] or raise them in a discussion or issue at the SurrealismUI repository

• V0.3.0 (Slint 1.3.2)
  • 中文
    • 所有组件更名SUR为S
    • 默认文字采用Arial
    • 重写所有组件 (SMenu 除外)
    • 重构themes/index.slint（用于导出内置Schema，内置Global）
    • 增加use方式导出内置方法，内置结构体，内置枚举等
    • 使用use方式对组件进行插槽预备
    • 修改内置主题色
    • 重构项目结构
  • English
    • Renaming all components from SUR to S
    • Default text adopts Arial
    • Rewrite all components（except SMenu）
    • Refactoring themes/index. slint (used to export built-in schemas, built-in Global)
    • Add use mode to export built-in functions, built-in struct, built-in enum, etc
    • Prepare slots for components using the use method
    • Modify built-in theme colors
    • Refactoring project structure