Merge pull request #282 from AuroraZiling/main

Docs Update

SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml

@@ -14,7 +14,7 @@
             <suki:GroupBox Header="InfoBar">
                 <StackPanel Classes="HeaderContent" Spacing="15">
                     <TextBlock>
-                        InfoBar is a control that displays a message to the user. It can be used to show specific severity message to the user.
+                        InfoBar is a control that displays a message and can be used to show specific severity message to the user.
                     </TextBlock>
                     <StackPanel Orientation="Horizontal">
                         <TextBlock Margin="0,0,0,0"

docs/.gitignore

@@ -4,4 +4,4 @@ cache
 temp
 dist
 pnpm-lock.yaml
-helper
+tools

docs/docs/documentation/controls/data/expander.md

@@ -0,0 +1,31 @@
+# Expander
+
+`Expander` is a content area which can be collapsed and expanded. It has styles for all `ExpandDirections`, using custom animation behaviour and controls internally to correctly animate showing/hiding any size content.
+
+## Show
+
+<img src="/controls/data/expander.gif" />
+
+## Example
+
+```xml
+<Expander ExpandDirection="Down" Header="Down Expander">
+    <TextBlock>Some Down Content</TextBlock>
+</Expander>
+
+<Expander ExpandDirection="Up" Header="Up Expander">
+    <TextBlock>Some Up Content</TextBlock>
+</Expander>
+
+<Expander ExpandDirection="Right" Header="Right Expander">
+    <TextBlock>Some Right Content</TextBlock>
+</Expander>
+
+<Expander ExpandDirection="Left" Header="Left Expander">
+    <TextBlock>Some Left Content</TextBlock>
+</Expander>
+```
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml)

docs/docs/documentation/controls/navigation/sidemenu.md

@@ -49,5 +49,4 @@
 
 [Demo: SukiUI.Demo/SukiUIDemoView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/SukiUIDemoView.axaml)
 
-
 [API: Controls/SukiSideMenu.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/SukiSideMenu.axaml.cs)

docs/docs/documentation/controls/notification/infobar.md

@@ -0,0 +1,31 @@
+# InfoBar
+
+`InfoBar` is a control that displays a message and can be used to show specific severity message to the user.
+
+## Show
+
+<img src="/controls/notification/infobar.gif" width="300px" />
+
+## Example
+
+```xml
+<suki:InfoBar 
+        Title="Info"
+        IsOpaque="{Binding IsOpaque}"
+        IsClosable="{Binding IsClosable}"
+        IsOpen="{Binding IsOpen, Mode=TwoWay}"
+        Severity="Warning"
+        Message="Hello World!" />
+```
+
+`Severity` property allows:
+- Information
+- Success
+- Warning
+- Error
+
+## See Also
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml)
+
+[API: Controls/InfoBar.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/InfoBar.axaml.cs)

docs/docs/documentation/getting-started/installation.md

@@ -1,7 +1,7 @@
 # Installation
 
 ::: info
-When this page was written, the latest Avalonia version was `11.1.0-beta2` with SukiUI version `6.0.0-beta6`
+When this page was written, the latest Avalonia version was `11.2.0-beta1` with SukiUI version `6.0.0-beta8`
 :::
 
 SukiUI can be installed in two ways:
@@ -48,8 +48,12 @@ Visit [SukiUI on Nuget](https://www.nuget.org/packages/SukiUI) for more informat
 
 5. Select `SukiUI.dll` you downloaded
 
+6. Add a Nuget package `System.Reactive`
+
 ::: tip
 The package list should be:
 
 ![](/getting-started/introduction-final-package-list.webp "package list")
+
+If installed by referencing `.dll`, there should be a `System.Reactive` here.
 :::

docs/docs/documentation/getting-started/launch.md

@@ -79,4 +79,16 @@ public partial class MainWindow : SukiWindow // [!code highlight]
 
 ## Done
 
-You're now ready to use SukiUI !
+You're now ready to use SukiUI !
+
+::: warning
+If you encounter the following exception:
+- `SukiWindow` not found [Issue#265](https://github.com/kikipoulet/SukiUI/issues/265)
+- System.MissingMethodException: Method not found: System.Collections.Generic.IReadOnlyList`1<System.Object> Avalonia.Markup.Xaml.XamlIl.Runtime.IAvaloniaXamlIlEagerParentStackProvider.get_DirectParents() [Issue#276](https://github.com/kikipoulet/SukiUI/issues/276)
+- Unable to resolve type `SukiTheme` from namespace clr-namespace:SukiUI;assembly=SukiUI [Discussion#276](https://github.com/kikipoulet/SukiUI/discussions/278)
+- and other similar exceptions
+
+There are two possible solutions to try:
+- Upgrade or downgrade the version of `Avalonia` and `SukiUI` until the exception is resolved
+- While ensuring that `Avalonia` is up to date (beta), reference the build `.dll` from [Github Action](https://github.com/kikipoulet/SukiUI/actions/workflows/build.yml) and proceed with the [following steps](/documentation/getting-started/installation#via-github-action)
+:::

docs/docs/zh/documentation/controls/data/expander.md

@@ -0,0 +1,31 @@
+# Expander
+
+`Expander` 是一个可以折叠/展开的内容容器，支持四种方向（上下左右）。
+
+## 展示
+
+<img src="/controls/data/expander.gif" />
+
+## 示例
+
+```xml
+<Expander ExpandDirection="Down" Header="Down Expander">
+    <TextBlock>Some Down Content</TextBlock>
+</Expander>
+
+<Expander ExpandDirection="Up" Header="Up Expander">
+    <TextBlock>Some Up Content</TextBlock>
+</Expander>
+
+<Expander ExpandDirection="Right" Header="Right Expander">
+    <TextBlock>Some Right Content</TextBlock>
+</Expander>
+
+<Expander ExpandDirection="Left" Header="Left Expander">
+    <TextBlock>Some Left Content</TextBlock>
+</Expander>
+```
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml)

docs/docs/zh/documentation/controls/notification/infobar.md

@@ -0,0 +1,31 @@
+# InfoBar
+
+`InfoBar` 是一个提醒控件，用于向用户传达特定严重程度的信息
+
+## 展示
+
+<img src="/controls/notification/infobar.gif" width="300px" />
+
+## 示例
+
+```xml
+<suki:InfoBar 
+        Title="Info"
+        IsOpaque="{Binding IsOpaque}"
+        IsClosable="{Binding IsClosable}"
+        IsOpen="{Binding IsOpen, Mode=TwoWay}"
+        Severity="Warning"
+        Message="Hello World!" />
+```
+
+`Severity` 的值:
+- Information
+- Success
+- Warning
+- Error
+
+## 参阅
+
+[Demo: SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml)
+
+[API: Controls/InfoBar.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/InfoBar.axaml.cs)

docs/docs/zh/documentation/getting-started/installation.md

@@ -1,7 +1,7 @@
 # 安装
 
 ::: info 
-写完本篇时，Avalonia 的版本是 `11.1.0-beta2` ，SukiUI 的版本是 `6.0.0-beta6`
+写完本篇时，Avalonia 的版本是 `11.2.0-beta1` ，SukiUI 的版本是 `6.0.0-beta8`
 :::
 
 SukiUI 可以通过以下两种方式安装:
@@ -48,8 +48,12 @@ dotnet add package SukiUI --version 6.0.0
 
 5. 选择刚刚下载的 `SukiUI.dll` 并添加
 
+6. 添加 Nuget 包 `System.Reactive`
+
 ::: tip
 最终，你的包列表应为：
 
 ![](/getting-started/introduction-final-package-list.webp "package list")
+
+如果你是以引用`dll`的方式安装的，此处应有 `System.Reactive`
 :::

docs/docs/zh/documentation/getting-started/launch.md

@@ -77,4 +77,15 @@ public partial class MainWindow : SukiWindow // [!code highlight]
 
 ## 完成
 
-至此，SukiUI 安装完成
+至此，SukiUI 安装完成
+
+::: warning
+如果你遇到了包括但不限于以下异常：
+- `SukiWindow` not found [Issue#265](https://github.com/kikipoulet/SukiUI/issues/265)
+- System.MissingMethodException: Method not found: System.Collections.Generic.IReadOnlyList`1<System.Object> Avalonia.Markup.Xaml.XamlIl.Runtime.IAvaloniaXamlIlEagerParentStackProvider.get_DirectParents() [Issue#276](https://github.com/kikipoulet/SukiUI/issues/276)
+- Unable to resolve type `SukiTheme` from namespace clr-namespace:SukiUI;assembly=SukiUI [Discussion#276](https://github.com/kikipoulet/SukiUI/discussions/278)
+
+有两种可能的解决方案：
+- 调整 `Avalonia` 和 `SukiUI` 的版本直到异常消失
+- 在保证 `Avalonia` 是最新版本（包括 beta）的情况下，引用来自 [Github Action](https://github.com/kikipoulet/SukiUI/actions/workflows/build.yml) 的 `.dll` 构建，然后执行[以下步骤](/zh/documentation/getting-started/installation#通过-github-action-安装)
+:::