surrealism-ui-book

.gitignore

@@ -0,0 +1 @@
+book

README.md

@@ -0,0 +1,16 @@
+<img src="https://img.shields.io/badge/SurrealismUI-0.4.1-orange?style=flat-square&logo=rust&logoColor=%23fff&labelColor=%23DEA584&color=%23DEA584"> <img src="https://img.shields.io/badge/License-MIT-orange?style=flat-square&logoColor=%23fff&labelColor=%2323B898&color=%2323B898">
+
+# SurrealismUI
+
+- author：[email protected]
+- createDate：20230908
+- updateDate：20240324
+- version：0.4.1
+- email：[email protected]
+- discord：[Surrealism-UI](https://discord.gg/KSQqrSMCnU)
+
+<img src="./static/logo.png" />
+
+**SurrealismUI is a third-party component library built entirely using Slint**
+
+**If you have any ideas or wanna to be contributor, join Discord!**

book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["syf20020816"]
+language = "en"
+multilingual = false
+src = "src"
+title = "SurrealismUI Book"

src/SUMMARY.md

@@ -0,0 +1,57 @@
+# Summary
+
+- [Introduction](../README.md)
+- [Ecology](./ecology.md)
+- [Install](./install/install.md)
+  - [Cargo-Generate 👍](./install/cargo-generate.md)
+  - [Github](./install/github.md)
+- [Quickstart](./quckstart.md)
+- [Themes](./themes.md)
+- [Components(Wdigets)](./components/components.md)
+  - [OverAll](./components/over-all.md)
+  - [Basic](./components/basic/basic.md)
+    - [SText](./components/basic/text.md)
+    - [SButton](./components/basic/button.md)
+    - [SDivider](./components/basic/divider.md)
+    - [SIcon](./components/basic/icon.md)
+    - [SCard](./components/basic/card.md)
+  - [Data](./components/data/data.md)
+    - [STag](./components/data/tag.md)
+    - [STable](./components/data/table.md)
+    - [SCollapse](./components/data/collapse.md)
+    - [SAvatar](./components/data/avatar.md)
+    - [SCollection](./components/data/collection.md)
+    - [SPersona](./components/data/persona.md)
+    - [SBadge](./components/data/badge.md)
+    - [SProgress](./components/data/progress.md)
+    - [STree](./components/data/tree.md)
+    - [SFile](./components/data/file.md)
+    - [STep](./components/data/step.md)
+    - [SKeyBoard](./components/data/keyboard.md)
+    - [SPagination](./components/data/pagination.md)
+  - [Form](./components/form/form.md)
+    - [SInput](./components/form/input.md)
+    - [SStar](./components/form/star.md)
+    - [SSelect](./components/form/select.md)
+    - [SLink](./components/form/link.md)
+    - [SRadio](./components/form/radio.md)
+    - [SSwitch](./components/form/switch.md)
+    - [SSwitchGroup](./components/form/switch-group.md)
+  - [Nav](./components/nav/nav.md)
+    - [SHeader](./components/nav/header.md)
+    - [SMenu](./components/nav/menu.md)
+    - [STab](./components/nav/tab.md)
+  - [Feedback](./components/feedback/feedback.md)
+    - [Result](./components/feedback/result.md)
+    - [SPopup](./components/feedback/popup.md)
+    - [SPopover](./components/feedback/popover.md)
+    - [STip](./components/feedback/tip.md)
+    - [SLoading](./components/feedback/loading.md)
+    - [SDialog](./components/feedback/dialog.md)
+    - [SDrawer](./components/feedback/drawer.md)
+    - [SAlert](./components/feedback/alert.md)
+- [Build-In](./build-in/build-in.md)
+  - [Global](./build-in/global.md)
+  - [Struct Enum](./build-in/struct.md)
+  - [Function](./build-in/function.md)
+- [Updates](./updates.md)

src/build-in/build-in.md

@@ -0,0 +1,5 @@
+# Build-In
+
+<p style="color: #FB3746;font-weight: 700;font-size:18px;">
+If you want to explore more powerful features, please read this chapter; otherwise, you can skip it
+</p>

src/build-in/function.md

@@ -0,0 +1,28 @@
+# Function
+
+## `UseSurrealismFn`
+- pure public function count-height(h:length,padding:length)->length : count component height
+- pure public function count-width(w:length,padding:length)->length : count component weight
+- pure public function get-padding(size:PaddingType)->PaddingProps : get padding by PaddingType
+- pure public function get-shadow(shadow:ShadowType)->ShadowProps : get shadow by ShadowType
+- pure public function get-shadow-x(shadow:ShadowType)->length : get shadow x by ShadowType
+- pure public function get-shadow-y(shadow:ShadowType)->length : get shadow y by ShadowType
+- pure public function get-shadow-blur(shadow:ShadowType)->length : get shadow blur by ShadowType
+- pure public function get-border(border:BorderType)->BorderProps : get border by BorderType
+- pure public function get-space(w:length) -> length : get spacing by component width
+- pure public function deeper(theme:Themes,color:brush)->brush : get deeper theme color
+  - pure public function light-deeper(color:brush)->brush : get deeper light theme color
+  - pure public function primary-deeper(color:brush)->brush : get deeper primary theme color
+  - pure public function success-deeper(color:brush)->brush : get deeper success theme color
+  - pure public function info-deeper(color:brush)->brush : get deeper info theme color
+  - pure public function warning-deeper(color:brush)->brush : get deeper warning theme color
+  - pure public function error-deeper(color:brush)->brush : get deeper error theme color
+  - pure public function dark-deeper(color:brush)->brush : get deeper dark theme color
+- pure public function get-color(theme:Themes,level:ColorLevel)->brush : get color by theme and ColorLevel
+  - pure public function get-color-light(level:ColorLevel)->brush : get light color by ColorLevel
+  - pure public function get-color-dark(level:ColorLevel)->brush : get dark color by ColorLevel
+  - pure public function get-color-primary(level:ColorLevel)->brush : get primary color by ColorLevel
+  - pure public function get-color-info(level:ColorLevel)->brush : get info color by ColorLevel
+  - pure public function get-color-warning(level:ColorLevel)->brush : get warning color by ColorLevel
+  - pure public function get-color-success(level:ColorLevel)->brush : get success color by ColorLevel
+  - pure public function get-color-error(level:ColorLevel)->brush : get error color by ColorLevel