TirsvadCLI.MenuPaginator 0.3.0

Menu paginator

Pagination Lib for menu selection in C# console applications.

Table of Contents

• Overview
• Features
• Getting Started
  • Prerequisites
  • Installation
    • Install via NuGet Package Manager Console
    • Install via Visual Studio NuGet Package Manager
    • Install via .NET CLI
    • Clone the repo
  • Example Usage
• Example
• Contributing
  • Translation
• License
• Contact
• Acknowledgments

Overview

The Menu Paginator library is a C# library that provides a simple and efficient way to create paginated menus in console applications. It allows you to display a list of menu items in a paginated format, making it easy for users to navigate through lists of menu choice.

Features

• Pagination: The library allows you to paginate a list of menu items, making it easy to navigate through large lists.
• Customizable: You can customize the appearance of the menu, including colors, styles, and more.
• Keyboard Navigation: The library supports F1-F10 for select menu.
• Easy to Use: The library is easy to use and integrate into your existing console applications.
• Multi-language support: The library can support multiple languages, making it easy to use in different regions.
• Example: The library comes with an example project that demonstrates how to use the library.
• Open Source: The library is open source and available on GitHub, allowing you to contribute and improve the library.

Getting Started

This section will guide you through the installation and setup of the Menu Paginator library in your C# console application.

Prerequisites

• .NET 9.0 or later

Installation

You can install this library using NuGet Package Manager or by adding the package reference directly to your project file. The library is available on NuGet, so you can easily install it using the NuGet Package Manager Console or the Visual Studio NuGet Package Manager.

Install via NuGet Package Manager Console

You can install this library using the NuGet Package Manager Console. Open the console and run the following command:

Install-Package TirsvadCLI.MenuPaginator

Install via Visual Studio NuGet Package Manager

You can also install this library using the Visual Studio NuGet Package Manager. Follow these steps:

1. Open your project in Visual Studio.
2. Right-click on your project in the Solution Explorer and select "Manage NuGet Packages".
3. Search for "TirsvadCLI.MenuPaginator" in the NuGet Package Manager.
4. Click "Install" to add the library to your project.

Install via .NET CLI

You can also install this library using the .NET CLI. Open a terminal and run the following command:

dotnet add package TirsvadCLI.MenuPaginator

Clone the repo

If you want to clone the repository and build the library from source, you can do so using Git. Make sure you have Git installed on your machine. Then, run the following command in your terminal:

git clone git@github.com:TirsvadCLI/Dotnet.Lib.MenuPaginator.git

Example

In the example you can see how to use the Menu Paginator class.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Translation

We need help for translate to other languages. If you want to help, please create a new issue with the translation. We will add it to the project.

Resources.resx contains the msg that can be translated. The key text is English.

For now we have the following languages:

• da (Danish)
• en (English)
• my (Myanmar)

If can create a new file called Resources.<language>.resx, where <language> is the language code. For example, for Danish, the file should be called Resources.da.resx. The file should contain the same keys as the original file, but with the translated text.

License

Distributed under the GPL-3.0 License.

Contact

Jens Tirsvad Nielsen - LinkedIn

Acknowledgments