Skip to content

Commit 04db8f9

Browse files
docs: update frontend plugin slots reference for teak
1 parent fd15920 commit 04db8f9

File tree

1 file changed

+69
-29
lines changed

1 file changed

+69
-29
lines changed

source/site_ops/references/frontend-plugin-slots.rst

Lines changed: 69 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,83 @@ may be available, and are discoverable by visiting the ``src/plugin-slots``
88
directory of any given MFE.
99

1010
Header slots, available in MFEs that use ``frontend-component-header``:
11-
12-
- `course_info_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/CourseInfoSlot#course-info-slot>`_
13-
- `desktop_header_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/DesktopHeaderSlot#desktop-header-slot>`_
14-
- `desktop_logged_out_items_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/DesktopLoggedOutItemsSlot#desktop-logged-out-items-slot>`_
15-
- `desktop_main_menu_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/DesktopMainMenuSlot#desktop-main-menu-slot>`_
16-
- `desktop_secondary_menu_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/DesktopSecondaryMenuSlot#desktop-secondary-menu-slot>`_
17-
- `desktop_user_menu_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/DesktopUserMenuSlot#desktop-user-menu-slot>`_
18-
- `learning_help_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/LearningHelpSlot#learning-help-slot>`_
19-
- `learning_logged_out_items_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/LearningLoggedOutItemsSlot#learning-logged-out-items-slot>`_
20-
- `learning_user_menu_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/LearningUserMenuSlot#learning-user-menu-slot>`_
21-
- `logo_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/LogoSlot#logo-slot>`_
22-
- `mobile_header_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/MobileHeaderSlot#mobile-header-slot>`_
23-
- `mobile_logged_out_items_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/MobileLoggedOutItemsSlot#mobile-logged-out-items-slot>`_
24-
- `mobile_main_menu_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/MobileMainMenuSlot#slot-id-mobile_main_menu_slot>`_
25-
- `mobile_user_menu_slot <https://github.com/openedx/frontend-component-header/tree/v5.7.1/src/plugin-slots/MobileUserMenuSlot#mobile-user-menu-slot>`_
26-
27-
The footer slot, available in MFEs that use ``frontend-slot-footer``:
28-
29-
- `footer_slot <https://github.com/openedx/frontend-slot-footer/tree/v1.0.6?tab=readme-ov-file#frontend-slot-footer>`_
11+
***********************************************************************
12+
13+
- `org.openedx.frontend.layout.header_logo.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/LogoSlot>`_
14+
- `org.openedx.frontend.layout.header_desktop.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/DesktopHeaderSlot>`_
15+
- `org.openedx.frontend.layout.header_desktop_logged_out_items.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/DesktopLoggedOutItemsSlot>`_
16+
- `org.openedx.frontend.layout.header_desktop_main_menu.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/DesktopMainMenuSlot>`_
17+
- `org.openedx.frontend.layout.header_desktop_secondary_menu.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/DesktopSecondaryMenuSlot>`_
18+
- `org.openedx.frontend.layout.header_desktop_user_menu.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/DesktopUserMenuSlot>`_
19+
- `org.openedx.frontend.layout.header_learning_course_info.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/CourseInfoSlot>`_
20+
- `org.openedx.frontend.layout.header_learning_help.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/LearningHelpSlot>`_
21+
- `org.openedx.frontend.layout.header_learning_logged_out_items.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/LearningLoggedOutItemsSlot>`_
22+
- `org.openedx.frontend.layout.header_learning_user_menu.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/LearningUserMenuSlot>`_
23+
- `org.openedx.frontend.layout.header_mobile.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/MobileHeaderSlot>`_
24+
- `org.openedx.frontend.layout.header_mobile_logged_out_items.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/MobileLoggedOutItemsSlot>`_
25+
- `org.openedx.frontend.layout.header_mobile_main_menu.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/MobileMainMenuSlot>`_
26+
- `org.openedx.frontend.layout.header_mobile_user_menu.v1 <https://github.com/openedx/frontend-component-header/tree/v6.4.0/src/plugin-slots/MobileUserMenuSlot>`_
27+
28+
Footer slots, available in MFEs that use ``frontend-component-footer``:
29+
***********************************************************************
30+
31+
- `org.openedx.frontend.layout.footer.v1 <https://github.com/openedx/frontend-component-footer/tree/v14.7.0/src/plugin-slots/FooterSlot>`_
32+
- `org.openedx.frontend.layout.studio_footer.v1 <https://github.com/openedx/frontend-component-footer/tree/v14.7.0/src/plugin-slots/StudioFooterSlot>`_
33+
- `org.openedx.frontend.layout.studio_footer_logo.v1 <https://github.com/openedx/frontend-component-footer/tree/v14.7.0/src/plugin-slots/StudioFooterLogoSlot>`_
3034

3135
A slot only available in the Account MFE:
36+
*****************************************
3237

33-
- `id_verification_page_plugin <https://github.com/openedx/frontend-app-account/tree/open-release/sumac.master/src/plugin-slots/IdVerificationPageSlot#slot-id-id_verification_page_plugin>`_
38+
- `org.openedx.frontend.account.id_verification_page.v1 <https://github.com/openedx/frontend-app-account/tree/release/teak.master/src/plugin-slots/IdVerificationPageSlot>`_
3439

35-
Slots only available in the Learner Dashboard MFE:
40+
Slots only available in the Authoring MFE:
41+
******************************************
3642

37-
- `course_card_action_slot <https://github.com/openedx/frontend-app-learner-dashboard/tree/open-release/sumac.master/src/plugin-slots/CourseCardActionSlot#course-card-action-slot>`_
38-
- `course_list_slot <https://github.com/openedx/frontend-app-learner-dashboard/tree/open-release/sumac.master/src/plugin-slots/CourseListSlot#course-list-slot>`_
39-
- `no_courses_view_slot <https://github.com/openedx/frontend-app-learner-dashboard/tree/open-release/sumac.master/src/plugin-slots/NoCoursesViewSlot#no-courses-view-slot>`_
40-
- `widget_sidebar_slot <https://github.com/openedx/frontend-app-learner-dashboard/tree/open-release/sumac.master/src/plugin-slots/WidgetSidebarSlot#widget-sidebar-slot>`_
43+
- `org.openedx.frontend.authoring.course_outline_header_actions.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/CourseOutlineHeaderActionsSlot>`_
44+
- `org.openedx.frontend.authoring.course_outline_sidebar.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/CourseAuthoringOutlineSidebarSlot>`_
45+
- `org.openedx.frontend.authoring.course_outline_subsection_card_extra_actions.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/CourseOutlineSubsectionCardExtraActionsSlot>`_
46+
- `org.openedx.frontend.authoring.course_outline_unit_card_extra_actions.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/CourseOutlineUnitCardExtraActionsSlot>`_
47+
- `org.openedx.frontend.authoring.course_unit_header_actions.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/CourseUnitHeaderActionsSlot>`_
48+
- `org.openedx.frontend.authoring.course_unit_sidebar.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/CourseAuthoringUnitSidebarSlot>`_
49+
- `org.openedx.frontend.authoring.additional_course_content_plugin.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/AdditionalCourseContentPluginSlot>`_
50+
- `org.openedx.frontend.authoring.additional_course_plugin.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/AdditionalCoursePluginSlot>`_
51+
- `org.openedx.frontend.authoring.video_transcript_additional_translations_component.v1 <https://github.com/openedx/frontend-app-authoring/tree/release/teak.master/src/plugin-slots/AdditionalTranslationsComponentSlot>`_
4152

42-
Slots only available in the Learning MFE:
53+
Slots only available in the Learner Dashboard MFE:
54+
**************************************************
4355

44-
- `header_slot <https://github.com/openedx/frontend-app-learning/tree/open-release/sumac.master/src/plugin-slots/HeaderSlot#header-slot>`_
45-
- `sequence_container_slot <https://github.com/openedx/frontend-app-learning/tree/open-release/sumac.master/src/plugin-slots/SequenceContainerSlot#sequence-container-slot>`_
46-
- `unit_title_slot <https://github.com/openedx/frontend-app-learning/tree/open-release/sumac.master/src/plugin-slots/UnitTitleSlot#slot-id-unit_title_slot>`_
56+
- `org.openedx.frontend.learner_dashboard.course_card_action.v1 <https://github.com/openedx/frontend-app-learner-dashboard/tree/release/teak.master/src/plugin-slots/CourseCardActionSlot>`_
57+
- `org.openedx.frontend.learner_dashboard.widget_sidebar.v1 <https://github.com/openedx/frontend-app-learner-dashboard/tree/release/teak.master/src/plugin-slots/WidgetSidebarSlot>`_
58+
- `org.openedx.frontend.learner_dashboard.course_list.v1 <https://github.com/openedx/frontend-app-learner-dashboard/tree/release/teak.master/src/plugin-slots/CourseListSlot>`_
59+
- `org.openedx.frontend.learner_dashboard.no_courses_view.v1 <https://github.com/openedx/frontend-app-learner-dashboard/tree/release/teak.master/src/plugin-slots/NoCoursesViewSlot>`_
60+
- `org.openedx.frontend.learner_dashboard.dashboard_modal.v1 <https://github.com/openedx/frontend-app-learner-dashboard/tree/release/teak.master/src/plugin-slots/DashboardModalSlot>`_
4761

62+
Slots only available in the Learning MFE:
63+
*****************************************
64+
65+
- `org.openedx.frontend.layout.header_learning.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/HeaderSlot>`_
66+
- `org.openedx.frontend.learning.content_iframe_loader.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ContentIFrameLoaderSlot>`_
67+
- `org.openedx.frontend.learning.course_breadcrumbs.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseBreadcrumbsSlot>`_
68+
- `org.openedx.frontend.learning.course_home_section_outline.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseHomeSectionOutlineSlot>`_
69+
- `org.openedx.frontend.learning.course_outline_mobile_sidebar_trigger.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseOutlineMobileSidebarTriggerSlot>`_
70+
- `org.openedx.frontend.learning.course_outline_sidebar_trigger.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseOutlineSidebarTriggerSlot>`_
71+
- `org.openedx.frontend.learning.course_outline_sidebar.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseOutlineSidebarSlot>`_
72+
- `org.openedx.frontend.learning.course_outline_tab_notifications.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseOutlineTabNotificationsSlot>`_
73+
- `org.openedx.frontend.learning.course_recommendations.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/CourseRecommendationsSlot>`_
74+
- `org.openedx.frontend.learning.gated_unit_content_message.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/GatedUnitContentMessageSlot>`_
75+
- `org.openedx.frontend.learning.next_unit_top_nav_trigger.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/NextUnitTopNavTriggerSlot>`_
76+
- `org.openedx.frontend.learning.notification_tray.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/NotificationTraySlot>`_
77+
- `org.openedx.frontend.learning.notification_widget.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/NotificationWidgetSlot>`_
78+
- `org.openedx.frontend.learning.notifications_discussions_sidebar_trigger.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/NotificationsDiscussionsSidebarTriggerSlot>`_
79+
- `org.openedx.frontend.learning.notifications_discussions_sidebar.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/NotificationsDiscussionsSidebarSlot>`_
80+
- `org.openedx.frontend.learning.progress_certificate_status.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ProgressCertificateStatusSlot>`_
81+
- `org.openedx.frontend.learning.progress_tab_certificate_status_main_body.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ProgressTabCertificateStatusMainBodySlot>`_
82+
- `org.openedx.frontend.learning.progress_tab_certificate_status_side_panel.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ProgressTabCertificateStatusSidePanelSlot>`_
83+
- `org.openedx.frontend.learning.progress_tab_course_grade.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ProgressTabCourseGradeSlot>`_
84+
- `org.openedx.frontend.learning.progress_tab_grade_breakdown.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ProgressTabGradeBreakdownSlot>`_
85+
- `org.openedx.frontend.learning.progress_tab_related_links.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/ProgressTabRelatedLinksSlot>`_
86+
- `org.openedx.frontend.learning.sequence_container.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/SequenceContainerSlot>`_
87+
- `org.openedx.frontend.learning.unit_title.v1 <https://github.com/openedx/frontend-app-learning/tree/release/teak.master/src/plugin-slots/UnitTitleSlot>`_
4888

4989
.. seealso::
5090

0 commit comments

Comments
 (0)