Skip to content

Commit b7f4b3a

Browse files
committed
Fixes #1
1 parent 385a44f commit b7f4b3a

File tree

1 file changed

+36
-3
lines changed

1 file changed

+36
-3
lines changed

README.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
Simplify.Web.MessageBox
2-
===
1+
# Simplify.Web.MessageBox
32

4-
`Simplify.Web.MessageBox` is a package which provides message box controller response and templates for [Simplify.Web web-framework](https://github.com/i4004/Simplify.Web).
3+
`Simplify.Web.MessageBox` is a package which provides non-interactive server side message box for [Simplify.Web](https://github.com/i4004/Simplify.Web) web-framework.
54

65
## Package status
76

@@ -14,3 +13,37 @@ Simplify.Web.MessageBox
1413
| | **.NET (4.5.2)** | **Mono (Latest)** |
1514
| :------ | :------ | :------: |
1615
| **master** | [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/2h8jh563pwsf283i/branch/master?svg=true)](https://ci.appveyor.com/project/i4004/simplify-web-messagebox/branch/master) | [![Travis Build Status](https://travis-ci.org/i4004/Simplify.Web.MessageBox.svg?branch=master)](https://travis-ci.org/i4004/Simplify.Web.MessageBox) |
16+
17+
# Examples
18+
19+
## Setup message box templates
20+
21+
There are different template file for different message box statuses.
22+
Inline templates intended to use as API responses but stylized with HTML.
23+
24+
![Template files](https://raw.githubusercontent.com/i4004/Simplify.Web.MessageBox/master/images/template-files.png)
25+
26+
## Displaying message box
27+
28+
### Default message box which will be added to 'MainContent' variable
29+
```csharp
30+
public class MyController : Controller
31+
{
32+
public override ControllerResponse Invoke()
33+
{
34+
return new MessageBox("your string");
35+
}
36+
}
37+
```
38+
### Inline message box
39+
40+
Framework execution will be stopped, message box will be returned to client without rest of the website content
41+
```csharp
42+
public class MyController : Controller
43+
{
44+
public override ControllerResponse Invoke()
45+
{
46+
return new MessageBoxInline("your string");
47+
}
48+
}
49+
```

0 commit comments

Comments
 (0)