Razor Class Library with ASP.NET Core MVC
ASP.NET Core 2.1 introduces Razor Class Library (RCL). It’s the new way how to share reusable web application components with UI as dependent project or NuGet package. As public examples mostly cover how it works with Razor Pages, I decided to write this blog post and demo application for ASP.NET Core MVC.
Source code available! I created demo application that shows all stuff written here. Feel free to visit my GitHub repository gpeipman/RazorClassLibraryDemo. To make it work it’s important to have stable release of .NET Core 2.1 without any preview or release candidate releases.
What is Razor Class Library?
Razor Class Library is ASP.NET Core library that contains pages, views, view components and other web application artifacts with their respective code. Library doesn’t run independent – there must be application that includes library and uses its functionalities. Razor class libraries make it easy to share web applications code with UI elements.
Razor class libraries doesn’t work well on preview and release candidate versions of ASP.NET Core 2.1.
Screenshot on right shows default structure. For some reason the project comes with Razor page. There is nothing about MVC and there’s also no project template for Razor class library with MVC structure.
But MVC is actually supported and it’s up to us to build the project structure we need.
Referencing Razor class library
There are two ways to reference Razor class library:
- Project reference
- NuGet package
If class library is in same solution with web application then project reference is enough.
Another important dependency is project dependency under build dependencies menu (right click on web application and select Build dependencies).
Setting this dependency tells Visual Studio that library project must be built before web application one.
Moving to MVC
There are some things to know:
- Controllers must have AreaAttribute
- Web application must have area route defined
Now let’s implement these changes and let’s make things work.
We start with HomeController in library project. I started with minimal and extremely primitive code.
[Area("MyFeature")]
public class HomeController : Controller
{
public IActionResult Index()
{
return View();
}
}
Same goes for Index view of HomeController.
<h1>Hello from MyFeature</h1>
In Startup class of web application include MVC like show here (Configure method).
app.UseMvc(routes =>
{
routes.MapRoute("areas", "{area}/{controller=Home}/{action=Index}/{id?}");
routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});
Now we are ready to run our application and try out view from Razor class library.
Hold on, what the hell is this? Well… we have area defined in another project and what’s going on in web application doesn’t apply to it fully. We need to copy _ViewStart.cshtml file under Shared folder in Razor class library. After this things get better.
This is the easiest method to use and it works well for applications with only one layout.
Overriding Razor class library views
It’s possible we want to use our own view instead of one that comes with Razor classlibrary.
It’s possible to override also controllers the same way but this is more complex topic and it needs some good analyzis before doing so. The question comes down to simple thing – is library author expecting something like this to happen?
Image on right shows how I replicated areas structure in Razor class library above to web application. Notice how there is only the index view of HomeController that I want to override.
Here is the primitive content of overriden view.
<h1>Hello from overridden MyFeature</h1>
And here is our overridden view in action.
If needed we can override views but we have to be careful – views from Razor class library may contain logic we don’t know.
Wrapping up
Razor Class Library is excellent way how to share web application components and UI artifacts. It’s not just about sharing components between projects in same solution – we can share our Razor class libraries as NuGet packages. The model seems flexible enough for me as it easy to take risks of overriding controllers, models, views and other components. I don’t give any suggestion right now about overriding as I am not yet sure what weight it actually puts to those responsible of Razor class libraries. Anyway, with Razor class libraries one problem is solved again.
Pingback:The Morning Brew - Chris Alcock » The Morning Brew #2598
“Razor class libraries doesn’t work well on preview and release candidate versions of ASP.NET Core 2.1.”
“It is recommended to put custom UI pieces to areas and it is up to developers to make sure that the names of areas doesn’t match.”
Is the meaning of these 2 sentences intended?
Yes, of course.
1. I tried to run my sample on ASP.NET Core 2.1 preview and release candidate. On both there were issues with finding views for controllers in RCL. With release version everything works fine.
2. There’s no central repository of area names and it’s impossible to know for public packages if some area name is taken or not. I’m trying to find some nice solution for naming conflicts.
Pingback:Razor Class Library with ASP.NET Core MVC - How to Code .NET
Pingback:ASP.NET Core Identity scaffolding | Gunnar Peipman - Programming Blog
Great information. Since last week, I am gathering details about asp experience. There are some amazing details on your blog which I didn’t know. Thanks.
Thanks a lot
Is there a way to store static content (JavaScript, CSS) in a RCL?
AFAIK there’s no straightforward way include static files. It’s possible to embed these files as resources and then use controller to extract them.
Example can be found here: https://github.com/aspnet/Docs/issues/7662
public class MiniCMSContentController : Controller
{
static Dictionary mime = new Dictionary {
{ “.js”, “text/javascript” },
{ “.css”, “text/css” },
};
[Route(“/MiniCMS/Content/{filename}”)]
public IActionResult Index(string filename)
{
string outMime = “application/unknown”;
mime.TryGetValue(Path.GetExtension(filename).ToLower(), out outMime);
return new FileStreamResult(Assembly.GetExecutingAssembly().GetManifestResourceStream(“MiniCMS.Content.” + filename), outMime);
}
}
I have not tried this approach out in practice and cannot tell you if there are hidden issues or not.
Very good article, thank you, saved me some time today. It seems the html helper tags does not work, need to figure this one out now.
Just add _ViewImports.cshtml to views as done with _ViewStart.cshtml
Nice Article,
Works fine if the RCL is as a project added to the main project.
However the moment I try to add it as a compiled assembly, I can’t seem to make it to work.
I even loaded my 2 assemblies (razor and view) through ApplicationPartManager and ConfigureApplicationPartManager.
I get some strange error
Invalid operation: The model item passed into the ViewDataDictionary is of type ‘xxx.ViewModel’, but this ViewDataDictionary instance requires a model of type ‘xxx.ViewModel’
Are you able to make that work as just an assembly ?
Informative insights! I am new to ASP.Net programming. Your article has helped me understand its basics and learn more about razor pages. I am obliged for this informative article, keep sharing.
I have learnt a lot from this article.
What is difference between RCL and other asp.net Non-RCL Library?
Thanks for your article!
It is a useful topic for people
I’m curious about something. In the article it says, “It’s possible to override also controllers the same way but this is more complex topic and it needs some good analyzis before doing so.” I haven’t been able to figure out how this would work. When I try to create a default set of controller actions in my RCL and then another set in the main project, I keep running into an AmbiguousActionException. Anyone have any thoughts on whether it is actually possible to override controllers the same way as views? Thanks!
Read the opinions and always take a look at the platforms before giving these web sites money. Charm Date affords a lot of reductions and bonuses to both its new and existing users – you should buy 2 credit for $4 instead of $16, and you’ll also get free premium membership, free First Mails, free minutes of chat, and so on. But there’s no have to pay for those who solely want to test this site – you will get free bonus factors for finishing your profile and check out if this site can work for you. 6. Professional Networking Events: Attending professional networking events, conferences, or industry gatherings associated to your subject of work might be a great way to fulfill single Ukrainian ladies who’re professionals in varied industries. In terms of employment, Ukrainian women often discover work in quite a lot of fields, including healthcare, education, finance, know-how, and hospitality. Joining groups or pages devoted to Ukrainian culture, language, or expat communities may help you discover and connect with like-minded individuals. Adapting to a brand new language, customs, and social norms might be daunting, but many Ukrainian ladies demonstrate resilience, determination, and adaptableness as they carve out their place in American society. This isn’t surprising at all, maintaining in mind that ladies from this country are pretty widespread among American males.
Family reunification is one other widespread reason for Ukrainian women to move to the USA, as they seek to hitch their liked ones who have already established roots within the nation. It is important to notice that whereas these are frequent elements, each girl is exclusive, and their preferences can differ, however you may get the point! Younger generations of Americans want to have housewives, and Ukrainian women are good for that. We perceive the intricacies of area of interest relationship and have embarked charmdate on the quest to assist you find your excellent Ukrainian match, without the usual problem and guesswork. This is where the magic of niche relationship apps comes into play. In in the present day’s digital age, courting apps have grow to be the go-to technique for locating love, friendship, and every little thing in between. Within the huge sea of courting apps, discovering the one that caters to your specific taste and preferences can feel like trying to find a needle in a haystack. 2. Social Media Platforms: Social media platforms like Facebook, Instagram, and Twitter can be nice locations to attach with Ukrainian women dwelling in the USA.
You will have a loving and caring accomplice and a terrific listener who is attentive to your wants and can help you no matter what occurs. This stage of help contributes to a optimistic person experience and enhances the positioning’s reputation. Positive testimonials from glad customers contribute to the site’s good fame. This web site has been round since 1998, which is a good result for a courting service, it has a superb reputation, and there are lots of “treats†(bonuses) for each new and present customers on CharmDate. Bear in mind that there’s a special supply for brand new customers – you can buy 20 credit for $2.99 as a substitute of $9.99 after registration. Nevertheless, you still have to all the time compliment your woman and please her with pretty little things to make her feel special. Buying her flowers on particular days like birthdays, Women’s Day and New Year’s is a should, and they will go as far as to make a giant deal out of it should you don’t. Hilary Silver interviewed many cross-tradition couples to seek out out the secrets of successful international relationships. In the end, it turns out that throughout the interval of “saturation†he feels the need to take and the whole lot shouldn’t be sufficient for him.
After that, you will need to look forward to the site’s administration to overview your profile – this may take just a few hours, and that’s one thing that may spoil the experience straight away. The registration process is kind of time-consuming right here, but that’s most likely the only drawback with CharmDate. If you’re considering dating Ukrainian singles, you could approach the process thoughtfully and respectfully. One major crimson flag is that if the woman you’re speaking with refuses to maneuver the conversation off the courting site, even after months of interaction. If you’re all for Ukrainian ladies dating, listed below are some dos and don’ts to information you thru your journey. Listen and help. If you are all about courting in Ukraine, you will need to be taught to take heed to your partner. 5. Volunteer Organizations: Getting concerned in volunteer organizations that help the Ukrainian neighborhood or humanitarian causes associated to Ukraine could be a meaningful means to meet single Ukrainian ladies who’re captivated with giving back to their neighborhood. Gone are the times when likelihood encounters at social events were the primary way to satisfy potential partners. 4. Language Classes and Cultural Workshops: Enrolling in Ukrainian language lessons or cultural workshops can be a enjoyable and interesting way to satisfy single Ukrainian ladies who share your curiosity in Ukrainian culture and heritage.
gunnarpeipman.com
gunnarpeipman.com
I’d like to find out more? I’d like to find out some additional information.
gunnarpeipman.com
gunnarpeipman.com