diff --git a/SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml b/SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml index abcf72535..b6c2c3960 100644 --- a/SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml +++ b/SukiUI.Demo/Features/ControlsLibrary/InfoBarView.axaml @@ -14,7 +14,7 @@ - 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. + +## Example + +```xml + + Some Down Content + + + + Some Up Content + + + + Some Right Content + + + + Some Left Content + +``` + +## See Also + +[Demo: SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml) \ No newline at end of file diff --git a/docs/docs/documentation/controls/navigation/sidemenu.md b/docs/docs/documentation/controls/navigation/sidemenu.md index 2c9baa969..61a3a1cd0 100644 --- a/docs/docs/documentation/controls/navigation/sidemenu.md +++ b/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) \ No newline at end of file diff --git a/docs/docs/documentation/controls/notification/infobar.md b/docs/docs/documentation/controls/notification/infobar.md index e69de29bb..7b2c5a5f2 100644 --- a/docs/docs/documentation/controls/notification/infobar.md +++ b/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 + + + +## Example + +```xml + +``` + +`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) \ No newline at end of file diff --git a/docs/docs/documentation/getting-started/installation.md b/docs/docs/documentation/getting-started/installation.md index 857e1aae2..8d4b8c98e 100644 --- a/docs/docs/documentation/getting-started/installation.md +++ b/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. ::: \ No newline at end of file diff --git a/docs/docs/documentation/getting-started/launch.md b/docs/docs/documentation/getting-started/launch.md index f74229ca7..44bdffb8e 100644 --- a/docs/docs/documentation/getting-started/launch.md +++ b/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 ! \ No newline at end of file +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 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) +::: \ No newline at end of file diff --git a/docs/docs/public/controls/data/expander.gif b/docs/docs/public/controls/data/expander.gif new file mode 100644 index 000000000..f365a823b Binary files /dev/null and b/docs/docs/public/controls/data/expander.gif differ diff --git a/docs/docs/public/controls/notification/infobar.gif b/docs/docs/public/controls/notification/infobar.gif new file mode 100644 index 000000000..3b16bcdf0 Binary files /dev/null and b/docs/docs/public/controls/notification/infobar.gif differ diff --git a/docs/docs/public/getting-started/introduction-default-package-list.webp b/docs/docs/public/getting-started/introduction-default-package-list.webp index e80bb0555..37ecef3ff 100644 Binary files a/docs/docs/public/getting-started/introduction-default-package-list.webp and b/docs/docs/public/getting-started/introduction-default-package-list.webp differ diff --git a/docs/docs/public/getting-started/introduction-final-package-list.webp b/docs/docs/public/getting-started/introduction-final-package-list.webp index 428509e04..3a2d402d5 100644 Binary files a/docs/docs/public/getting-started/introduction-final-package-list.webp and b/docs/docs/public/getting-started/introduction-final-package-list.webp differ diff --git a/docs/docs/zh/documentation/controls/data/expander.md b/docs/docs/zh/documentation/controls/data/expander.md index e69de29bb..0ec21902a 100644 --- a/docs/docs/zh/documentation/controls/data/expander.md +++ b/docs/docs/zh/documentation/controls/data/expander.md @@ -0,0 +1,31 @@ +# Expander + +`Expander` 是一个可以折叠/展开的内容容器，支持四种方向（上下左右）。 + +## 展示 + + + +## 示例 + +```xml + + Some Down Content + + + + Some Up Content + + + + Some Right Content + + + + Some Left Content + +``` + +## 参阅 + +[Demo: SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/ExpanderView.axaml) \ No newline at end of file diff --git a/docs/docs/zh/documentation/controls/notification/infobar.md b/docs/docs/zh/documentation/controls/notification/infobar.md index e69de29bb..5bb6374f7 100644 --- a/docs/docs/zh/documentation/controls/notification/infobar.md +++ b/docs/docs/zh/documentation/controls/notification/infobar.md @@ -0,0 +1,31 @@ +# InfoBar + +`InfoBar` 是一个提醒控件，用于向用户传达特定严重程度的信息 + +## 展示 + + + +## 示例 + +```xml + +``` + +`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) \ No newline at end of file diff --git a/docs/docs/zh/documentation/getting-started/installation.md b/docs/docs/zh/documentation/getting-started/installation.md index 52b2e8521..6d9dc692c 100644 --- a/docs/docs/zh/documentation/getting-started/installation.md +++ b/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` ::: \ No newline at end of file diff --git a/docs/docs/zh/documentation/getting-started/launch.md b/docs/docs/zh/documentation/getting-started/launch.md index 3b75bd4ef..716dd6a18 100644 --- a/docs/docs/zh/documentation/getting-started/launch.md +++ b/docs/docs/zh/documentation/getting-started/launch.md @@ -77,4 +77,15 @@ public partial class MainWindow : SukiWindow // [!code highlight] ## 完成 -至此，SukiUI 安装完成 \ No newline at end of file +至此，SukiUI 安装完成 + +::: warning +如果你遇到了包括但不限于以下异常： +- `SukiWindow` not found [Issue#265](https://github.com/kikipoulet/SukiUI/issues/265) +- System.MissingMethodException: Method not found: System.Collections.Generic.IReadOnlyList`1 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-安装) +::: \ No newline at end of file