2 |
3 | [](https://badge.fury.io/nu/DotNetify.Blazor)
4 |
5 | **DotNetify-Blazor** is a free, open source project that lets you create real-time, reactive, cross-platform apps with Blazor WebAssembly.
6 |
7 | ## Features
8 |
9 | - Server-side view model: don't let your client download too much code; keep most processing on the back-end and only send things that change.
10 | - Declarative state hydration: eliminate the need to write data-fetching boilerplate services. Send data to the back-end by simply invoking an interface method.
11 | - Simple real-time abstraction: push data to client in real-time from multiple classes with no coupling to low-level SignalR details.
12 | - **Can switch to Web API**: don't need real-time/SignalR? Keep your view model stateless and switch to Web API endpoint instead.
13 | - **Scoped CSS**: built-in support for SASS-like syntax and replacing styles at runtime!
14 | - **[Web Components](https://dotnetify.net/elements?webcomponent)**: comes with a library of HTML native web components to implement layouts, online forms, charts, and more --- all supporting CSS isolation. Usage is optional!
15 | - **Reusable with Javascript SPAs**: Can't always use Blazor? The same view models you write for Blazor can be reused with Javascript UI frameworks without change. DotNetify has full support for React and Vue, and can be made to work with Angular and others.
16 | - **Reusable with .NET desktop clients**: reuse the same view models with .NET-based client apps (WPF/Avalonia).
17 | - **Multicasting**: send real-time data to multiple clients at once; perfect for real-time collaboration/data sync.
18 | - **Reactive**: make your view model declarative with streaming, observable properties + asynch programming.
19 | - **Dependency injection**: inject dependency objects through the class constructor.
20 | - **Middlewares/filters**: build a pipeline to do all sorts of things before reaching the view models.
21 | - **Bearer token authentication**: pass authentication header as payload instead of query string.
22 |
23 | ## Install
24 |
25 | ```
26 | dotnet add package DotNetify.Blazor
27 | ```
28 |
29 | ## Documentation
30 |
31 | Documentation and live demo can be found at [https://dotnetify.net/blazor](https://dotnetify.net/blazor).
32 |
33 | DotNetify core repo: [https://github.com/dsuryd/dotNetify](https://github.com/dsuryd/dotNetify).
34 |
35 | ## License
36 |
37 | Licensed under the Apache License, Version 2.0.
38 |
39 | ## Contributing
40 |
41 | All contribution is welcome: star this project, let others know about it, report issues, submit pull requests!
42 |
43 | _Logo design by [area55git](https://github.com/area55git)._
44 |
--------------------------------------------------------------------------------
/Source/ClientConfiguration.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | using System.Reflection;
18 | using System.Text.Json.Serialization;
19 |
20 | namespace DotNetify.Blazor
21 | {
22 | public class ClientConfiguration
23 | {
24 | ///
25 | /// Enable debug output on the browser's developer console.
26 | ///
27 | public bool Debug { get; set; }
28 |
29 | ///
30 | /// DotNetify hub server URL.
31 | ///
32 | public string HubServerUrl { get; set; }
33 |
34 | ///
35 | /// Assemblies to look for StyleSheet files.
36 | ///
37 | [JsonIgnore]
38 | public Assembly[] StyleSheetAssemblies { get; set; }
39 |
40 | ///
41 | /// Web socket server URL (ws://).
42 | ///
43 | public string WebSocketServerUrl { get; set; }
44 | }
45 | }
--------------------------------------------------------------------------------
/Source/DotNetify.Blazor.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | net6.0
5 | true
6 | 8.0
7 | 3.0
8 | true
9 | DotNetify.Blazor
10 | 2.1.2
11 | DotNetify.Blazor
12 | Dicky Suryadi
13 | DotNetify.Blazor
14 | Real-time, reactive MVVM library for Blazor web assembly apps.
15 | Copyright 2019-2022
16 | https://dotnetify.net
17 | https://github.com/dsuryd/dotNetify-Blazor
18 | LICENSE.md
19 | true
20 | dotnetify.png
21 |
22 |
23 |
24 | DEBUG;TRACE
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/Source/ElementEventArgs.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | namespace DotNetify.Blazor
18 | {
19 | public class ElementEventArgs
20 | {
21 | ///
22 | /// Identifies the DOM element raising the event.
23 | ///
24 | public string TargetId { get; set; }
25 |
26 | ///
27 | /// Event name.
28 | ///
29 | public string EventName { get; set; }
30 |
31 | ///
32 | /// Event arguments.
33 | ///
34 | public object EventArgs { get; set; }
35 | }
36 | }
--------------------------------------------------------------------------------
/Source/ExceptionEventArgs.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | namespace DotNetify.Blazor
18 | {
19 | public class ExceptionEventArgs
20 | {
21 | ///
22 | /// Exception name.
23 | ///
24 | public string Name { get; set; }
25 |
26 | ///
27 | /// Exception message.
28 | ///
29 | public string Message { get; set; }
30 | }
31 | }
--------------------------------------------------------------------------------
/Source/IStylesheet.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | namespace DotNetify.Blazor
18 | {
19 | public interface IStyleSheet
20 | {
21 | ///
22 | /// Gets the style sheet content of an embedded resource. It doesn't need the full name, only a sufficiently unique substring.
23 | ///
24 | /// Name of the embedded resource containing a style sheet.
25 | string this[string embeddedResourceName] { get; }
26 | }
27 | }
--------------------------------------------------------------------------------
/Source/IVMProxy.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | using System;
18 | using System.Collections.Generic;
19 | using System.Threading.Tasks;
20 | using Microsoft.AspNetCore.Components;
21 |
22 | namespace DotNetify.Blazor
23 | {
24 | public interface IVMProxy : IDisposable
25 | {
26 | ///
27 | /// Reference to the associated 'd-vm-context' HTML markup.
28 | ///
29 | ElementReference ElementRef { get; set; }
30 |
31 | ///
32 | /// Listens to the state change event from the server-side view model.
33 | ///
34 | /// Gets called when the client receives state change from the server-side view model.
35 | Task HandleStateChangeAsync(Action stateChangeEventCallback);
36 |
37 | ///
38 | /// Listens to the events from the web component elements under this VM context.
39 | ///
40 | /// Gets called when an element under this VM context raises an event.
41 | Task HandleElementEventAsync(Action eventCallback);
42 |
43 | ///
44 | /// Listens to the exception event from the server-side view model.
45 | ///
46 | /// Gets called when the client receives exception from the server-side view model.
47 | Task HandleExceptionAsync(Action exceptionEventCallback);
48 |
49 | ///
50 | /// Listens to an event from a DOM element.
51 | ///
52 | /// Event argument type.
53 | /// Document element.
54 | /// Event name.
55 | /// Event callback.
56 | Task HandleDomEventAsync(string eventName, ElementReference domElement, Action eventCallback);
57 |
58 | ///
59 | /// Dispatches property value to server-side view model.
60 | ///
61 | /// Name that matches a server-side view model property.
62 | /// Value to be dispatched.
63 | Task DispatchAsync(string propertyName, object propertyValue = null);
64 |
65 | ///
66 | /// Dispatches multiple property values to server-side view model.
67 | ///
68 | /// Dictionary of property name and values.
69 | Task DispatchAsync(Dictionary properties);
70 |
71 | ///
72 | /// Disposes the context element.
73 | ///
74 | ///
75 | Task DisposeAsync();
76 | }
77 | }
--------------------------------------------------------------------------------
/Source/IVMState.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | using System;
18 |
19 | namespace DotNetify.Blazor
20 | {
21 | ///
22 | /// Use this attribute on a property to make any changed value to be dispatched to the server view model.
23 | ///
24 | [AttributeUsage(AttributeTargets.Property)]
25 | public class WatchAttribute : Attribute
26 | {
27 | }
28 |
29 | ///
30 | /// Required interface for view model state that wants to use watch attributes.
31 | ///
32 | public interface IVMState
33 | {
34 | IVMProxy VMProxy { get; set; }
35 | }
36 | }
--------------------------------------------------------------------------------
/Source/JSCallback.cs:
--------------------------------------------------------------------------------
1 | /*
2 | Copyright 2020 Dicky Suryadi
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 | */
16 |
17 | using Microsoft.JSInterop;
18 | using System;
19 |
20 | namespace DotNetify.Blazor
21 | {
22 | public class JSCallback
23 | {
24 | private readonly Action
