Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Ability to easily extend admin dashboard by injecting custom partials… (#12599)
Damian Legawiece856fec2ad26
diff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rbindex 6c3788f889..811d041120 100644--- a/admin/app/helpers/spree/admin/base_helper.rb+++ b/admin/app/helpers/spree/admin/base_helper.rb@@ -3,6 +3,12 @@ module Spreemodule BaseHelperinclude Spree::ImagesHelper+ def render_admin_partials(section, options = {})+ Rails.application.config.spree_admin.send(section).map do |partial|+ render partial, options+ end.join.html_safe+ end+def enterprise_edition?defined?(Vendo)end@@ -16,12 +22,12 @@ module Spreeenddef settings_active?- %w[stores zones shipping_methods oauth_applications- payment_methods refund_reasons reimbursement_types- shipping_categories store_credit_categories- syncs tax_categories tax_rates webhooks accounts- custom_domains audits exports imports return_authorization_reasons- documents stripe_tax_registrations members subscriptions stock_locations webhooks_subscribers].include?(controller_name)+ @settings_active || %w[stores zones shipping_methods oauth_applications+ payment_methods refund_reasons reimbursement_types+ shipping_categories store_credit_categories+ syncs tax_categories tax_rates webhooks accounts+ custom_domains audits exports imports return_authorization_reasons+ documents stripe_tax_registrations members subscriptions stock_locations webhooks_subscribers].include?(controller_name)enddef available_countries_isodiff --git a/admin/app/views/layouts/spree/admin.html.erb b/admin/app/views/layouts/spree/admin.html.erbindex b2e6481967..c843fbe42a 100644--- a/admin/app/views/layouts/spree/admin.html.erb+++ b/admin/app/views/layouts/spree/admin.html.erb@@ -6,6 +6,8 @@</head><body class="admin min-vh-100 <%= controller_name %> <%= action_name %>">+ <%= render_admin_partials(:body_start_partials) %>+<%= render "spree/admin/shared/header" %><%= render "spree/admin/shared/sidebar" %><main id="content">@@ -17,5 +19,7 @@</main><%= render "spree/admin/shared/modal" %><%= render "spree/admin/shared/alerts" %>++ <%= render_admin_partials(:body_end_partials) %></body></html>diff --git a/admin/app/views/spree/admin/dashboard/_sidebar.html.erb b/admin/app/views/spree/admin/dashboard/_sidebar.html.erbnew file mode 100644index 0000000000..b296ef1f2b--- /dev/null+++ b/admin/app/views/spree/admin/dashboard/_sidebar.html.erb@@ -0,0 +1,2 @@+<%= render 'updater' %>+<%= render 'store_preview' %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/dashboard/analytics.html.erb b/admin/app/views/spree/admin/dashboard/analytics.html.erbindex f799d9d626..4942a645b0 100644--- a/admin/app/views/spree/admin/dashboard/analytics.html.erb+++ b/admin/app/views/spree/admin/dashboard/analytics.html.erb@@ -115,4 +115,6 @@<%= render 'top_products' if @top_products %><%= render 'visits' if @visits %>++ <%= render_admin_partials(:dashboard_analytics_partials) %><% end %>diff --git a/admin/app/views/spree/admin/dashboard/show.html.erb b/admin/app/views/spree/admin/dashboard/show.html.erbindex 685128f82d..7f89125e8c 100644--- a/admin/app/views/spree/admin/dashboard/show.html.erb+++ b/admin/app/views/spree/admin/dashboard/show.html.erb@@ -23,11 +23,7 @@<%= render 'analytics' %></div><div class="col-lg-4">- <% if defined?(current_vendor) && current_vendor %>- <%= render 'spree/admin/shared/vendor_faq' %>- <% else %>- <%= render 'updater' %>- <%= render 'store_preview' %>- <%= render 'vendors' if defined?(Spree::Vendor) %>- <% end %>+ <%= render 'sidebar' %>+ <%= render_admin_partials(:dashboard_sidebar_partials) %>+ </div></div>diff --git a/admin/app/views/spree/admin/orders/_extra_filters.html.erb b/admin/app/views/spree/admin/orders/_extra_filters.html.erbdeleted file mode 100644index e69de29bb2..0000000000diff --git a/admin/app/views/spree/admin/orders/_filters.html.erb b/admin/app/views/spree/admin/orders/_filters.html.erbindex 3e9db98077..e93e704697 100644--- a/admin/app/views/spree/admin/orders/_filters.html.erb+++ b/admin/app/views/spree/admin/orders/_filters.html.erb@@ -89,7 +89,7 @@</div></div>- <%= render "spree/admin/orders/extra_filters", f: f %>+ <%= render_admin_partials(:orders_filters_partials, f: f) %></div><div class="form-actions">diff --git a/admin/app/views/spree/admin/orders/_header.html.erb b/admin/app/views/spree/admin/orders/_header.html.erbindex 41a7183b83..9dccc1c50f 100644--- a/admin/app/views/spree/admin/orders/_header.html.erb+++ b/admin/app/views/spree/admin/orders/_header.html.erb@@ -63,6 +63,8 @@<% end %><% end %>+ <%= render_admin_partials(:order_page_dropdown_partials, order: @order) %>+<% if can?(:cancel, @order) %><div class="dropdown-divider"></div><%= link_to spree.cancel_admin_order_path(@order),diff --git a/admin/app/views/spree/admin/orders/_summary.html.erb b/admin/app/views/spree/admin/orders/_summary.html.erbindex 608087b863..1bf8cdec67 100644--- a/admin/app/views/spree/admin/orders/_summary.html.erb+++ b/admin/app/views/spree/admin/orders/_summary.html.erb@@ -74,7 +74,7 @@<%= render 'tax_lines', tax_lines: tax_lines, id: 'tax-lines-additional' %></li>- <%= render 'summary_custom', order: @order %>+ <%= render_admin_partials(:order_page_body_partials, order: @order) %><li class="list-group-item d-flex justify-content-between align-items-center border-0"><span data-hook='admin_order_tab_total_title'><%= Spree.t(:total) %></span>diff --git a/admin/app/views/spree/admin/orders/edit.html.erb b/admin/app/views/spree/admin/orders/edit.html.erbindex 33becd1ef8..5a70f40692 100644--- a/admin/app/views/spree/admin/orders/edit.html.erb+++ b/admin/app/views/spree/admin/orders/edit.html.erb@@ -1,23 +1,21 @@<%= render 'header' %>-<%= render 'header_custom' %>+<%= render_admin_partials(:order_page_header_partials, order: @order) %><div class="container px-0"><div class="row"><div class="col-lg-8">-<%= render 'line_items' %><%= render 'shipments' %><%= render 'customer_returns' %><%= render 'return_authorizations' %><%= render 'payments'%><%= render 'refunds'%>-- <%= render 'body_custom' %>+ <%= render_admin_partials(:order_page_body_partials, order: @order) %><%= render 'summary' %></div><div class="col-lg-4">- <!-- TODO: add notes --><%= render 'customer' %>+ <%= render_admin_partials(:order_page_sidebar_partials, order: @order) %></div></div></div>diff --git a/admin/app/views/spree/admin/products/_filters.html.erb b/admin/app/views/spree/admin/products/_filters.html.erbindex 664dc7fd5c..536ca41e3a 100644--- a/admin/app/views/spree/admin/products/_filters.html.erb+++ b/admin/app/views/spree/admin/products/_filters.html.erb@@ -43,7 +43,7 @@} %></div></div>- <%= render partial: "spree/admin/products/form/extra_filters", locals: { f: f } %>+ <%= render_admin_partials(:products_filters_partials, f: f) %></div><div class="form-actions">diff --git a/admin/app/views/spree/admin/products/_form.html.erb b/admin/app/views/spree/admin/products/_form.html.erbindex 7567fc3e5c..4028df1fa8 100644--- a/admin/app/views/spree/admin/products/_form.html.erb+++ b/admin/app/views/spree/admin/products/_form.html.erb@@ -9,13 +9,13 @@<%= render 'spree/admin/products/form/inventory', f: f unless @product.has_variants? %><%= render 'spree/admin/products/form/shipping', f: f %><%= render 'spree/admin/products/form/properties', f: f %>- <%= render 'spree/admin/products/form/extra_form', f: f %>+ <%= render_admin_partials(:product_form_partials, f: f, product: @product) %></div><div class="col-md-4"><%= render 'spree/admin/products/form/status', f: f %><%= render 'spree/admin/products/form/categorization', f: f %>- <%= render 'spree/admin/products/form/stores', f: f if Spree::Store.accessible_by(current_ability).count > 1 %>- <%= render 'spree/admin/products/form/extra_form_sidebar', f: f %>+ <%= render 'spree/admin/products/form/stores', f: f if available_stores.count > 1 %>+ <%= render_admin_partials(:product_form_sidebar_partials, f: f, product: @product) %><%= render 'spree/admin/shared/seo',f: f,diff --git a/admin/app/views/spree/admin/products/edit.html.erb b/admin/app/views/spree/admin/products/edit.html.erbindex cd4ea63e4f..edad86f583 100644--- a/admin/app/views/spree/admin/products/edit.html.erb+++ b/admin/app/views/spree/admin/products/edit.html.erb@@ -6,6 +6,9 @@spree.admin_product_digital_assets_path(@product),class: "dropdown-item",) if can?(:manage, Spree::Digital) %>++ <%= render_admin_partials(:product_dropdown_partials, product: @product) %>+<div class="dropdown-divider"></div><%= external_page_preview_link(@product) %>diff --git a/admin/app/views/spree/admin/products/form/_extra_filters.html.erb b/admin/app/views/spree/admin/products/form/_extra_filters.html.erbdeleted file mode 100644index e69de29bb2..0000000000diff --git a/admin/app/views/spree/admin/products/form/_extra_form.html.erb b/admin/app/views/spree/admin/products/form/_extra_form.html.erbdeleted file mode 100644index e69de29bb2..0000000000diff --git a/admin/app/views/spree/admin/products/form/_extra_form_sidebar.erb b/admin/app/views/spree/admin/products/form/_extra_form_sidebar.erbdeleted file mode 100644index e69de29bb2..0000000000diff --git a/admin/app/views/spree/admin/shared/_head.html.erb b/admin/app/views/spree/admin/shared/_head.html.erbindex c460b67c52..601cd81343 100644--- a/admin/app/views/spree/admin/shared/_head.html.erb+++ b/admin/app/views/spree/admin/shared/_head.html.erb@@ -49,4 +49,6 @@</style><% end %>-<%= render 'spree/shared/google_places_api_loader' %>\ No newline at end of file+<%= render 'spree/shared/google_places_api_loader' %>++<%= render_admin_partials(:head_partials) %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/shared/sidebar/_orders_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_orders_nav.html.erbindex 418e0c57a8..fdb0817ac2 100644--- a/admin/app/views/spree/admin/shared/sidebar/_orders_nav.html.erb+++ b/admin/app/views/spree/admin/shared/sidebar/_orders_nav.html.erb@@ -18,6 +18,8 @@<% if can?(:manage, :checkouts) %><%= nav_item(Spree.t(:draft_orders), spree.admin_checkouts_path, active: params[:controller] == 'checkouts') %><% end %>++ <%= render_admin_partials(:store_orders_nav_partials) %></ul><% end %><% end %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erbindex 1573e1c7ee..6c5ce0ba74 100644--- a/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb+++ b/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb@@ -16,9 +16,7 @@<%= nav_item(Spree.t(:properties), spree.admin_properties_path) %><% end %>- <% if defined?(Spree::ExternalCategory) && can?(:manage, Spree::ExternalCategory) %>- <%= nav_item('Category mapper', spree.admin_external_categories_path) %>- <% end %>+ <%= render_admin_partials(:store_products_nav_partials) %></ul><% end %><% end %>diff --git a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erbindex caa26c155b..f8edf74d43 100644--- a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb+++ b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb@@ -65,6 +65,8 @@<% if can?(:manage, Spree::OauthApplication) %><%= nav_item(Spree.t(:developers), spree.admin_oauth_applications_path, icon: 'terminal', active: %w[oauth_applications webhooks_subscribers].include?(controller_name)) %><% end %>++ <%= render_admin_partials(:store_settings_nav_partials) %></ul><% else %><%= render 'spree/admin/shared/sidebar/store_dropdown' %>@@ -129,6 +131,8 @@<%= render 'spree/admin/shared/sidebar/custom_nav' %>+ <%= render_admin_partials(:store_nav_partials) %>+<li class="nav-item border-top border-top-dashed my-1"></li><%= render 'spree/admin/shared/sidebar/storefront_nav' %><%= render 'spree/admin/shared/sidebar/integrations_nav' %>diff --git a/admin/app/views/spree/admin/stores/form/_basic.html.erb b/admin/app/views/spree/admin/stores/form/_basic.html.erbindex fb9131746d..afc94e0b61 100644--- a/admin/app/views/spree/admin/stores/form/_basic.html.erb+++ b/admin/app/views/spree/admin/stores/form/_basic.html.erb@@ -155,6 +155,6 @@</div></div></div>-- <%= render "spree/admin/stores/form/custom", f: f %></div>++<%= render_admin_partials(:store_form_partials, f: f) %>diff --git a/admin/app/views/spree/admin/stores/form/_custom.html.erb b/admin/app/views/spree/admin/stores/form/_custom.html.erbdeleted file mode 100644index e69de29bb2..0000000000diff --git a/admin/lib/spree/admin/engine.rb b/admin/lib/spree/admin/engine.rbindex 84671b58cb..bc55d3e9da 100644--- a/admin/lib/spree/admin/engine.rb+++ b/admin/lib/spree/admin/engine.rb@@ -3,6 +3,33 @@ require_relative 'runtime_configuration'module Spreemodule Adminclass Engine < ::Rails::Engine+ Environment = Struct.new(+ :head_partials,+ :body_start_partials,+ :body_end_partials,+ :dashboard_analytics_partials,+ :dashboard_sidebar_partials,+ :product_dropdown_partials,+ :product_form_partials,+ :product_form_sidebar_partials,+ :products_filters_partials,+ :order_page_header_partials,+ :order_page_body_partials,+ :order_page_summary_partials,+ :order_page_sidebar_partials,+ :order_page_dropdown_partials,+ :orders_filters_partials,+ :store_form_partials,+ :store_nav_partials,+ :store_settings_nav_partials,+ :store_orders_nav_partials,+ :store_products_nav_partials+ )++ # accessible via Rails.application.config.spree_admin+ initializer 'spree.admin.environment', before: :load_config_initializers do |app|+ app.config.spree_admin = Environment.new+ endinitializer 'spree.admin.configuration', before: :load_config_initializers do |_app|Spree::Admin::RuntimeConfig = Spree::Admin::RuntimeConfiguration.new@@ -46,6 +73,29 @@ module Spreeendendend++ config.after_initialize do+ Rails.application.config.spree_admin.head_partials = []+ Rails.application.config.spree_admin.body_start_partials = []+ Rails.application.config.spree_admin.body_end_partials = []+ Rails.application.config.spree_admin.dashboard_analytics_partials = []+ Rails.application.config.spree_admin.dashboard_sidebar_partials = []+ Rails.application.config.spree_admin.product_form_partials = []+ Rails.application.config.spree_admin.product_form_sidebar_partials = []+ Rails.application.config.spree_admin.product_dropdown_partials = []+ Rails.application.config.spree_admin.products_filters_partials = []+ Rails.application.config.spree_admin.order_page_header_partials = []+ Rails.application.config.spree_admin.order_page_body_partials = []+ Rails.application.config.spree_admin.order_page_sidebar_partials = []+ Rails.application.config.spree_admin.order_page_summary_partials = []+ Rails.application.config.spree_admin.order_page_dropdown_partials = []+ Rails.application.config.spree_admin.orders_filters_partials = []+ Rails.application.config.spree_admin.store_form_partials = []+ Rails.application.config.spree_admin.store_nav_partials = []+ Rails.application.config.spree_admin.store_settings_nav_partials = []+ Rails.application.config.spree_admin.store_orders_nav_partials = []+ Rails.application.config.spree_admin.store_products_nav_partials = []+ endendendenddiff --git a/storefront/app/helpers/spree/storefront_helper.rb b/storefront/app/helpers/spree/storefront_helper.rbindex a37de9d235..07ce981858 100644--- a/storefront/app/helpers/spree/storefront_helper.rb+++ b/storefront/app/helpers/spree/storefront_helper.rb@@ -3,9 +3,9 @@ module Spreeinclude BaseHelperinclude Heroicon::Engine.helpers- def render_storefront_partials(section)+ def render_storefront_partials(section, options = {})Rails.application.config.spree_storefront.send(section).map do |partial|- render partial: partial+ render partial, optionsend.join.html_safeenddiff --git a/storefront/lib/spree/storefront/engine.rb b/storefront/lib/spree/storefront/engine.rbindex 78e848be65..ebdfe20c0d 100644--- a/storefront/lib/spree/storefront/engine.rb+++ b/storefront/lib/spree/storefront/engine.rb@@ -14,12 +14,16 @@ module Spree:quick_checkout_partials)+ # accessible via Rails.application.config.spree_storefront+ initializer 'spree.storefront.environment', before: :load_config_initializers do |app|+ app.config.spree_storefront = Environment.new+ end+initializer 'spree.storefront.configuration', before: :load_config_initializers do |_app|Spree::Storefront::Config = Spree::Storefront::Configuration.newendinitializer 'spree.storefront.assets' do |app|- app.config.spree_storefront = Environment.newapp.config.assets.paths << root.join('app/javascript')app.config.assets.paths << root.join('vendor/javascript')app.config.assets.precompile += %w[spree_storefront_manifest]