Skip to content

Conversation

@Faraz32123
Copy link
Contributor

@Faraz32123 Faraz32123 commented Apr 11, 2025

use PluginSlot to add your site logo to studio footer.

@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch 2 times, most recently from 8320ecd to 83e0ab3 Compare April 11, 2025 06:11
@codecov
Copy link

codecov bot commented Apr 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.52%. Comparing base (655d6c0) to head (2c8cf2d).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #520      +/-   ##
==========================================
+ Coverage   91.22%   91.52%   +0.29%     
==========================================
  Files           5        6       +1     
  Lines          57       59       +2     
  Branches       19       19              
==========================================
+ Hits           52       54       +2     
  Misses          5        5              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current strategy for making the frontend more customizable is by using frontend-plugin-framework PluginSlots as opposed to adding new configuration variables (see https://discuss.openedx.org/t/plugin-slots-vs-configuration/13009)

As of openedx/frontend-app-authoring#1729, it is possible for site operators to replace the entire StudioFooter by utilizing the StudioFooterSlot - if that satisfies your use case then this PR can just be closed.

If you'd like a more granular approach (just replacing the "Powered by Open edX" logo/link), then updating this PR to wrap it in a new PluginSlot is another option.

@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch from 83e0ab3 to 9186c72 Compare April 15, 2025 08:56
@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch from 92910c3 to 01f1605 Compare April 15, 2025 09:33
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this to use a PluginSlot!

I left a comment about following the pattern we use in other places for plugin slots, if you could update this to do that it would be wonderful.

Thanks!

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for being so patient with my reviews!

I left a couple more comments with some change requests, but this is looking super close to ready to go!

@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch from 5229274 to cb64ed4 Compare April 16, 2025 05:38
@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch from cb64ed4 to 2d53df1 Compare April 16, 2025 05:42
@Faraz32123 Faraz32123 changed the title feat: use studio footer logo variables feat: use PluginSlot to add your site logo to studio footer Apr 16, 2025
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nearly perfect now!

Just one small naming thing and this will be ready to land!

@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch from 2d53df1 to 4e6da2e Compare April 17, 2025 05:32
Muhammad Faraz Maqsood added 3 commits April 17, 2025 10:34
use PluginSlot for customizing studio footer logo and it's redirect
move @openedx/frontend-plugin-framework from devDependencies to dependencies in package.json. This fixes this: https://github.com/openedx/frontend-component-footer/actions/runs/14465403436/job/40566531587?pr=520
add instructions for the new pluginslot studio_footer_logo_slot.
@Faraz32123 Faraz32123 force-pushed the feat/add_variable_for_studio_logo_and_url branch from 4e6da2e to 2c8cf2d Compare April 17, 2025 05:35
@brian-smith-tcril brian-smith-tcril merged commit a87c111 into openedx:master Apr 17, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants