5 |
6 | ### AKSoftware.Blazor.Utilities
7 |
8 | #### ⚡ ⚡ 🚀 Send data across your components fluently with the Messaging Center ⚡ ⚡ 🚀
9 | Paramters, Cascading Parameters and Event Callbacks are ways to send data across components but MessagingCenter is much easier and straightforward
10 | 
11 |
12 |
13 | If you are a Xamarin.Forms developer, you definitely passed across the MessagingCenter class that was being used to send messages across objects, this class helps a lot by pushing data across components in the system effiecently.
14 | And now for Blazor Messaging Center is a great tool to use to solve the issue of sending the data across components and updating them.
15 | Using MessagingCenter you will be able to send data from one component to another or to a set of other components just with one line of code despite the relationship between those components (Parent - Child .etc...)
16 | The following illustration shows the benefits of using MessagingCenter to send data between the components.
17 |
18 | ### Messaging Center Quick Explanation:
19 | 
20 | ## Package Content:
21 | For now package the **AKSoftware.Blazor.Utilities** just contains the ***MessagingCenter*** service which is the same that is implemented in Xamarin.Forms to be used in Blazor projects as a service to send the data across the components using the Publish - Subscription pattern in addition to the existing model of Parameters & Event Callbacks.
22 |
23 | > **Note:** The messaging center class with the current package is the same class and cloned from the Xamarin.Forms repository from the following link [Xamarin.Forms](https://github.com/xamarin/Xamarin.Forms/blob/5.0.0/Xamarin.Forms.Core/MessagingCenter.cs)
24 |
25 | ## Check out the sample project:
26 | In the current repository you can find a sample project to use the MessagingCenter service in Blazor that shows how to send a string value from one component to two other components without a direct relationship between them and update their states.
27 | The example shows using updating the username in a form component then using MessagingCenter we can send that update to the NavMenu component and the MainLayout and update the value there.
28 | Check out the following folder:
29 |
30 | ## 🌎 👷 Get Started with Blazor MessagingCenter ⛳
31 | Make sure to instal the NuGet package of the library using the ***NuGet command***
32 | ```
33 | Install-Package AKSoftware.Blazor.Utilities
34 | ```
35 |
36 | Or through the ***.NET CLI***
37 | ```
38 | dotnet package install AKSoftware.Blazor.Utilities
39 | ```
40 |
41 | Now in the **_imports.razor** and add the following namesapce
42 | ``` Razor
43 | @using AKSoftware.Blazor.Utilities
44 | ```
45 |
46 | ## ⚡ 🚀 Publish a message 🚀 ⚡
47 | From the component that you want to send data from example a sample string like the example in the repository
48 |
49 | > The code takes a the sender object as a parameter, the filter of the message like for this example "greeting_message" which will be used by other components to receive the message, and the last parameter is the value to be sent
50 |
51 | ``` C#
52 | public void SendMessage()
53 | {
54 | string valueToSend = "Hi from Component 1";
55 | MessagingCenter.Send(this, "greeting_message", valueToSend);
56 | }
57 | ```
58 |
59 | ## ✈️ Receive a message from destination component ✈️
60 |
61 | In the destination component all you can do is calling the subscribe method to subscribe for a target of messaging
62 |
63 | Blazor WebAssembly
64 |
65 | ``` C#
66 | public void SubscribeToMessage()
67 | {
68 | MessagingCenter.Subscribe
13 | Welcome @_username
14 |
15 |
16 |
17 | @Body
18 |
19 | Sorry, there's nothing at this address.
8 |Counter
4 | 5 |Current count: @currentCount
6 | 7 | 8 | 9 | @code { 10 | private int currentCount = 0; 11 | 12 | private void IncrementCount() 13 | { 14 | currentCount++; 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /src/BlazorUtilitiesSample/Pages/FetchData.razor: -------------------------------------------------------------------------------- 1 | @page "/fetchdata" 2 | @inject HttpClient Http 3 | 4 |Weather forecast
5 | 6 |This component demonstrates fetching data from the server.
7 | 8 | @if (forecasts == null) 9 | { 10 |Loading...
11 | } 12 | else 13 | { 14 || Date | 18 |Temp. (C) | 19 |Temp. (F) | 20 |Summary | 21 |
|---|---|---|---|
| @forecast.Date.ToShortDateString() | 28 |@forecast.TemperatureC | 29 |@forecast.TemperatureF | 30 |@forecast.Summary | 31 |
Hello, world!
4 | 5 | Welcome to your new app. 6 | 7 |Update my Username
4 |
5 |
13 |
14 |
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/Pages/MyAccount.razor.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using System.Threading.Tasks;
5 | using Microsoft.AspNetCore.Components;
6 | using System.Net.Http;
7 | using System.Net.Http.Json;
8 | using Microsoft.AspNetCore.Components.Forms;
9 | using Microsoft.AspNetCore.Components.Routing;
10 | using Microsoft.AspNetCore.Components.Web;
11 | using Microsoft.AspNetCore.Components.Web.Virtualization;
12 | using Microsoft.AspNetCore.Components.WebAssembly.Http;
13 | using Microsoft.JSInterop;
14 | using BlazorUtilitiesSample;
15 | using BlazorUtilitiesSample.Shared;
16 | using AKSoftware.Blazor.Utilities;
17 |
18 | namespace BlazorUtilitiesSample.Pages
19 | {
20 | public partial class MyAccount
21 | {
22 |
23 | private string _username = UserSettings.DefaultUsername;
24 |
25 | private void OnEnterClicked(KeyboardEventArgs args)
26 | {
27 | if (args.Key == "Enter")
28 | {
29 | UpdateUsername();
30 | }
31 | }
32 |
33 | private void UpdateUsername()
34 | {
35 | // Set the new value of the username
36 | UserSettings.DefaultUsername = _username;
37 |
38 | // Send the updated
39 | // You can use the Send function to send the sender object with the value you want to send
40 | MessagingCenter.Send(this, "username_updated", _username);
41 | }
42 |
43 | private void OnInputChange(ChangeEventArgs e)
44 | {
45 | _username = e.Value.ToString();
46 | }
47 |
48 | }
49 | }
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/Program.cs:
--------------------------------------------------------------------------------
1 | using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
2 | using Microsoft.Extensions.Configuration;
3 | using Microsoft.Extensions.DependencyInjection;
4 | using Microsoft.Extensions.Logging;
5 | using System;
6 | using System.Collections.Generic;
7 | using System.Net.Http;
8 | using System.Text;
9 | using System.Threading.Tasks;
10 |
11 | namespace BlazorUtilitiesSample
12 | {
13 | public class Program
14 | {
15 | public static async Task Main(string[] args)
16 | {
17 | var builder = WebAssemblyHostBuilder.CreateDefault(args);
18 | builder.RootComponents.Add
6 |
12 |
7 |
8 |
9 |
10 |
11 |
7 |
10 |
11 |
21 |
22 | @code
23 | {
24 |
25 | private string _username = UserSettings.DefaultUsername;
26 |
27 | protected override void OnInitialized()
28 | {
29 | string newUsername = string.Empty;
30 |
31 | // Subscribe to "username_updated" message so we can take an action whenever the username gots udpatd from the my account page
32 | MessagingCenter.Subscribe
12 |
20 |
12 |
34 |
35 |
36 | @code {
37 | private bool collapseNavMenu = true;
38 |
39 | private string NavMenuCssClass => collapseNavMenu ? "collapse" : null;
40 |
41 | private void ToggleNavMenu()
42 | {
43 | collapseNavMenu = !collapseNavMenu;
44 | }
45 |
46 | private string _username = UserSettings.DefaultUsername;
47 |
48 | protected override void OnInitialized()
49 | {
50 | // Subscribe to "username_updated" message so we can take an action whenever the username gots udpatd from the my account page
51 | MessagingCenter.Subscribe
2 |
3 | @Title
4 |
5 |
6 | Please take our
7 | brief survey
8 |
9 | and tell us what you think.
10 |
11 |
12 | @code {
13 | // Demonstrates how a parent component can supply parameters
14 | [Parameter]
15 | public string Title { get; set; }
16 | }
17 |
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/UserSettings.cs:
--------------------------------------------------------------------------------
1 | namespace BlazorUtilitiesSample
2 | {
3 | public class UserSettings
4 | {
5 | public static string DefaultUsername = "Ahmad Mozaffar";
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/_Imports.razor:
--------------------------------------------------------------------------------
1 | @using System.Net.Http
2 | @using System.Net.Http.Json
3 | @using Microsoft.AspNetCore.Components.Forms
4 | @using Microsoft.AspNetCore.Components.Routing
5 | @using Microsoft.AspNetCore.Components.Web
6 | @using Microsoft.AspNetCore.Components.Web.Virtualization
7 | @using Microsoft.AspNetCore.Components.WebAssembly.Http
8 | @using Microsoft.JSInterop
9 | @using BlazorUtilitiesSample
10 | @using BlazorUtilitiesSample.Shared
11 |
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/wwwroot/css/app.css:
--------------------------------------------------------------------------------
1 | @import url('open-iconic/font/css/open-iconic-bootstrap.min.css');
2 |
3 | html, body {
4 | font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
5 | }
6 |
7 | a, .btn-link {
8 | color: #0366d6;
9 | }
10 |
11 | .btn-primary {
12 | color: #fff;
13 | background-color: #1b6ec2;
14 | border-color: #1861ac;
15 | }
16 |
17 | .content {
18 | padding-top: 1.1rem;
19 | }
20 |
21 | .valid.modified:not([type=checkbox]) {
22 | outline: 1px solid #26b050;
23 | }
24 |
25 | .invalid {
26 | outline: 1px solid red;
27 | }
28 |
29 | .validation-message {
30 | color: red;
31 | }
32 |
33 | #blazor-error-ui {
34 | background: lightyellow;
35 | bottom: 0;
36 | box-shadow: 0 -1px 2px rgba(0, 0, 0, 0.2);
37 | display: none;
38 | left: 0;
39 | padding: 0.6rem 1.25rem 0.7rem 1.25rem;
40 | position: fixed;
41 | width: 100%;
42 | z-index: 1000;
43 | }
44 |
45 | #blazor-error-ui .dismiss {
46 | cursor: pointer;
47 | position: absolute;
48 | right: 0.75rem;
49 | top: 0.5rem;
50 | }
51 |
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/wwwroot/css/open-iconic/FONT-LICENSE:
--------------------------------------------------------------------------------
1 | SIL OPEN FONT LICENSE Version 1.1
2 |
3 | Copyright (c) 2014 Waybury
4 |
5 | PREAMBLE
6 | The goals of the Open Font License (OFL) are to stimulate worldwide
7 | development of collaborative font projects, to support the font creation
8 | efforts of academic and linguistic communities, and to provide a free and
9 | open framework in which fonts may be shared and improved in partnership
10 | with others.
11 |
12 | The OFL allows the licensed fonts to be used, studied, modified and
13 | redistributed freely as long as they are not sold by themselves. The
14 | fonts, including any derivative works, can be bundled, embedded,
15 | redistributed and/or sold with any software provided that any reserved
16 | names are not used by derivative works. The fonts and derivatives,
17 | however, cannot be released under any other type of license. The
18 | requirement for fonts to remain under this license does not apply
19 | to any document created using the fonts or their derivatives.
20 |
21 | DEFINITIONS
22 | "Font Software" refers to the set of files released by the Copyright
23 | Holder(s) under this license and clearly marked as such. This may
24 | include source files, build scripts and documentation.
25 |
26 | "Reserved Font Name" refers to any names specified as such after the
27 | copyright statement(s).
28 |
29 | "Original Version" refers to the collection of Font Software components as
30 | distributed by the Copyright Holder(s).
31 |
32 | "Modified Version" refers to any derivative made by adding to, deleting,
33 | or substituting -- in part or in whole -- any of the components of the
34 | Original Version, by changing formats or by porting the Font Software to a
35 | new environment.
36 |
37 | "Author" refers to any designer, engineer, programmer, technical
38 | writer or other person who contributed to the Font Software.
39 |
40 | PERMISSION & CONDITIONS
41 | Permission is hereby granted, free of charge, to any person obtaining
42 | a copy of the Font Software, to use, study, copy, merge, embed, modify,
43 | redistribute, and sell modified and unmodified copies of the Font
44 | Software, subject to the following conditions:
45 |
46 | 1) Neither the Font Software nor any of its individual components,
47 | in Original or Modified Versions, may be sold by itself.
48 |
49 | 2) Original or Modified Versions of the Font Software may be bundled,
50 | redistributed and/or sold with any software, provided that each copy
51 | contains the above copyright notice and this license. These can be
52 | included either as stand-alone text files, human-readable headers or
53 | in the appropriate machine-readable metadata fields within text or
54 | binary files as long as those fields can be easily viewed by the user.
55 |
56 | 3) No Modified Version of the Font Software may use the Reserved Font
57 | Name(s) unless explicit written permission is granted by the corresponding
58 | Copyright Holder. This restriction only applies to the primary font name as
59 | presented to the users.
60 |
61 | 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
62 | Software shall not be used to promote, endorse or advertise any
63 | Modified Version, except to acknowledge the contribution(s) of the
64 | Copyright Holder(s) and the Author(s) or with their explicit written
65 | permission.
66 |
67 | 5) The Font Software, modified or unmodified, in part or in whole,
68 | must be distributed entirely under this license, and must not be
69 | distributed under any other license. The requirement for fonts to
70 | remain under this license does not apply to any document created
71 | using the Font Software.
72 |
73 | TERMINATION
74 | This license becomes null and void if any of the above conditions are
75 | not met.
76 |
77 | DISCLAIMER
78 | THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
79 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
80 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
81 | OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
82 | COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
83 | INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
84 | DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
85 | FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
86 | OTHER DEALINGS IN THE FONT SOFTWARE.
87 |
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/wwwroot/css/open-iconic/ICON-LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2014 Waybury
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
--------------------------------------------------------------------------------
/src/BlazorUtilitiesSample/wwwroot/css/open-iconic/README.md:
--------------------------------------------------------------------------------
1 | [Open Iconic v1.1.1](http://useiconic.com/open)
2 | ===========
3 |
4 | ### Open Iconic is the open source sibling of [Iconic](http://useiconic.com). It is a hyper-legible collection of 223 icons with a tiny footprint—ready to use with Bootstrap and Foundation. [View the collection](http://useiconic.com/open#icons)
5 |
6 |
7 |
8 | ## What's in Open Iconic?
9 |
10 | * 223 icons designed to be legible down to 8 pixels
11 | * Super-light SVG files - 61.8 for the entire set
12 | * SVG sprite—the modern replacement for icon fonts
13 | * Webfont (EOT, OTF, SVG, TTF, WOFF), PNG and WebP formats
14 | * Webfont stylesheets (including versions for Bootstrap and Foundation) in CSS, LESS, SCSS and Stylus formats
15 | * PNG and WebP raster images in 8px, 16px, 24px, 32px, 48px and 64px.
16 |
17 |
18 | ## Getting Started
19 |
20 | #### For code samples and everything else you need to get started with Open Iconic, check out our [Icons](http://useiconic.com/open#icons) and [Reference](http://useiconic.com/open#reference) sections.
21 |
22 | ### General Usage
23 |
24 | #### Using Open Iconic's SVGs
25 |
26 | We like SVGs and we think they're the way to display icons on the web. Since Open Iconic are just basic SVGs, we suggest you display them like you would any other image (don't forget the `alt` attribute).
27 |
28 | ```
29 | 
30 | ```
31 |
32 | #### Using Open Iconic's SVG Sprite
33 |
34 | Open Iconic also comes in a SVG sprite which allows you to display all the icons in the set with a single request. It's like an icon font, without being a hack.
35 |
36 | Adding an icon from an SVG sprite is a little different than what you're used to, but it's still a piece of cake. *Tip: To make your icons easily style able, we suggest adding a general class to the* `