diff --git a/docs/.gitignore b/docs/.gitignore index d1bb86d19..e29190c95 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -3,4 +3,5 @@ node_modules cache temp dist -pnpm-lock.yaml \ No newline at end of file +pnpm-lock.yaml +helper \ No newline at end of file diff --git a/docs/docs/.vitepress/config/shared.mts b/docs/docs/.vitepress/config/shared.mts index 1a763e6a9..981eabd97 100644 --- a/docs/docs/.vitepress/config/shared.mts +++ b/docs/docs/.vitepress/config/shared.mts @@ -12,6 +12,29 @@ export const shared = defineConfig({ logo: { src: '/suki.webp', width: 24, height: 24 }, socialLinks: [ { icon: 'github', link: 'https://github.com/kikipoulet/SukiUI' } - ] + ], + search: { + provider: 'local', + options: { + locales: { + zh: { + translations: { + button: { + buttonText: '搜索文档', + buttonAriaLabel: '搜索文档' + }, + modal: { + noResultsText: '无法找到相关结果', + resetButtonTitle: '清除查询条件', + footer: { + selectText: '选择', + navigateText: '切换' + } + } + } + } + } + } + } } }) diff --git a/docs/docs/documentation/controls/layout/glasscard.md b/docs/docs/documentation/controls/layout/glasscard.md index e69de29bb..8fd16807a 100644 --- a/docs/docs/documentation/controls/layout/glasscard.md +++ b/docs/docs/documentation/controls/layout/glasscard.md @@ -0,0 +1,34 @@ +# Glass Card + +A simple Card control that can present any control inside. + +You can adjust whether the `GlassCard` is opaque or not and with or without interactive effects. + +## Show + +- Normal + + + +- Opaque + + + +- Interactive + + + +## Example + +```xml + + + +``` + +## See Also + +[Demo: SukiUI.Demo/Features/ControlsLibrary/CardsView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/CardsView.axaml) + + +[API: Controls/GlassMorphism/GlassCard.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/GlassMorphism/GlassCard.axaml.cs) \ No newline at end of file diff --git a/docs/docs/documentation/controls/layout/tabcontrol.md b/docs/docs/documentation/controls/layout/tabcontrol.md index e69de29bb..e9f0ea91f 100644 --- a/docs/docs/documentation/controls/layout/tabcontrol.md +++ b/docs/docs/documentation/controls/layout/tabcontrol.md @@ -0,0 +1,28 @@ +# Tab Control + +`TabControl` provides the user with a collection of tabs that can be used to display several contents. + +::: tip +`TabStripPlacement` property is available +::: + +## Show + + + +## Example + +```xml + + + + + + + + +``` + +## See Also + +[Demo: SukiUI.Demo/Features/ControlsLibrary/TabControl/TabControlView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TabControl/TabControlView.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 e8cc2d7dd..fcf4b002b 100644 --- a/docs/docs/documentation/controls/navigation/sidemenu.md +++ b/docs/docs/documentation/controls/navigation/sidemenu.md @@ -1,3 +1,39 @@ # SukiSideMenu -`SukiSideMenu` is the main navigation control used in SukiUI, similar to `NavigationView` in other libraries. \ No newline at end of file +`SukiSideMenu` is the main navigation control used in SukiUI, similar to `NavigationView` in other libraries. + +## Show + + + +## Example + +```xml + + + + + + + + + + + + + + + + + + + + +``` + +## See Also + +[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/public/controls/layout/glasscard-1.webp b/docs/docs/public/controls/layout/glasscard-1.webp new file mode 100644 index 000000000..dffbef37e Binary files /dev/null and b/docs/docs/public/controls/layout/glasscard-1.webp differ diff --git a/docs/docs/public/controls/layout/glasscard-2.webp b/docs/docs/public/controls/layout/glasscard-2.webp new file mode 100644 index 000000000..34bcb24c7 Binary files /dev/null and b/docs/docs/public/controls/layout/glasscard-2.webp differ diff --git a/docs/docs/public/controls/layout/glasscard-3.webp b/docs/docs/public/controls/layout/glasscard-3.webp new file mode 100644 index 000000000..fdba95f24 Binary files /dev/null and b/docs/docs/public/controls/layout/glasscard-3.webp differ diff --git a/docs/docs/public/controls/layout/tabcontrol.webp b/docs/docs/public/controls/layout/tabcontrol.webp new file mode 100644 index 000000000..64482955d Binary files /dev/null and b/docs/docs/public/controls/layout/tabcontrol.webp differ diff --git a/docs/docs/public/controls/navigation/sukisidemenu.webp b/docs/docs/public/controls/navigation/sukisidemenu.webp new file mode 100644 index 000000000..623fa1346 Binary files /dev/null and b/docs/docs/public/controls/navigation/sukisidemenu.webp differ diff --git a/docs/docs/zh/documentation/controls/layout/glasscard.md b/docs/docs/zh/documentation/controls/layout/glasscard.md index e69de29bb..67f929a09 100644 --- a/docs/docs/zh/documentation/controls/layout/glasscard.md +++ b/docs/docs/zh/documentation/controls/layout/glasscard.md @@ -0,0 +1,34 @@ +# Glass Card + +一个简单的卡片式控件,可以往里面塞各种内容 + +`GlassCard` 的透明和交互效果是可以开关的 + +## 展示 + +- 普通 + + + +- 不透明 + + + +- 有交互效果 + + + +## 示例 + +```xml + + + +``` + +## 参阅 + +[Demo: SukiUI.Demo/Features/ControlsLibrary/CardsView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/CardsView.axaml) + + +[API: Controls/GlassMorphism/GlassCard.axaml.cs](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI/Controls/GlassMorphism/GlassCard.axaml.cs) \ No newline at end of file diff --git a/docs/docs/zh/documentation/controls/layout/tabcontrol.md b/docs/docs/zh/documentation/controls/layout/tabcontrol.md index e69de29bb..4d17e7b30 100644 --- a/docs/docs/zh/documentation/controls/layout/tabcontrol.md +++ b/docs/docs/zh/documentation/controls/layout/tabcontrol.md @@ -0,0 +1,28 @@ +# Tab Control + +`TabControl` 可以通过切换 `TabItem` 以展现多种内容 + +::: tip +`TabStripPlacement` 属性是可用的 +::: + +## 展示 + + + +## 示例 + +```xml + + + + + + + + +``` + +## 参阅 + +[Demo: SukiUI.Demo/Features/ControlsLibrary/TabControl/TabControlView.axaml](https://github.com/kikipoulet/SukiUI/blob/main/SukiUI.Demo/Features/ControlsLibrary/TabControl/TabControlView.axaml) \ No newline at end of file diff --git a/docs/docs/zh/documentation/controls/navigation/sidemenu.md b/docs/docs/zh/documentation/controls/navigation/sidemenu.md index e69de29bb..c635f24e1 100644 --- a/docs/docs/zh/documentation/controls/navigation/sidemenu.md +++ b/docs/docs/zh/documentation/controls/navigation/sidemenu.md @@ -0,0 +1,39 @@ +# SukiSideMenu + +`SukiSideMenu` 是 SukiUI 主要的导航控件,类似其他库中的 `NavigationView` + +## 展示 + + + +## 示例 + +```xml + + + + + + + + + + + + + + + + + + + + +``` + +## 参阅 + +[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