Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Add ability to toggle page visibility through API

Matthew Kennedy918b1f049e90
diff --git a/api/app/controllers/spree/api/v2/platform/cms_pages_controller.rb b/api/app/controllers/spree/api/v2/platform/cms_pages_controller.rb
index 53278ddcfd..7891c98805 100644
--- a/api/app/controllers/spree/api/v2/platform/cms_pages_controller.rb
+++ b/api/app/controllers/spree/api/v2/platform/cms_pages_controller.rb
@@ -3,6 +3,24 @@ module Spree
module V2
module Platform
class CmsPagesController < ResourceController
+ before_action -> { doorkeeper_authorize! :write, :admin }, only: WRITE_ACTIONS << :toggle_visibility
+
+ def toggle_visibility
+ spree_authorize! :update, @toggle_page if spree_current_user.present?
+
+ @toggle_page = scope.find(params[:page_id])
+
+ if @toggle_page
+ @toggle_page.toggle!(:visible)
+ else
+ head :bad_request
+ end
+
+ if @toggle_page.save
+ head :no_content
+ end
+ end
+
private
def model_class
diff --git a/api/config/routes.rb b/api/config/routes.rb
index 1795be6334..ba81688ebe 100644
--- a/api/config/routes.rb
+++ b/api/config/routes.rb
@@ -267,7 +267,12 @@ Spree::Core::Engine.add_routes do
end
# CMS Pages API
- resources :cms_pages
+ resources :cms_pages do
+ member do
+ patch :toggle_visibility
+ end
+ end
+
resource :cms_sections do
member do
patch :reposition
diff --git a/backend/app/assets/javascripts/spree/backend/cms/page.es6 b/backend/app/assets/javascripts/spree/backend/cms/page.es6
index 8fc85b08ef..0a7d885b1b 100644
--- a/backend/app/assets/javascripts/spree/backend/cms/page.es6
+++ b/backend/app/assets/javascripts/spree/backend/cms/page.es6
@@ -21,10 +21,57 @@ document.addEventListener('DOMContentLoaded', function() {
}
})
}
+
+ const pageVisabilityAttribute = document.querySelectorAll('[data-cms-page-id]')
+ pageVisabilityAttribute.forEach(function (elem) {
+ elem.addEventListener('change', function () {
+ handleToggleVisibility(this)
+ })
+ })
})
+function handleToggleVisibility(obj) {
+ const pageId = parseInt(obj.dataset.cmsPageId, 10)
+ const data = { page_id: pageId }
+
+ fetch(Spree.routes.pages_api_v2 + `/${pageId}/toggle_visibility`, {
+ method: 'PATCH',
+ headers: {
+ Authorization: 'Bearer ' + OAUTH_TOKEN,
+ 'Content-Type': 'application/json'
+ },
+ body: JSON.stringify(data)
+ })
+ .then(response => {
+ if (response.ok) {
+ reloadPreview()
+ toggleVisibilityState(obj)
+ } else {
+ handleMenuItemMoveError()
+ }
+ })
+ .catch(err => {
+ console.error(err);
+ });
+}
+
+function toggleVisibilityState (obj) {
+ const statusHolder = document.getElementById('visibilityStatus')
+ const pageHidden = statusHolder.querySelector('.page_hidden')
+
+ if (obj.checked) {
+ pageHidden.classList.add('d-none')
+ } else {
+ pageHidden.classList.remove('d-none')
+ }
+}
+
function reloadPreview () {
- document.getElementById('pageLivePreview').contentWindow.location.reload();
+ const liveLiewArea = document.getElementById('pageLivePreview')
+
+ if (!liveLiewArea) return
+
+ liveLiewArea.contentWindow.location.reload();
}
function handleSectionReposition(evt) {
@@ -82,4 +129,3 @@ function updateCmsPageType () {
updatePageType.classList.remove('d-none')
}
}
-
diff --git a/backend/app/views/spree/admin/cms_pages/_form.html.erb b/backend/app/views/spree/admin/cms_pages/_form.html.erb
index ae6e8c4328..73c0b29c0f 100644
--- a/backend/app/views/spree/admin/cms_pages/_form.html.erb
+++ b/backend/app/views/spree/admin/cms_pages/_form.html.erb
@@ -5,15 +5,20 @@
<div class="card-header col-12">
<div class="row pb-0">
<div class="col d-flex justify-content-start">
- <h5 class="mb-0"> <%= Spree.t(:settings) %></h5>
+
+ <%= f.field_container :visible, class: ['form-group pb-0 mb-0 mr-3'] do %>
+ <div class="custom-control custom-switch">
+ <%= f.check_box :visible, class: 'custom-control-input', data: {cms_page_id: @cms_page.id} %>
+ <%= f.label :visible, Spree.t('admin.cms.toggle_page_visibility'), class: 'custom-control-label' %>
+ <%= f.error_message_on :visible %>
+ </div>
+ <% end %>
+ </div>
+ <div class="d-flex mr-3">
+ <h5 id="visibilityStatus" class="pb-0 mb-0">
+ <span class="page_hidden text-danger <% if @cms_page.viewable? %>d-none<% end %>"><%= svg_icon name: "view.svg", width: '16', height: '16' %> Hidden</span>
+ </h5>
</div>
- <%= f.field_container :visible, class: ['form-group pb-0 mb-0 mr-3'] do %>
- <div class="custom-control custom-switch">
- <%= f.check_box :visible, class: 'custom-control-input' %>
- <%= f.label :visible, Spree.t('admin.cms.visible'), class: 'custom-control-label' %>
- <%= f.error_message_on :visible %>
- </div>
- <% end %>
</div>
</div>
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 0571b09384..0ffc43927d 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -560,7 +560,7 @@ en:
page_type: Page Type
you_have_no_pages: You have no pages, click the Add New Page button to get started.
new_page: New Page
- visible: Visible
+ toggle_page_visibility: Toggle page visibility
meta_title: Meta Title
meta_description: Meta Description
preview_page: Preview Page