https://github.com/sidescrollui/sidescroll
SideScroll is a cross platform Avalonia UI framework designed for quickly navigating through a tree of tabs
https://github.com/sidescrollui/sidescroll
avalonia avaloniaui cross-platform csharp desktop linux macos windows
Last synced: 2 months ago
JSON representation
SideScroll is a cross platform Avalonia UI framework designed for quickly navigating through a tree of tabs
- Host: GitHub
- URL: https://github.com/sidescrollui/sidescroll
- Owner: SideScrollUI
- License: mit
- Created: 2024-07-02T20:39:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-22T03:38:39.000Z (about 1 year ago)
- Last Synced: 2025-06-22T19:06:43.628Z (about 1 year ago)
- Topics: avalonia, avaloniaui, cross-platform, csharp, desktop, linux, macos, windows
- Language: C#
- Homepage:
- Size: 9.25 MB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.NuGet.md
- License: LICENSE
Awesome Lists containing this project
README
# SideScroll
[](https://sidescrollui.github.io/SideScroll/)
[](https://www.nuget.org/packages/SideScroll)
[](https://github.com/SideScrollUI/SideScroll/blob/main/LICENSE)
[](https://dotnet.microsoft.com/download)
[](https://github.com/AvaloniaUI/Avalonia)
**A cross-platform Avalonia UI framework for building fast, navigable, data-driven applications with automatically generated forms and smart tab navigation.**
SideScroll is designed for navigating complex data hierarchies with speed and developer productivity in mind. It automatically selects the most likely next tabs as you navigate, allowing you to drill down 20, 30, or even 50 levels deep with ease. Every view can be saved as a shareable link, and any object can be instantly displayed or edited with auto-generated controls.
## ✨ Key Features
- **🚀 Smart Tab Navigation** — Automatically predicts and displays the next most relevant tabs based on your navigation patterns
- **🖥️ Cross-Platform** — Built on [Avalonia UI](https://github.com/AvaloniaUI/Avalonia), runs on **Windows, macOS, Linux**, and **Web (WASM)**
- **⚡ Rapid Development** — Create tabs in code for easy linking and refactoring; no XAML required
- **🎨 Dynamic Forms** — Load any object into a **TabForm** and get auto-generated Avalonia controls with attribute-based customization
- **💾 DataRepos** — Manage local data storage with data-bound views and automatic serialization
- **🔗 Shareable Links** — Create and share deep links to any view or data state
- **📊 Interactive Charting** — Integrated [LiveCharts 2](https://github.com/beto-rodriguez/LiveCharts2) with smooth animations, zooming, and interactive legends
- **📝 Rich Text Editing** — Built-in [AvaloniaEdit](https://github.com/AvaloniaUI/AvaloniaEdit) support for syntax highlighting and text manipulation
- **🎨 Customizable Themes** — Light, dark, and custom themes with exportable/importable JSON configurations
- **🔍 Advanced Filtering** — Powerful DataGrid filtering with nested queries and operators
## 🎬 Live Demo
**Try SideScroll in your browser:** [https://sidescrollui.github.io/SideScroll/](https://sidescrollui.github.io/SideScroll/)
The demo runs entirely in WebAssembly using Avalonia's browser support—no installation required!
> **Note:** The browser version is experimental. For the best performance and full features, use the desktop application.
## 📸 Screenshots & Examples
### VideoGamesDB Sample
### Light Theme
### Dark Theme
### Custom Theming - Hybrid Theme
### Rich Text Editing with AvaloniaEdit
### Shareable Links
## 🚀 Quick Start
1. **Install SideScroll templates**
```bash
dotnet new install SideScroll.Templates
```
2. **Create a new SideScroll application**
```bash
dotnet new sidescroll.app -o MyApp
```
Or create a solution with library and program projects:
```bash
dotnet new sidescroll.sln -o MyApp
```
3. **Run your new app**
```bash
cd MyApp
dotnet run
```
## 📚 Documentation
### For Users
- **[User Guide](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/UserGuide.md)** — How to use SideScroll applications
- **[Live Demo](https://sidescrollui.github.io/SideScroll/)** — Try it in your browser
### For Developers
- **[Project Setup](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/ProjectSetup.md)** — Setting up your first SideScroll project
- **[Development Guide](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/Development.md)** — Core concepts and development workflow
- **[Adding Tabs](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/AddingTabs.md)** — Creating custom tabs
- **[TabForms](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/TabForms.md)** — Auto-generated forms for objects
- **[DataRepos](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/DataRepos.md)** — Data storage and management
- **[Bookmarks](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/Bookmarks.md)** — Creating shareable links
- **[Charts](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/Charts.md)** — Adding interactive charts
- **[Logs](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/Logs.md)** — Logging and debugging
- **[Projects](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/Projects.md)** — Project configuration
- **[Serializer](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Dev/Serializer.md)** — Object serialization
### Additional Resources
- **[Credits](https://github.com/SideScrollUI/SideScroll/blob/main/Docs/Credits.md)** — Acknowledgments and third-party libraries
- **[Changelog](https://github.com/SideScrollUI/SideScroll/blob/main/CHANGELOG.md)** — Version history and release notes
- **[Contributing Guide](https://github.com/SideScrollUI/SideScroll/blob/main/CONTRIBUTING.md)** — How to contribute to SideScroll
## 🎯 Sample Projects
- **[SideScroll Samples](https://github.com/SideScrollUI/SideScroll/blob/main/Libraries/SideScroll.Avalonia.Samples/MainWindow.cs)** — Included in the repository
- **[Video Game Database](https://github.com/SideScrollUI/VideoGamesDB)** — External sample project demonstrating real-world usage
## 📄 License
This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/SideScrollUI/SideScroll/blob/main/LICENSE) file for details.
