nich2408.Blazor.SimpleModal 1.0.0

Blazor.SimpleModal

Blazor class library for modal display and interaction with simplicity in mind.

Getting started

Add the package

Install the package in your project with the dotnet CLI:

dotnet add package nich2408.Blazor.SimpleModal

or with the Package Manager Console: Install-Package nich2408.Blazor.SimpleModal

Add script tags

Add these script tags in your App.razor or index.html

<script src="_content/nich2408.Blazor.SimpleModal/modals.js" type="module"></script>
<script src="_content/nich2408.Blazor.SimpleModal/bootstrap-5.1.3.min.js"></script>

⚠️ If you are already using boostrap JS script in your project, you can skip adding <script src="_content/nich2408.Blazor.SimpleModal/bootstrap-5.1.3.min.js"></script>

Be sure to clean and rebuild the project if you are using Visual Studio and also clean the browser cache if the files are not appearing as sources.

Usage

Declaring a modal

Example.razor

@using Blazor.SimpleModal

<SimpleModal
  @ref="mySimpleModal"
  Title="This is the title"
  EnableConfirmButton="true"
  EnableDismissButton="true"
  DismissOnOutsideClick="true"
  DismissOnEscapeKey="true">
    Place here the content!
</SimpleModal>

@code {
  // Use this field for holding a reference to the modal.
  private SimpleModal mySimpleModal;

  // code omitted for brevity
  [...]
}

Displaying the modal

bool confirmed = await mySimpleModal.ShowAsync();

or

await mySimpleModal.ShowAsync();

Screenshot:

Additional documentation

You can change the style of modal including custom buttons CSS classes and texts by changing the related properties of the SimpleModal component.

Feedback

If you want to leave feedback (bugs or discussion) you can open an issue.

Contributing

Currently the project is not planned to be opened to contribution inside this repository.

Credits

• Bootstrap modals: https://getbootstrap.com/docs/5.3/components/modal/