Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/try0/feedbackmessages
Feedback messages utility for .NET Web application.
https://github.com/try0/feedbackmessages
asp asp-net-core asp-net-core-mvc asp-net-mvc blazor dotnet feedback-message feedback-messages message mvc net-framework net5 netframework netstandard razor-pages razorpages web web-application web-forms
Last synced: about 1 month ago
JSON representation
Feedback messages utility for .NET Web application.
- Host: GitHub
- URL: https://github.com/try0/feedbackmessages
- Owner: try0
- License: mit
- Created: 2020-04-06T11:44:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-31T20:39:03.000Z (over 1 year ago)
- Last Synced: 2024-04-28T08:17:28.816Z (9 months ago)
- Topics: asp, asp-net-core, asp-net-core-mvc, asp-net-mvc, blazor, dotnet, feedback-message, feedback-messages, message, mvc, net-framework, net5, netframework, netstandard, razor-pages, razorpages, web, web-application, web-forms
- Language: C#
- Homepage:
- Size: 1.08 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FeedbackMessages
[](https://ci.appveyor.com/project/try0/feedbackmessages)
[](https://sonarcloud.io/dashboard?id=FeedbackMessages)
[](https://sonarcloud.io/dashboard?id=FeedbackMessages)
Feedback messages utility for .NET Web application.
Display your feedbacks for web clients easily.
Messages that could not be rendered are persisted in the session until rendered.
## Version
0.6.0 (pre-release)
version >=.NETFramework 4.6.1, .NET Standard 2.0
## Demo
[FeedbackMessages.Example.WebForms](http://feedbackmessages-webforms.azurewebsites.net)
## Usage
### NuGet
[FeedbackMessages](https://www.nuget.org/packages/FeedbackMessages/0.6.0) WebForms
[FeedbackMessages.Mvc](https://www.nuget.org/packages/FeedbackMessages.Mvc/0.6.0) Mvc (.NETFramework)
[FeedbackMessages.AspNetCore.Mvc](https://www.nuget.org/packages/FeedbackMessages.AspNetCore.Mvc/0.6.0) Mvc, RazorPages
[FeedbackMessages.AspNetCore.Blazor](https://www.nuget.org/packages/FeedbackMessages.AspNetCore.Blazor/0.6.0) ServerSideBlazor
---
### Initialize settings (optional)
In your application's start up process.
```C#
FeedbackMessageSettings.CreateInitializer()
// custom renderer for feedback-message-panel
.SetMessageRendererFactory(() => {
var messageRenderer = new FeedbackMessageRenderer();
messageRenderer.OuterTagName = "div";
messageRenderer.InnerTagName = "span";
messageRenderer.AppendOuterAttributeValue(FeedbackMessageLevel.INFO, "class", "ui info message");
messageRenderer.AppendOuterAttributeValue(FeedbackMessageLevel.SUCCESS, "class", "ui success message");
messageRenderer.AppendOuterAttributeValue(FeedbackMessageLevel.WARN, "class", "ui warning message");
messageRenderer.AppendOuterAttributeValue(FeedbackMessageLevel.ERROR, "class", "ui error message");
return messageRenderer;
})
// custom script builder.
.SetScriptBuilderInstance(new FeedbackMessageScriptBuilder(msg => $"alert('{msg.ToString()}');"))
// custom store serializer.
.SetStoreSerializerInstance(new FeedbackMessageStoreSerializer()
{
Deserializer = serial => /* TODO */ new FeedbackMessageStore(),
Serializer = store => /* TODO */ ""
})
// init configs
.Initialize();
```
#### Default
* FeedbackMessageRenderer renders ul and li tags that has "feedback-level" class attribute value.
* FeedbackMessageScriptBuilder throws Exception.
* FeedbackMessageStoreSerializer use System.Text.Json.JsonSerializer
---
### WebForms
Add FeedbackMessages dependency.
There is nothing you need to do to initialize. When start up application, add FeedbackMessages.FeedbackMessageHttpModule automatically.
Add messages.
```C#
// Control that inherits System.Web.UI.Control
using FeedbackMessages.Extensions;
...
this.InfoMessage("Information feedback message.");
this.SuccessMessage("Success feedback message.");
this.WarnMessage("Warning feedback message.");
this.ErrorMessage("Error feedback message.");
```
In the case of display messages as html element.
```xml
<%@ Register Assembly="FeedbackMessages" Namespace="FeedbackMessages.Components" TagPrefix="fm" %>
```
In the case of display messages using JavaScript.
```C#
// Control that inherits System.Web.UI.Control
using FeedbackMessages.Extensions;
this.AppendFeedbackMessageScript();
```
---
### Mvc (.NETFramework)
Add FeedbackMessages.Mvc dependency.
There is nothing you need to do to initialize. When start up application, add FeedbackMessages.FeedbackMessageHttpModule automatically.
Add messages.
```C#
// Controller that inherits System.Web.Mvc.Controller
using FeedbackMessages.Extensions;
・・・
this.InfoMessage("Information feedback message.");
this.SuccessMessage("Success feedback message.");
this.WarnMessage("Warning feedback message.");
this.ErrorMessage("Error feedback message.");
```
In the case of display messages as html element.
```xml
@using FeedbackMessages.Extensions;
@Html.FeedbackMessagePanel()
```
In the case of display messages using JavaScript.
```xml
@using FeedbackMessages.Extensions;
@Html.FeedbackMessageScript()
```
Ajax lazy load
```C#
public class YourController : Controller
{
public ActionResult AjaxFeedbackMessage()
{
var messageHtml = FeedbackMessageSettings.Instance.MessageRenderer.RenderMessages().ToString();
return new ContentResult()
{
ContentType = "text/html",
ContentEncoding = System.Text.Encoding.UTF8,
Content = messageHtml
};
}
}
```
```html
$(function () {
$.ajax({
type: "POST", // GET
url: "/Your/AjaxFeedbackMessage",
success: function (messageHtml) {
if (!messageHtml) {
return;
}
$("#ajax-feedback-msg-container").html(messageHtml);
},
error: function (jqXHR, status, error) {
// TODO
}
});
});
```
---
### Mvc
Add FeedbackMessages.AspNetCore.Mvc dependency.
Initialize FeedbackMessages in Startup.cs.
```C#
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc(options =>
{
// Required add filter
options.Filters.Add(FeedbackMessageActionFilter.Instance);
});
// Required add context accessor
services.AddHttpContextAccessor();
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
// Required use middleware
app.UseFeedackMessages();
}
```
Add messages.
```C#
// Controller that inherits Microsoft.AspNetCore.Mvc.Controller
using FeedbackMessages.Extensions;
・・・
this.InfoMessage("Information feedback message.");
this.SuccessMessage("Success feedback message.");
this.WarnMessage("Warning feedback message.");
this.ErrorMessage("Error feedback message.");
```
In the case of display messages as html element.
```xml
@using FeedbackMessages.Extensions;
@Html.FeedbackMessagePanel()
```
In the case of display messages using JavaScript.
```xml
@using FeedbackMessages.Extensions;
@Html.FeedbackMessageScript()
```
---
### RazorPages
Add FeedbackMessages.AspNetCore.Mvc dependency.
Initialize FeedbackMessages in Startup.cs.
```C#
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc(options =>
{
// Required add filter
options.Filters.Add(FeedbackMessageActionFilter.Instance);
});
// Required add context accessor
services.AddHttpContextAccessor();
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
// Required use middleware
app.UseFeedackMessages();
}
```
Add messages.
```C#
// PageModel that inherits Microsoft.AspNetCore.Mvc.RazorPages.PageModel
using FeedbackMessages.Extensions;
・・・
this.InfoMessage("Information feedback message.");
this.SuccessMessage("Success feedback message.");
this.WarnMessage("Warning feedback message.");
this.ErrorMessage("Error feedback message.");
```
In the case of display messages as html element.
```xml
@addTagHelper *, FeedbackMessages.AspNetCore.Mvc
```
In the case of display messages using JavaScript.
```xml
@addTagHelper *, FeedbackMessages.AspNetCore.Mvc
```
---
### Blazor(server-side)
Add FeedbackMessages.AspNetCore.Blazor dependency.
Initialize FeedbackMessages in Startup.cs.
```C#
public void ConfigureServices(IServiceCollection services)
{
// Required add context accessor
services.AddHttpContextAccessor();
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
// Required use middleware
app.UseFeedackMessages();
}
```
Add messages.
```C#
// Component that inherits Microsoft.AspNetCore.Components.ComponentBase
using FeedbackMessages.Extensions;
・・・
this.InfoMessage("Information feedback message.");
this.SuccessMessage("Success feedback message.");
this.WarnMessage("Warning feedback message.");
this.ErrorMessage("Error feedback message.");
```
```xml
@using FeedbackMessages.Extensions;
@code {
this.InfoMessage("Information message.");
this.SuccessMessage("Success message.");
this.WarnMessage("Warning message.");
this.ErrorMessage("Error message.");
}
```
In the case of display messages as html element.
```xml
@namespace FeedbackMessages.Components
```
In the case of display messages using JavaScript.
```xml
@namespace FeedbackMessages.Components
```
Refresh feedback message component.
To redraw, the component needs to be refreshed.
```
feedbackMessagePanel.RefreshRender();
//feedbackMessageScript.RefreshRender();
```
---