Editing Admin Pages - Revision history

Luke at 15:27, 17 November 2022

2022-11-17T15:27:47Z

← Older revision		Revision as of 15:27, 17 November 2022
Line 11:		Line 11:
	Simply put, an admin panel page can use all of them. You can make a page purely out of email group components if you wanted. This is because the underlying HTML generator for /en-admin/* pages specifically adds a js script tag for all 3 groups; if you view source on an en-admin page, you'll see the 3 main.js links there.		Simply put, an admin panel page can use all of them. You can make a page purely out of email group components if you wanted. This is because the underlying HTML generator for /en-admin/* pages specifically adds a js script tag for all 3 groups; if you view source on an en-admin page, you'll see the 3 main.js links there.

	= ~~Installing some other page~~ =		= Injecting JSON into the default generated pages =

	You can leave the default [[Installing Admin Pages\|InstallAdminPages]] commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be:		Alternatively you can manipulate the JSON of the default admin panel pages automatically. This is how, for example, the password reset module injects a "generate link" tile onto the user edit page. In order to allow multiple extensions to manipulate the same page (and again the user edit page is likely to be popular for this kind of extension), the API represents the about-to-be-created page with an in memory structure of the JSON which you can manipulate as needed. That manipulation is done by the Events.Page.BeforeAdminPageInstall event.


	~~<syntaxhighlight lang="csharp">~~

	~~// Inside your services constructor, for a service which would like to install pages.~~
	~~// You can either inject PageService and use it, or more typically, use AfterStart:~~

	~~Events.Service.AfterStart.AddEventListener((Context context, object sender) => {~~

	~~// This route is suggested rather than dependency injection~~
	~~// Because some projects (particularly fully headless and micro instances) don't have a page service installed.~~
	~~var pageService = Services.Get<PageService>();~~

	~~pageService.Install(~~
	~~new Page()~~
	{
	~~Url = "/en-admin/custom-page/",~~
	~~Title = "My custom admin panel page",~~
	~~BodyJson = @"{~~
	~~""t"": ""Admin/Layouts/Default"",~~
	~~""c"": ""Hello world! This is the content of a new admin panel page. Use Admin/Tile to get one or more tiles in your layout.""~~
	}"
	~~});~~

	~~return new ValueTask<object>(sender);~~
	~~});~~


	~~</syntaxhighlight>~~

	~~= Injecting JSON into the default page =~~

	Alternatively you can manipulate the JSON of the default admin panel pages. This is how, for example, the password reset module injects a "generate link" tile onto the user edit page. In order to allow multiple extensions to manipulate the same page (and again the user edit page is likely to be popular for this kind of extension), the API represents the about-to-be-created page with an in memory structure of the JSON which you can manipulate as needed. That manipulation is done by the Events.Page.BeforeAdminPageInstall event.

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">

Luke at 15:24, 17 November 2022

2022-11-17T15:24:59Z

← Older revision		Revision as of 15:24, 17 November 2022
Line 1:		Line 1:
	The administration panel in SocialStack is just a set of pages as well meaning they are editable in [[Editing pages\|the same way as your frontend]]. These pages are primarily automatically generated by the modules in your project through the [[Installing Admin Pages\|InstallAdminPages]] call which is provided by default and commented out in the *Service.cs file by the [[Generate\|generate command]]. However, there are occasionally times when you're creating a reusable module where you would like your module to manipulate the administration panel page automatically, such as extend it or entirely replace it with something custom. There are a few ways you can do this.		The administration panel in SocialStack is just a set of pages as well meaning they are editable in [[Editing pages\|the same way as your frontend]] and you can create them directly as well. The only thing required of an admin panel page is its URL starts with /en-admin/. These pages are primarily automatically generated by the modules in your project through the [[Installing Admin Pages\|InstallAdminPages]] call which is provided by default and commented out in the *Service.cs file by the [[Generate\|generate command]]. However, there are occasionally times when you're creating a reusable module where you would like your module to manipulate the administration panel page automatically, such as extend it or entirely replace it with something custom. There are a few ways you can do this.

			= Components an admin panel page can use =

			To avoid bloating the frontend of a site with components that only admins will use, SocialStack splits components in to 3 groups:

			* Email: email only components.
			* UI: frontend only components.
			* Admin: admin only components.

			Simply put, an admin panel page can use all of them. You can make a page purely out of email group components if you wanted. This is because the underlying HTML generator for /en-admin/* pages specifically adds a js script tag for all 3 groups; if you view source on an en-admin page, you'll see the 3 main.js links there.

	= Installing some other page =		= Installing some other page =

Luke at 15:19, 17 November 2022

2022-11-17T15:19:52Z

← Older revision		Revision as of 15:19, 17 November 2022
Line 1:		Line 1:
	The administration panel in SocialStack is just a set of pages as well meaning they are editable in [[Editing pages\|the same way as your frontend]]. These pages are automatically generated by the modules in your project through the InstallAdminPages call which is provided by default and commented out in the *Service.cs file by the [[Generate\|generate command]]. However, there are occasionally times when you're creating a reusable module where you would like your module to manipulate the administration panel page automatically, such as extend it or entirely replace it with something custom. There are a few ways you can do this.		The administration panel in SocialStack is just a set of pages as well meaning they are editable in [[Editing pages\|the same way as your frontend]]. These pages are primarily automatically generated by the modules in your project through the [[Installing Admin Pages\|InstallAdminPages]] call which is provided by default and commented out in the *Service.cs file by the [[Generate\|generate command]]. However, there are occasionally times when you're creating a reusable module where you would like your module to manipulate the administration panel page automatically, such as extend it or entirely replace it with something custom. There are a few ways you can do this.

	= Installing some other page =		= Installing some other page =

Luke: /* Installing some other page */

2022-11-17T14:58:04Z

Installing some other page

← Older revision		Revision as of 14:58, 17 November 2022
Line 3:		Line 3:
	= Installing some other page =		= Installing some other page =

	You can leave the default InstallAdminPages commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be:		You can leave the default [[Installing Admin Pages\|InstallAdminPages]] commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be:

Luke: /* Installing some other page */

2022-09-02T12:35:42Z

Installing some other page

← Older revision		Revision as of 12:35, 2 September 2022
Line 24:		Line 24:
	BodyJson = @"{		BodyJson = @"{
	""t"": ""Admin/Layouts/Default"",		""t"": ""Admin/Layouts/Default"",
	""c"": ""Hello world! This is the content of a new admin panel page.""		""c"": ""Hello world! This is the content of a new admin panel page. Use Admin/Tile to get one or more tiles in your layout.""
	}"		}"
	});		});

Luke: /* Installing some other page */

2022-09-02T12:27:43Z

Installing some other page

← Older revision		Revision as of 12:27, 2 September 2022
Line 24:		Line 24:
	BodyJson = @"{		BodyJson = @"{
	""t"": ""Admin/Layouts/Default"",		""t"": ""Admin/Layouts/Default"",
	""c"": ""Hello world! This is the content of a new admin panel page."		""c"": ""Hello world! This is the content of a new admin panel page.""
	}"		}"
	});		});

Luke: /* Installing some other page */

2022-09-02T12:26:50Z

Installing some other page

← Older revision		Revision as of 12:26, 2 September 2022
Line 13:		Line 13:
	Events.Service.AfterStart.AddEventListener((Context context, object sender) => {		Events.Service.AfterStart.AddEventListener((Context context, object sender) => {

			// This route is suggested rather than dependency injection
			// Because some projects (particularly fully headless and micro instances) don't have a page service installed.
	var pageService = Services.Get<PageService>();		var pageService = Services.Get<PageService>();

Luke: /* Installing some other page */

2022-09-02T12:26:13Z

Installing some other page

← Older revision		Revision as of 12:26, 2 September 2022
Line 6:		Line 6:


	<syntaxhighlight lang="cs">		<syntaxhighlight lang="csharp">

	// Inside your services constructor, for a service which would like to install pages.		// Inside your services constructor, for a service which would like to install pages.

Luke: /* Installing some other page */

2022-09-02T12:26:05Z

Installing some other page

← Older revision		Revision as of 12:26, 2 September 2022
Line 3:		Line 3:
	= Installing some other page =		= Installing some other page =

	You can leave the default InstallAdminPages commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be.		You can leave the default InstallAdminPages commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be:


			<syntaxhighlight lang="cs">

			// Inside your services constructor, for a service which would like to install pages.
			// You can either inject PageService and use it, or more typically, use AfterStart:

			Events.Service.AfterStart.AddEventListener((Context context, object sender) => {

			var pageService = Services.Get<PageService>();

			pageService.Install(
			new Page()
			{
			Url = "/en-admin/custom-page/",
			Title = "My custom admin panel page",
			BodyJson = @"{
			""t"": ""Admin/Layouts/Default"",
			""c"": ""Hello world! This is the content of a new admin panel page."
			}"
			});

			return new ValueTask<object>(sender);
			});


			</syntaxhighlight>

	= Injecting JSON into the default page =		= Injecting JSON into the default page =

Luke at 00:26, 11 August 2022

2022-08-11T00:26:41Z

← Older revision		Revision as of 00:26, 11 August 2022
Line 1:		Line 1:
	The administration panel in SocialStack is just a set of pages as well meaning they are editable in [[Editing pages\|the same way as your frontend]]. These pages are automatically generated by the modules in your project through the InstallAdminPages call which is provided by default and commented out in the *Service.cs file by the [[Generate\|generate command]]. However, there are occasionally times when you're creating a reusable module where you would like your module to manipulate the administration panel page automatically, such as extend it or entirely replace it with something custom. There are a few ways you can do this.		The administration panel in SocialStack is just a set of pages as well meaning they are editable in [[Editing pages\|the same way as your frontend]]. These pages are automatically generated by the modules in your project through the InstallAdminPages call which is provided by default and commented out in the *Service.cs file by the [[Generate\|generate command]]. However, there are occasionally times when you're creating a reusable module where you would like your module to manipulate the administration panel page automatically, such as extend it or entirely replace it with something custom. There are a few ways you can do this.

	# Installing some other page		= Installing some other page =

	You can leave the default InstallAdminPages commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be.		You can leave the default InstallAdminPages commented out and instead create pages directly. This is done via calling Install on the PageService, typically in the Events.Service.AfterStart event handler. For the page to be treated as part of the admin panel, all it needs is a URL that starts with /en-admin/ - aside from that its content is whatever you need it to be.

	# Injecting JSON into the default page		= Injecting JSON into the default page =

	Alternatively you can manipulate the JSON of the default admin panel pages. This is how, for example, the password reset module injects a "generate link" tile onto the user edit page. In order to allow multiple extensions to manipulate the same page (and again the user edit page is likely to be popular for this kind of extension), the API represents the about-to-be-created page with an in memory structure of the JSON which you can manipulate as needed. That manipulation is done by the Events.Page.BeforeAdminPageInstall event.		Alternatively you can manipulate the JSON of the default admin panel pages. This is how, for example, the password reset module injects a "generate link" tile onto the user edit page. In order to allow multiple extensions to manipulate the same page (and again the user edit page is likely to be popular for this kind of extension), the API represents the about-to-be-created page with an in memory structure of the JSON which you can manipulate as needed. That manipulation is done by the Events.Page.BeforeAdminPageInstall event.