Skip to content

Commit

Permalink
docs: sidemenu & search support
Browse files Browse the repository at this point in the history
  • Loading branch information
AuroraZiling committed May 28, 2024
1 parent 14c3ffd commit 6616c9e
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ node_modules
cache
temp
dist
pnpm-lock.yaml
pnpm-lock.yaml
helper
25 changes: 24 additions & 1 deletion docs/docs/.vitepress/config/shared.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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: '切换'
}
}
}
}
}
}
}
}
})
38 changes: 37 additions & 1 deletion docs/docs/documentation/controls/navigation/sidemenu.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# SukiSideMenu

`SukiSideMenu` is the main navigation control used in SukiUI, similar to `NavigationView` in other libraries.
`SukiSideMenu` is the main navigation control used in SukiUI, similar to `NavigationView` in other libraries.

## Show

<img src="/controls/navigation/sukisidemenu.webp" height="200px" width="200px"/>

## Example

```xml
<suki:SukiSideMenu>
<suki:SukiSideMenu.Items>
<suki:SukiSideMenuItem Header="Statistics">
<suki:SukiSideMenuItem.Icon>
<!-- Icon -->
</suki:SukiSideMenuItem.Icon>
<suki:SukiSideMenuItem.PageContent>
<!-- Page Content -->
</suki:SukiSideMenuItem.PageContent>
</suki:SukiSideMenuItem>
</suki:SukiSideMenu.Items>

<suki:SukiSideMenu.HeaderContent>
<!-- Header Content -->
</suki:SukiSideMenu.HeaderContent>

<suki:SukiSideMenu.FooterContent>
<!-- Footer Content -->
</suki:SukiSideMenu.FooterContent>
</suki:SukiSideMenu>
```

## 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)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.

0 comments on commit 6616c9e

Please sign in to comment.