Skip to content

Commit b5f7a38

Browse files
Gourav DwivediGourav Dwivedi
authored andcommitted
modified readme file
1 parent 56ccc78 commit b5f7a38

File tree

2 files changed

+93
-96
lines changed

2 files changed

+93
-96
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# SignalR-Web-Client
2-
ASP.NET Core Signal-R is a JavaScript based Web Client.
2+
This is a JavaScript based SignalR Web Client.
33

4-
5-
It is a debugging tool to test ASP.Net Core SignalR hubs. This is a UI based SignalR client. Using this tool, we can send the data to the SignalR hub and receive the response from the SignalR Hub. This tool is design for dotnet developer to make their life easier when they work with SignalR.
4+
It is a debugging tool to test ASP.Net Core SignalR hubs. This is a UI based SignalR client. Using this tool, we can send the data to the SignalR hub and receive the response from the SignalR Hub. This tool is design for dotnetcore developer to make their life easier when they work with SignalR.
65

76
<p align="center">
87
<img src="./src/images/SignalR-Web-Client.jpg" >
@@ -14,7 +13,7 @@ It is a debugging tool to test ASP.Net Core SignalR hubs. This is a UI based Sig
1413
- [Basic Understanding of](#Basic-Understanding-of)
1514
- [Install](#install)
1615
- [Usage](#usage)
17-
- [Examples & Demos](#examples--demos)
16+
- [Technologies](#technologies)
1817
- [API](#api)
1918
- [Contribute](#contribute)
2019
- [License](#license)
@@ -27,9 +26,6 @@ Before using this tool, you should be know few concepts about:
2726
- [What is Asp.Net Core?](https://dotnet.microsoft.com/learn/aspnet/what-is-aspnet-core)
2827
- [What is SignalR in Asp.Net Core?](https://docs.microsoft.com/en-us/aspnet/core/signalr/introduction?view=aspnetcore-3.0)
2928

30-
31-
32-
3329
#Prerequsit
3430

3531
# How it works?
@@ -97,9 +93,9 @@ Currently it supports only chrome browser.
9793

9894
### Reporting Issues
9995

100-
Nothing is perfect. Same rule goes to this tool also.
101-
- Found an issue or problem?
102-
- Want a new feature?
96+
Nothing is perfect.
97+
- Found an issue?
98+
- Wants a new feature?
10399

104100
Then, just open a [new clear and descriptive issue](../../issues/new).
105101

@@ -111,14 +107,23 @@ Then, just open a [new clear and descriptive issue](../../issues/new).
111107

112108
2. Now we have to create hub.
113109
- Create a folder "Hubs". Inside that folder, create a file called "TestHub.cs".
114-
-
110+
111+
112+
113+
## Technologies
114+
115+
- Aspnet-Signalr 1.1.4
116+
- Bootstrap 4.3.1
117+
- [Mitt](https://github.com/developit/mitt)
118+
- WebComponentsJs 2.2.10
119+
115120

116121

117122
## License
118123

119124
[MIT License](https://opensource.org/licenses/MIT)
120125

121126
---
122-
Copyright &copy; 2019,
127+
Copyright &copy; 2020,
123128
Created by [Gourav Dwivedi](https://github.com/gouravdwivedi6590).
124129
Released under the terms of the [MIT license](https://github.com/gouravdwivedi6590/SignalR-Web-Client/blob/master/LICENSE).

src/js/components/srform.js

Lines changed: 76 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -4,97 +4,94 @@ import * as AppCommon from './logic/lib/app.common';
44

55
var isConnected = false;
66

7-
export function Init() {
7+
//#region ConnectedEvent
8+
AppCommon.AppEvents.on('Init', () => {
9+
//console.log('Init Event Emitter');
10+
});
11+
//#endregion
12+
13+
//#region OnDisconnected
14+
AppCommon.AppEvents.on('OnDisconnected', () => {
15+
if (window.appLogic.GetCurrentView() !== true) {
16+
document.getElementById('chk-ws').disabled = false;
17+
document.getElementById('chk-sse').disabled = false;
18+
}
19+
});
20+
//#endregion
821

22+
export function Init() {
923
window.appLogic = new AppLogic();
1024

1125
//Connect Button Events
1226
document.getElementById('btn-connect')
13-
.addEventListener('click',
14-
function () {
15-
OnConnect();
16-
},
17-
false);
27+
.addEventListener('click',
28+
function () {
29+
OnConnect();
30+
},
31+
false);
1832

1933
//Disconnect Button Events
2034
document.getElementById('btn-disconnectbtn')
21-
.addEventListener('click',
22-
function () {
23-
OnDisConnect();
24-
},
25-
false);
35+
.addEventListener('click',
36+
function () {
37+
OnDisConnect();
38+
},
39+
false);
2640

2741
//Send Payload Button Events
2842
document.getElementById('btn-send-payload')
29-
.addEventListener('click',
30-
function () {
31-
SendPayload();
32-
},
33-
false);
43+
.addEventListener('click',
44+
function () {
45+
SendPayload();
46+
},
47+
false);
3448

3549
document.getElementById('chk-loggerView')
36-
.addEventListener('change', (event) => {
37-
if (event.target.checked) {
38-
document.getElementById('logger-container').style.display = "block";
39-
} else {
40-
document.getElementById('logger-container').style.display = "none";
41-
}
42-
});
50+
.addEventListener('change', (event) => {
51+
if (event.target.checked) {
52+
document.getElementById('logger-container').style.display = "block";
53+
} else {
54+
document.getElementById('logger-container').style.display = "none";
55+
}
56+
});
4357

4458
document.getElementById('btn-clearlogs')
45-
.addEventListener('click', (event) => {
46-
document.getElementById("app-logs").innerHTML = "";
47-
},
59+
.addEventListener('click', (event) => {
60+
document.getElementById("app-logs").innerHTML = "";
61+
},
4862
false);
4963

5064
AppCommon.AppEvents.on('Logger', (message) => {
5165
var msg = "[" + new Date().toISOString() + "] :: " + message;
5266
var temp = document.getElementById("app-logs").innerHTML;
5367
document.getElementById("app-logs").innerHTML = '<p>' + msg + '</p>' + temp;
54-
} );
68+
});
5569

5670
AppCommon.AppEvents.on('ConnectionFailed', (message) => {
5771
debugger;
5872
isConnected = false;
5973
alert('Connection Failed: Not able to establised the connection. Please check the Url.');
6074
AppCommon.AppEvents.off('ReceivedData', HandleResponse);
61-
} );
75+
});
6276

6377
AppCommon.AppEvents.on('OnConnected', OnConnected);
6478

6579
NotConnected();
6680
RigisterNavigationTabEvent();
6781

6882
document.getElementById('chk-req-token')
69-
.addEventListener('change', (event) => {
70-
if (event.target.checked) {
71-
document.getElementById('authHeader').disabled= false;
72-
window.appLogic.EnableAuth();
73-
} else {
74-
window.appLogic.DisableAuth();
75-
document.getElementById('authHeader').disabled= true;
76-
}
77-
});
83+
.addEventListener('change', (event) => {
84+
if (event.target.checked) {
85+
document.getElementById('authHeader').disabled = false;
86+
window.appLogic.EnableAuth();
87+
} else {
88+
window.appLogic.DisableAuth();
89+
document.getElementById('authHeader').disabled = true;
90+
}
91+
});
7892

7993
}
8094

81-
//#region ConnectedEvent
82-
83-
AppCommon.AppEvents.on('Init', () => {
84-
//console.log('Init Event Emitter');
85-
} );
86-
87-
//#endregion
88-
89-
//#region OnDisconnected
90-
AppCommon.AppEvents.on('OnDisconnected', () => {
91-
if(window.appLogic.GetCurrentView() !== true) {
92-
document.getElementById('chk-ws').disabled= false;
93-
document.getElementById('chk-sse').disabled= false;
94-
}
95-
} );
96-
//#endregion
97-
9895
export function RigisterNavigationTabEvent() {
9996

10097
var navLinkClass = document.getElementsByClassName('nav-link');
@@ -121,19 +118,19 @@ export function OnTabChange(tabName) {
121118

122119
export function AdvanceViewElements(enable) {
123120

124-
if(enable === true) {
121+
if (enable === true) {
125122
document.getElementById('protocol-support').style = 'display:block';
126123
document.getElementById('auth-container').style = 'display:block';
127-
if(isConnected === true) {
124+
if (isConnected === true) {
128125
document.getElementById('chk-req-token').disabled = true;
129126
document.getElementById('authHeader').disabled = true;
130127
AppCommon.DisableElementByClassName('protocol-support');
131-
}
128+
}
132129
else {
133130
document.getElementById('chk-req-token').disabled = false;
134-
if(window.appLogic.IsAuthEnabled() === true) {
131+
if (window.appLogic.IsAuthEnabled() === true) {
135132
document.getElementById('authHeader').disabled = false;
136-
}
133+
}
137134
}
138135
}
139136
else {
@@ -182,7 +179,7 @@ export function GetSelectElement() {
182179
var optionNum = document.createElement('option');
183180
var optionJsonObj = document.createElement('option');
184181

185-
optionTxt.value = AppCommon.ContentType.TEXT
182+
optionTxt.value = AppCommon.ContentType.TEXT
186183
optionTxt.text = "Text";
187184
selectElement.add(optionTxt, null);
188185

@@ -220,8 +217,7 @@ export function GetImageElement() {
220217

221218
var imgElement = document.createElement('img');
222219
imgElement.src = deleteImg;
223-
imgElement.addEventListener('click', function() {
224-
console.log('Delete Button');
220+
imgElement.addEventListener('click', function () {
225221
this.parentElement.parentElement.remove();
226222
});
227223
div.appendChild(imgElement);
@@ -231,7 +227,7 @@ export function GetImageElement() {
231227
export function ReadArguments() {
232228
var requestArgs = new Array();
233229
var argsContainers = document.querySelectorAll('.args-container');
234-
230+
235231
if (argsContainers.length == 0) {
236232
return requestArgs;
237233
}
@@ -240,8 +236,8 @@ export function ReadArguments() {
240236
var textBox = el.querySelector('.req-arg-txt').value;
241237
var selectList = el.querySelector('.req-content-type').value;
242238

243-
if(textBox !== "") {
244-
requestArgs.push({cType: selectList, data: textBox });
239+
if (textBox !== "") {
240+
requestArgs.push({ cType: selectList, data: textBox });
245241
}
246242
});
247243

@@ -253,13 +249,13 @@ export function ReadAndFormatArguments() {
253249
var requestArguments = new Array();
254250

255251
args.forEach((d) => {
256-
if(d.cType == AppCommon.ContentType.NUMBER) {
252+
if (d.cType == AppCommon.ContentType.NUMBER) {
257253
requestArguments.push(Number(d.data));
258-
}
259-
else if(d.cType == AppCommon.ContentType.JSON) {
254+
}
255+
else if (d.cType == AppCommon.ContentType.JSON) {
260256
requestArguments.push(JSON.parse(d.data));
261257
}
262-
else if(d.cType == AppCommon.ContentType.TEXT) {
258+
else if (d.cType == AppCommon.ContentType.TEXT) {
263259
requestArguments.push(d.data);
264260
}
265261
});
@@ -268,7 +264,7 @@ export function ReadAndFormatArguments() {
268264
}
269265

270266
export function NotConnected() {
271-
console.log("notConnected");
267+
console.log("Not Connected");
272268
var onConnectClass = document.getElementsByClassName('onconnect');
273269

274270
for (var i = 0; i < onConnectClass.length; i++) {
@@ -293,7 +289,7 @@ export function connectToServer(url) {
293289
export function OnConnect() {
294290

295291
var isAdvanceView = !window.appLogic.GetCurrentView();
296-
if(isAdvanceView) {
292+
if (isAdvanceView) {
297293
SetConnectionProtocol();
298294
}
299295

@@ -320,33 +316,29 @@ export function OnConnected() {
320316
}
321317

322318
export function HandleResponse(data) {
323-
document.querySelector("#inputResponseData").value += JSON.stringify(data) + '\n';
319+
document.querySelector("#inputResponseData").value += JSON.stringify(data) + '\n';
324320
}
325321

326322
export function SetConnectionProtocol() {
327323
var elements = document.querySelectorAll(".protocol-support");
328324

329-
for(var i = 0; i < elements.length; i++)
330-
{
331-
if(elements[i].value === "ws" && elements[i].checked !== true)
332-
{
325+
for (var i = 0; i < elements.length; i++) {
326+
if (elements[i].value === "ws" && elements[i].checked !== true) {
333327
console.log("WebSocket disabled");
334328
WebSocket = undefined;
335329
}
336-
else if(elements[i].value === "sse" && elements[i].checked !== true)
337-
{
330+
else if (elements[i].value === "sse" && elements[i].checked !== true) {
338331
console.log("Server Sent Event disabled");
339332
EventSource = undefined;
340333
}
341-
else if(elements[i].value === "lp" && elements[i].checked !== true)
342-
{
334+
else if (elements[i].value === "lp" && elements[i].checked !== true) {
343335
//console.log("Server Sent Event disabled");
344336
}
345337
}
346338
}
347339

348340
export function OnDisConnect() {
349-
console.log("OnDisConnect");
341+
console.log("On DisConnect");
350342
isConnected = false;
351343
Disconnect();
352344
AppCommon.HideElementByClassName('onconnect');
@@ -363,7 +355,7 @@ export function OnDisConnect() {
363355
export function Reset() {
364356
//Clear Server Method Text
365357
document.getElementById('inputServerMethod').value = "";
366-
358+
367359
var addArgBtnClass = document.getElementsByClassName('btn-add-argument');
368360
for (var i = 0; i < addArgBtnClass.length; i++) {
369361
addArgBtnClass[i].removeEventListener('click', AddArgumentsCallBack, false);
@@ -380,7 +372,7 @@ export function SendPayload() {
380372

381373
var methodName = document.getElementById("inputServerMethod").value;
382374
var methodArguments = new Array();
383-
375+
384376
methodArguments = ReadAndFormatArguments();
385-
window.appLogic.OnSend({ methodName: methodName, methodArguments: methodArguments});
377+
window.appLogic.OnSend({ methodName: methodName, methodArguments: methodArguments });
386378
}

0 commit comments

Comments
 (0)