AdsDialogKit

Dialog Kit is a user interface solution that provides fast and customizable dialog boxes.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Usage
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Dialog Kit is a useful and customizable dialog box solution for user interfaces. This NuGet package allows you to quickly and easily add dialog box features to your applications. By supporting various types of dialogs, Dialog Kit can be used for communication purposes such as informative messages, alerts, confirmations and user logins. It also offers theme and style options that can be easily integrated and customized into the user interface. Dialog Kit helps you improve the user experience while speeding up your development process

This description highlights the key features and user benefits of the Dialog Kit NuGet package you have created. You can help users understand and use the package by adding this description to the NuGet package's documentation, the package's description section, or the GitHub repository. Of course, you may also want to add customization options or other noteworthy details.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

• Download and install .NET 6

Installation

• Add AdsDialogKit NuGet package to your project

dotnet add package AdsDialogKit

Usage

Create The SampleStaticDialogBoxHelperMethods

using AdsDialogKit;

public static class SampleBasicDialogBoxExtensions
{
    public static IAdsBasicDialogBox BasicDialogError(this IAdsDialogBox AdsDialogBox)
    {
        return AdsDialogBox.Basic
            .Header
                .SetTitle("Example Title For the BasicDialogError")
                .Next()
            .Body
                .SetText("Example Description For the BasicDialogError")
                .Next()
            .Footer
                .Button
                    .SetText("Agree")
                    .SetAction(AdsDialogKitButtonAction.GoToDeepLink)
                    .SetLink("")
                    .Next()
                .Button
                    .SetText("Disagree")
                    .SetAction(AdsDialogKitButtonAction.GoToDeepLink)
                    .SetLink("")
                    .Next()
                .Next()
            .Create();
    }
}

Dependency Injection

using AdsDialogKit;

builder.Services.AddAdsDialogBox()

Call the DialogBox

using AdsDialogKit;

public class DialogBoxController : ControllerBase
{
    readonly IAdsDialogBox _adsDialogBox;

    public DialogBoxController(IAdsDialogBox adsDialogBox)
    {
        _adsDialogBox = adsDialogBox;
    }

    [HttpGet(Name = "BasicDialogInformation")]
    public AdsDialogBox Get()
    {
        var model = SampleBasicDialogBoxExtensions.BasicDialogInformation(_adsDialogBox);
        var serializerSettings = new JsonSerializerSettings
        {
            NullValueHandling = NullValueHandling.Include,
        };
        var serializedDialogBox = JsonConvert.SerializeObject(model, serializerSettings);
        return JsonConvert.DeserializeObject<AdsDialogBox>(serializedDialogBox, serializerSettings);
    }
}

For more examples, please refer to the Sample Project

(back to top)

Roadmap

• Add basic dialog box
• Add examples
• Add license file
• Add NuGet package
• Add Changelog
• Add structral comments for methods
• Add tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Cihan Çakır - [email protected]

Project Link: https://github.com/adessoTurkey-dotNET/AdsDialogKit

(back to top)