Extract selectedChild tabheader functionality and enable for Manage Events #12747
Conversation
|
(Standard links)
|
|
jenkins, test this please |
034c5d6 to
8d536fa
Compare
templates/CRM/common/TabSelected.tpl
Outdated
| {if $selectedChild}selectedTab = '{$selectedChild}';{/if} | ||
| {literal} | ||
| CRM.$(function($) { | ||
| var tabIndex = $('#tab_' + selectedTab).prevAll().length |
There was a problem hiding this comment.
I think there should be a semicolon at the end of this line -for style even if it works without
| CRM.$(function($) { | ||
| var tabIndex = $('#tab_' + selectedTab).prevAll().length; | ||
| $("#mainTabContainer").tabs({active: tabIndex}); | ||
| $(".crm-tab-button").addClass("ui-corner-bottom"); |
There was a problem hiding this comment.
This class addition is lost in this change (intentionally or otherwise) - however, I think the selectedChild doesn't actually work on extensions with or without this patch -it does with this
diff --git a/CRM/Admin/Page/Extensions.php b/CRM/Admin/Page/Extensions.php
index a2d5e9cbad..eb556d4afb 100644
--- a/CRM/Admin/Page/Extensions.php
+++ b/CRM/Admin/Page/Extensions.php
@@ -56,6 +56,7 @@ class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic {
$destination = urlencode($destination);
$this->assign('destination', $destination);
- $this->assign('selectedChild', CRM_Utils_Request::retrieve('selectedChild', 'Alphanumeric', $this));
}
There was a problem hiding this comment.
class loss also affects ContributionPage
|
Testing notes (still wip) Tested urls work (before & after) doesn't work (before & after) @mattwire what do you think about putting this line $this->assign('selectedChild', CRM_Utils_Request::retrieve('selectedChild', 'Alphanumeric', $this)); into CRM_Core_Basic_Page::run() it feels like a common enough & cheap enough thing it might make sense |
| {* Tab management *} | ||
| <script type="text/javascript"> | ||
| var selectedTab = 'contributions'; | ||
| {include file="CRM/common/TabSelected.tpl" defaultTab="contributions" tabContainer="#secondaryTabContainer"} |
There was a problem hiding this comment.
I couldn't figure out how to select the recurring subtab (before or after this change)
There was a problem hiding this comment.
@eileenmcnaughton No, you can't :-( But maybe once this abstraction is in place we might be able to look at it
8d536fa to
c1bd837
Compare
|
Ok, I've addressed comments, extensions is now working. MessageTemplates uses CRM_Core_Page instead of CRM_Core_Page_Basic so I've not abstracted out the assigns there as I nearly fell into the rabbit hole again. |
|
thanks @mattwire - good to merge |
|
Test fails unrelated, merging as per the tag |
| @@ -107,3 +107,4 @@ CRM.$(function($) { | |||
| </script> | |||
| {/literal} | |||
| {include file="CRM/Event/Form/ManageEvent/ConfirmRepeatMode.tpl" entityID=$id entityTable="civicrm_event"} | |||
| {include file="CRM/common/TabSelected.tpl" defaultTab="settings"} | |||
There was a problem hiding this comment.
@mattwire @eileenmcnaughton Currently this line breaks the manage event URLs if selectedChild is not appended to it. Eg
https://dmaster.demo.civicrm.org/civicrm/event/manage/fee?reset=1&action=update&id=3 goes to the settings page instead of opening the fee tab. Similarly all the configuration links from the manage event page goes to the settings page.
Maybe, we should just
- remove this line from the file or
- append selectedChild to the links in Manage Event Page. But we already specify the tab name in the link before the query string eg
civicrm/event/manage/fee?reset=1. - Format the links to look like
civicrm/event/manage?..selectedChild=fee(might need xml/upgrade changes along with fixing the links in core).
There was a problem hiding this comment.
@mattwire @jitendrapurohit maybe we should assign defaultTab from php?
@mattwire I think this needs to be fixed in the rc
There was a problem hiding this comment.
Ok. So before this PR the selectedChild stuff didn't work for events at all. Events is the only one that specifies the tab as part of the link.
- remove this line from the file
Specifying the "defaultTab" is standard across all usages of the tab selector code and is meant to be a fallback default if selectedChild is not defined.
- append selectedChild to the links in Manage Event Page. But we already specify the tab name in the link before the query string eg civicrm/event/manage/fee?reset=1.
This is probably the easiest / safest way to resolve this, unless we assign defaultTab from PHP in 1.
- Format the links to look like civicrm/event/manage?..selectedChild=fee (might need xml/upgrade changes along with fixing the links in core).
This would be more standard and is what we should probably aspire to for consistency, but is also much more likely to cause breakage.
|
@jitendrapurohit @eileenmcnaughton Please see Links to manage event tabs broken following work on "selected tab" functionality. |
|
I think the work in this PR arose from an unfortunate lack of communication. Back in 2013 I worked to get the "default tab" functionality out of the See https://lab.civicrm.org/dev/core/-/issues/2215#note_50975 |
Overview
Some pages with tabs in CiviCRM allow you to link directly to a specific tab using the URL parameter
&selectedChild=tabname(eg. for the contact summary to link directly to the contributions tabtabname="contribute"This is currently supported for:
... But the code is duplicated in each template.
This PR extracts the duplicate code to a common shared template and adds support to the event page tabs.
Before
After
selectedChildin event tabs.Technical Details
For the events tab we have to retrieve the
selectedChildparameter. Other than that this is just template extraction.Comments