Merge pull request #268 from AuroraZiling/main

Docs update & Bump Avalonia Version 11.1.2
kikipoulet · Aug 11, 2024 · 70b42ee · 70b42ee
2 parents 4eb86af + 6640d66
commit 70b42ee
Show file tree

Hide file tree

Showing 22 changed files with 262 additions and 17 deletions.
diff --git a/SukiUI.Demo/SukiUI.Demo.csproj b/SukiUI.Demo/SukiUI.Demo.csproj
@@ -9,18 +9,19 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Avalonia" Version="11.1.0" />
-		<PackageReference Include="Avalonia.AvaloniaEdit" Version="11.0.6" />
-		<PackageReference Include="Avalonia.Desktop" Version="11.1.0" />
-		<PackageReference Include="Avalonia.Fonts.Inter" Version="11.1.0" />
+		<PackageReference Include="Avalonia" Version="11.1.2" />
+		<PackageReference Include="Avalonia.AvaloniaEdit" Version="11.1.0" />
+		<PackageReference Include="Avalonia.Controls.ColorPicker" Version="11.1.2" />
+		<PackageReference Include="Avalonia.Desktop" Version="11.1.2" />
+		<PackageReference Include="Avalonia.Fonts.Inter" Version="11.1.2" />
 		<!--Condition below is needed to remove Avalonia.Diagnostics package from build output in Release configuration.-->
 		<PackageReference Condition="'$(Configuration)' == 'Debug'" Include="Avalonia.Diagnostics" Version="11.1.0" />
-		<PackageReference Include="Avalonia.Themes.Fluent" Version="11.1.0" />
-		<PackageReference Include="AvaloniaEdit.TextMate" Version="11.0.6" />
+		<PackageReference Include="Avalonia.Themes.Fluent" Version="11.1.2" />
+		<PackageReference Include="AvaloniaEdit.TextMate" Version="11.1.0" />
 		<PackageReference Include="CommunityToolkit.Mvvm" Version="8.2.2" />
-		<PackageReference Include="Dock.Avalonia" Version="11.1.0-rc1" />
-		<PackageReference Include="Dock.Model" Version="11.1.0-rc1" />
-		<PackageReference Include="Dock.Model.Avalonia" Version="11.1.0-rc1" />
+		<PackageReference Include="Dock.Avalonia" Version="11.1.0.1" />
+		<PackageReference Include="Dock.Model" Version="11.1.0.1" />
+		<PackageReference Include="Dock.Model.Avalonia" Version="11.1.0.1" />
 		<PackageReference Include="Material.Icons.Avalonia" Version="2.1.10" />
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.0-preview.3.24172.9" />
 		<PackageReference Include="ShowMeTheXaml.Avalonia" Version="1.5.1" />

diff --git a/SukiUI.Dock/SukiUI.Dock.csproj b/SukiUI.Dock/SukiUI.Dock.csproj
@@ -14,8 +14,8 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="Dock.Avalonia" Version="11.1.0-rc1" />
-      <PackageReference Include="Dock.Model.Avalonia" Version="11.1.0-rc1" />
+      <PackageReference Include="Dock.Avalonia" Version="11.1.0.1" />
+      <PackageReference Include="Dock.Model.Avalonia" Version="11.1.0.1" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/SukiUI/SukiUI.csproj b/SukiUI/SukiUI.csproj
@@ -28,10 +28,10 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Avalonia" Version="11.1.0" />
-		<PackageReference Include="Avalonia.Skia" Version="11.1.0" />
+		<PackageReference Include="Avalonia" Version="11.1.2" />
+		<PackageReference Include="Avalonia.Skia" Version="11.1.2" />
 		<PackageReference Include="SkiaSharp" Version="2.88.8" />
-		<PackageReference Include="Avalonia.Controls.DataGrid" Version="11.1.0" />
+		<PackageReference Include="Avalonia.Controls.DataGrid" Version="11.1.2" />
 		<PackageReference Include="Avalonia.Themes.Simple" Version="11.1.0" />
 		<PackageReference Include="ReactiveUI" Version="20.1.1" />
 	</ItemGroup>

diff --git a/docs/docs/.vitepress/config/zh.mts b/docs/docs/.vitepress/config/zh.mts
@@ -93,7 +93,7 @@ export const zh = defineConfig({
             ]
           },
           {
-            text: 'System',
+            text: '系统 API',
             items: [
               { text: 'FilePicker', link: '/zh/documentation/controls/system/filepicker' },
             ]

diff --git a/docs/docs/documentation/controls/navigation/sidemenu.md b/docs/docs/documentation/controls/navigation/sidemenu.md
@@ -9,7 +9,9 @@
 ## Example
 
 ```xml
-<suki:SukiSideMenu>
+<suki:SukiSideMenu 
+    IsSearchEnabled="True"  // Enabled Search function
+    >
     <suki:SukiSideMenu.Items>
         <suki:SukiSideMenuItem Header="Statistics">
             <suki:SukiSideMenuItem.Icon>
@@ -21,6 +23,18 @@
         </suki:SukiSideMenuItem>
     </suki:SukiSideMenu.Items>
 
+    <suki:SukiSideMenu.ItemTemplate>
+        <DataTemplate>
+            <suki:SukiSideMenuItem 
+                Classes="Compact"  // Enabled Compact SideMenuItem style
+                Header="{Binding DisplayName}">
+                <suki:SukiSideMenuItem.Icon>
+                    <avalonia:MaterialIcon Kind="{Binding Icon}" />
+                </suki:SukiSideMenuItem.Icon>
+            </suki:SukiSideMenuItem>
+        </DataTemplate>
+    </suki:SukiSideMenu.ItemTemplate>
+
     <suki:SukiSideMenu.HeaderContent>
         <!-- Header Content -->
     </suki:SukiSideMenu.HeaderContent>

diff --git a/docs/docs/documentation/controls/progress/circleprogressbar.md b/docs/docs/documentation/controls/progress/circleprogressbar.md
@@ -0,0 +1,26 @@
+# CircleProgressBar
+
+Circle Progress Bar
+
+## Show
+
+<img src="/controls/progress/circleprogressbar.gif" height="300px" width="200px"/>
+
+## Example
+
+```xml
+<suki:CircleProgressBar IsIndeterminate="{Binding IsIndeterminate}"
+                        StrokeWidth="11"
+                        Value="{Binding ProgressValue}">
+    <TextBlock Margin="0,2,0,0"  // Show percentage
+               Classes="h3"
+               IsVisible="{Binding IsTextVisible}"
+               Text="{Binding ProgressValue, StringFormat={}{0:#0}%}" />
+</suki:CircleProgressBar>
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/CircleProgressBar.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/CircleProgressBar.axaml.cs)
diff --git a/docs/docs/documentation/controls/progress/loading.md b/docs/docs/documentation/controls/progress/loading.md
@@ -0,0 +1,19 @@
+# Loading
+
+Loading Indicator
+
+## Show
+
+<img src="/controls/progress/loading.gif" height="300px" width="200px"/>
+
+## Example
+
+```xml
+<suki:Loading />
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/Loading.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/Loading.axaml.cs)
diff --git a/docs/docs/documentation/controls/progress/progressbar.md b/docs/docs/documentation/controls/progress/progressbar.md
@@ -0,0 +1,17 @@
+# ProgressBar
+
+Progress Bar
+
+## Show
+
+<img src="/controls/progress/progressbar.gif" height="300px" width="400px"/>
+
+## Example
+
+```xml
+<ProgressBar IsIndeterminate="{Binding IsIndeterminate}" ShowProgressText="{Binding IsTextVisible}" Value="{Binding ProgressValue}"/>
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
diff --git a/docs/docs/documentation/controls/progress/stepper.md b/docs/docs/documentation/controls/progress/stepper.md
@@ -0,0 +1,25 @@
+# Stepper
+
+A bar that guides users through the steps of a task
+
+## Show
+
+<img src="/controls/progress/stepper.gif" height="300px" width="300px"/>
+
+## Example
+
+```xml .axaml
+<suki:Stepper Index="{Binding StepIndex}" Steps="{Binding Steps}" />
+```
+
+```csharp
+[ObservableProperty] private int _stepIndex = 1;
+public IEnumerable<string> Steps { get; } = 
+                           ["First Step", "Second Step", "Third Step"];
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/Stepper.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/Stepper.axaml.cs)
diff --git a/docs/docs/documentation/controls/progress/waveprogress.md b/docs/docs/documentation/controls/progress/waveprogress.md
@@ -0,0 +1,21 @@
+# WaveProgress
+
+Progress Controls with Wave Animation
+
+## Show
+
+<img src="/controls/progress/waveprogress.gif" height="300px" width="300px"/>
+
+## Example
+
+```xml
+<suki:WaveProgress 
+        IsTextVisible="{Binding IsTextVisible}"  // Display the percentage or not
+        Value="{Binding ProgressValue}" />
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/WaveProgress.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/WaveProgress.axaml.cs)
diff --git a/docs/docs/public/controls/navigation/sukisidemenu.webp b/docs/docs/public/controls/navigation/sukisidemenu.webp
diff --git a/docs/docs/public/controls/progress/circleprogressbar.gif b/docs/docs/public/controls/progress/circleprogressbar.gif
diff --git a/docs/docs/public/controls/progress/loading.gif b/docs/docs/public/controls/progress/loading.gif
diff --git a/docs/docs/public/controls/progress/progressbar.gif b/docs/docs/public/controls/progress/progressbar.gif
diff --git a/docs/docs/public/controls/progress/stepper.gif b/docs/docs/public/controls/progress/stepper.gif
diff --git a/docs/docs/public/controls/progress/waveprogress.gif b/docs/docs/public/controls/progress/waveprogress.gif
diff --git a/docs/docs/zh/documentation/controls/navigation/sidemenu.md b/docs/docs/zh/documentation/controls/navigation/sidemenu.md
@@ -9,7 +9,9 @@
 ## 示例
 
 ```xml
-<suki:SukiSideMenu>
+<suki:SukiSideMenu 
+    IsSearchEnabled="True"  // 启用搜索
+    >
     <suki:SukiSideMenu.Items>
         <suki:SukiSideMenuItem Header="Statistics">
             <suki:SukiSideMenuItem.Icon>
@@ -21,6 +23,18 @@
         </suki:SukiSideMenuItem>
     </suki:SukiSideMenu.Items>
 
+    <suki:SukiSideMenu.ItemTemplate>
+        <DataTemplate>
+            <suki:SukiSideMenuItem 
+                Classes="Compact"  // 启用紧凑布局
+                Header="{Binding DisplayName}">
+                <suki:SukiSideMenuItem.Icon>
+                    <avalonia:MaterialIcon Kind="{Binding Icon}" />
+                </suki:SukiSideMenuItem.Icon>
+            </suki:SukiSideMenuItem>
+        </DataTemplate>
+    </suki:SukiSideMenu.ItemTemplate>
+
     <suki:SukiSideMenu.HeaderContent>
         <!-- Header Content -->
     </suki:SukiSideMenu.HeaderContent>

diff --git a/docs/docs/zh/documentation/controls/progress/circleprogressbar.md b/docs/docs/zh/documentation/controls/progress/circleprogressbar.md
@@ -0,0 +1,26 @@
+# CircleProgressBar
+
+圆形进度条
+
+## 展示
+
+<img src="/controls/progress/circleprogressbar.gif" height="300px" width="200px"/>
+
+## 示例
+
+```xml
+<suki:CircleProgressBar IsIndeterminate="{Binding IsIndeterminate}"
+                        StrokeWidth="11"
+                        Value="{Binding ProgressValue}">
+    <TextBlock Margin="0,2,0,0"  // 百分比显示
+               Classes="h3"
+               IsVisible="{Binding IsTextVisible}"
+               Text="{Binding ProgressValue, StringFormat={}{0:#0}%}" />
+</suki:CircleProgressBar>
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/CircleProgressBar.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/CircleProgressBar.axaml.cs)
diff --git a/docs/docs/zh/documentation/controls/progress/loading.md b/docs/docs/zh/documentation/controls/progress/loading.md
@@ -0,0 +1,19 @@
+# Loading
+
+加载控件
+
+## 展示
+
+<img src="/controls/progress/loading.gif" height="300px" width="200px"/>
+
+## 示例
+
+```xml
+<suki:Loading />
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/Loading.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/Loading.axaml.cs)
diff --git a/docs/docs/zh/documentation/controls/progress/progressbar.md b/docs/docs/zh/documentation/controls/progress/progressbar.md
@@ -0,0 +1,17 @@
+# ProgressBar
+
+进度条
+
+## 展示
+
+<img src="/controls/progress/progressbar.gif" height="300px" width="400px"/>
+
+## 示例
+
+```xml
+<ProgressBar IsIndeterminate="{Binding IsIndeterminate}" ShowProgressText="{Binding IsTextVisible}" Value="{Binding ProgressValue}"/>
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
diff --git a/docs/docs/zh/documentation/controls/progress/stepper.md b/docs/docs/zh/documentation/controls/progress/stepper.md
@@ -0,0 +1,25 @@
+# Stepper
+
+指引用户分步骤完成一项任务的控件
+
+## 展示
+
+<img src="/controls/progress/stepper.gif" height="300px" width="300px"/>
+
+## 示例
+
+```xml .axaml
+<suki:Stepper Index="{Binding StepIndex}" Steps="{Binding Steps}" />
+```
+
+```csharp
+[ObservableProperty] private int _stepIndex = 1;
+public IEnumerable<string> Steps { get; } = 
+                           ["First Step", "Second Step", "Third Step"];
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/Stepper.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/Stepper.axaml.cs)
diff --git a/docs/docs/zh/documentation/controls/progress/waveprogress.md b/docs/docs/zh/documentation/controls/progress/waveprogress.md
@@ -0,0 +1,21 @@
+# WaveProgress
+
+带波浪动画的进度控件
+
+## 展示
+
+<img src="/controls/progress/waveprogress.gif" height="300px" width="300px"/>
+
+## 示例
+
+```xml
+<suki:WaveProgress 
+        IsTextVisible="{Binding IsTextVisible}"  // 是否显示百分比
+        Value="{Binding ProgressValue}" />
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ProgressView.axaml)
+
+[API: Controls/WaveProgress.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/WaveProgress.axaml.cs)