Merge pull request #218 from AuroraZiling/main

[Docs] Update
kikipoulet · Jun 15, 2024 · 2046b87 · 2046b87
2 parents 601bcd4 + c80d23f
commit 2046b87
Show file tree

Hide file tree

Showing 21 changed files with 186 additions and 0 deletions.
diff --git a/docs/docs/.vitepress/config/en.mts b/docs/docs/.vitepress/config/en.mts
@@ -42,6 +42,7 @@ export const en = defineConfig({
               { text: 'StackPage', link: '/documentation/controls/layout/stackpage' },
               { text: 'SettingsLayout', link: '/documentation/controls/layout/settingslayout' },
               { text: 'SukiWindow', link: '/documentation/controls/layout/sukiwindow' },
+              { text: 'Dock', link: '/zh/documentation/controls/layout/dock' },
             ]
           },
           {
@@ -109,6 +110,8 @@ export const en = defineConfig({
           { text: 'Dialog', link: '/documentation/notification/dialog' },
           { text: 'Toast', link: '/documentation/notification/toast' },
           { text: 'MessageBox', link: '/documentation/notification/messagebox' },
+          { text: 'InfoBar', link: '/zh/documentation/notification/infobar' },
+          { text: 'InfoBadge', link: '/zh/documentation/notification/infobadge' },
         ]
       },
       {

diff --git a/docs/docs/.vitepress/config/zh.mts b/docs/docs/.vitepress/config/zh.mts
@@ -42,6 +42,7 @@ export const zh = defineConfig({
               { text: 'StackPage', link: '/zh/documentation/controls/layout/stackpage' },
               { text: 'SettingsLayout', link: '/zh/documentation/controls/layout/settingslayout' },
               { text: 'SukiWindow', link: '/zh/documentation/controls/layout/sukiwindow' },
+              { text: 'Dock', link: '/zh/documentation/controls/layout/dock' },
             ]
           },
           {
@@ -109,6 +110,8 @@ export const zh = defineConfig({
           { text: 'Dialog', link: '/zh/documentation/notification/dialog' },
           { text: 'Toast', link: '/zh/documentation/notification/toast' },
           { text: 'MessageBox', link: '/zh/documentation/notification/messagebox' },
+          { text: 'InfoBar', link: '/zh/documentation/notification/infobar' },
+          { text: 'InfoBadge', link: '/zh/documentation/notification/infobadge' },
         ]
       },
       {

diff --git a/docs/docs/documentation/controls/inputs/button.md b/docs/docs/documentation/controls/inputs/button.md
@@ -0,0 +1,35 @@
+# Button
+
+SukiUI has a handful of button styles, available in both the standard primary color, but also in the theme's accent color.
+
+## Show
+
+<img src="/controls/inputs/button.webp" height="300px" width="300px"/>
+
+- Busy
+
+<img src="/controls/inputs/button-busy.gif" height="300px" width="300px"/>
+
+## Example
+
+```xml
+<Button>
+    <!-- Content -->
+</Button>
+```
+
+### Busy
+
+```xml
+...
+xmlns:theme="clr-namespace:SukiUI.Theme;assembly=SukiUI"
+...
+
+<Button theme:ButtonExtensions.ShowProgress="true">
+    <!-- Content -->
+</Button>
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ButtonsView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ButtonsView.axaml)
diff --git a/docs/docs/documentation/controls/inputs/dropdownbutton.md b/docs/docs/documentation/controls/inputs/dropdownbutton.md
@@ -0,0 +1,23 @@
+# DropDownButton
+
+When you click on the `DropDownButton`, the custom content will pop up.
+
+## Show
+
+<img src="/controls/inputs/dropdownbutton.webp" height="300px" width="300px"/>
+
+## Example
+
+```xml
+<DropDownButton Content="Click To Open">
+    <DropDownButton.Flyout>
+        <Flyout>
+            <!-- Content -->
+        </Flyout>
+    </DropDownButton.Flyout>
+</DropDownButton>
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/MiscView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/MiscView.axaml)
diff --git a/docs/docs/documentation/controls/inputs/togglebutton.md b/docs/docs/documentation/controls/inputs/togglebutton.md
@@ -0,0 +1,15 @@
+# ToggleButton
+
+## Show
+
+<img src="/controls/inputs/togglebutton.gif" height="300px" width="300px"/>
+
+## Example
+
+```xml
+<ToggleButton Content="Toggle Me" />
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml)
diff --git a/docs/docs/documentation/controls/inputs/toggleswitch.md b/docs/docs/documentation/controls/inputs/toggleswitch.md
@@ -0,0 +1,17 @@
+# ToggleSwitch
+
+## Show
+
+<img src="/controls/inputs/toggleswitch.gif" height="300px" width="300px"/>
+
+## Example
+
+```xml
+<ToggleSwitch IsChecked="True" />
+
+<ToggleSwitch OffContent="Switch Off." OnContent="Switch On." />
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml)
diff --git a/docs/docs/documentation/controls/layout/dock.md b/docs/docs/documentation/controls/layout/dock.md
diff --git a/docs/docs/documentation/notification/infobadge.md b/docs/docs/documentation/notification/infobadge.md
diff --git a/docs/docs/documentation/notification/infobar.md b/docs/docs/documentation/notification/infobar.md
diff --git a/docs/docs/public/controls/inputs/button-busy.gif b/docs/docs/public/controls/inputs/button-busy.gif
diff --git a/docs/docs/public/controls/inputs/button.webp b/docs/docs/public/controls/inputs/button.webp
diff --git a/docs/docs/public/controls/inputs/dropdownbutton.webp b/docs/docs/public/controls/inputs/dropdownbutton.webp
diff --git a/docs/docs/public/controls/inputs/togglebutton.gif b/docs/docs/public/controls/inputs/togglebutton.gif
diff --git a/docs/docs/public/controls/inputs/toggleswitch.gif b/docs/docs/public/controls/inputs/toggleswitch.gif
diff --git a/docs/docs/zh/documentation/controls/inputs/button.md b/docs/docs/zh/documentation/controls/inputs/button.md
@@ -0,0 +1,35 @@
+# Button
+
+SukiUI 提供了多种样式的按钮，并支持添加主题色
+
+## 展示
+
+<img src="/controls/inputs/button.webp" height="300px" width="300px"/>
+
+- Busy
+
+<img src="/controls/inputs/button-busy.gif" height="300px" width="300px"/>
+
+## 示例
+
+```xml
+<Button>
+    <!-- Content -->
+</Button>
+```
+
+### Busy
+
+```xml
+...
+xmlns:theme="clr-namespace:SukiUI.Theme;assembly=SukiUI"
+...
+
+<Button theme:ButtonExtensions.ShowProgress="true">
+    <!-- Content -->
+</Button>
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ButtonsView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ButtonsView.axaml)
diff --git a/docs/docs/zh/documentation/controls/inputs/dropdownbutton.md b/docs/docs/zh/documentation/controls/inputs/dropdownbutton.md
@@ -0,0 +1,23 @@
+# DropDownButton
+
+点击`DropDownButton`后，将会弹出自定义的内容
+
+## 展示
+
+<img src="/controls/inputs/dropdownbutton.webp" height="300px" width="300px"/>
+
+## 示例
+
+```xml
+<DropDownButton Content="Click To Open">
+    <DropDownButton.Flyout>
+        <Flyout>
+            <!-- Content -->
+        </Flyout>
+    </DropDownButton.Flyout>
+</DropDownButton>
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/MiscView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/MiscView.axaml)
diff --git a/docs/docs/zh/documentation/controls/inputs/togglebutton.md b/docs/docs/zh/documentation/controls/inputs/togglebutton.md
@@ -0,0 +1,15 @@
+# ToggleButton
+
+## 展示
+
+<img src="/controls/inputs/togglebutton.gif" height="300px" width="300px"/>
+
+## 示例
+
+```xml
+<ToggleButton Content="Toggle Me" />
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml)
diff --git a/docs/docs/zh/documentation/controls/inputs/toggleswitch.md b/docs/docs/zh/documentation/controls/inputs/toggleswitch.md
@@ -0,0 +1,17 @@
+# ToggleSwitch
+
+## 展示
+
+<img src="/controls/inputs/toggleswitch.gif" height="300px" width="300px"/>
+
+## 示例
+
+```xml
+<ToggleSwitch IsChecked="True" />
+
+<ToggleSwitch OffContent="Switch Off." OnContent="Switch On." />
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TogglesView.axaml)
diff --git a/docs/docs/zh/documentation/controls/layout/dock.md b/docs/docs/zh/documentation/controls/layout/dock.md
diff --git a/docs/docs/zh/documentation/notification/infobadge.md b/docs/docs/zh/documentation/notification/infobadge.md
diff --git a/docs/docs/zh/documentation/notification/infobar.md b/docs/docs/zh/documentation/notification/infobar.md