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.

Admin: Added dialog/drawer component

Damian Legawiec9a4ffb2b7485
diff --git a/admin/app/assets/stylesheets/spree/admin/application.scss b/admin/app/assets/stylesheets/spree/admin/application.scss
index bc5d68b23c..b53d9dbba8 100644
--- a/admin/app/assets/stylesheets/spree/admin/application.scss
+++ b/admin/app/assets/stylesheets/spree/admin/application.scss
@@ -12,7 +12,8 @@
@import 'components/buttons';
@import 'components/filters';
@import 'components/navigation';
-@import 'components/modals';
+@import 'components/modals'; // old bootstrap modals
+@import 'components/dialogs'; // new native dialogs
@import 'components/offcanvas';
@import 'components/variants_form';
@import 'components/media_form';
diff --git a/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss b/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
new file mode 100644
index 0000000000..b668722492
--- /dev/null
+++ b/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
@@ -0,0 +1,111 @@
+/* Prevent scrolling while dialog is open */
+body:has(dialog[data-dialog-target="dialog"][open]) {
+ // overflow: hidden;
+}
+
+/* Customize the dialog backdrop */
+dialog {
+ box-shadow: 0 0 0 100vw rgba($modal-backdrop-bg, $modal-backdrop-opacity);
+}
+
+dialog:-internal-dialog-in-top-layer::backdrop {
+ background-color: rgba($modal-backdrop-bg, $modal-backdrop-opacity);
+}
+
+@keyframes fade-in {
+ 0% {
+ opacity: 0;
+ }
+ 100% {
+ opacity: 1;
+ }
+}
+
+@keyframes fade-out {
+ 0% {
+ opacity: 1;
+ }
+ 100% {
+ opacity: 0;
+ }
+}
+
+/* Add animations */
+dialog[data-dialog-target="dialog"][open] {
+ animation: fade-in 200ms forwards;
+}
+
+dialog[data-dialog-target="dialog"][closing] {
+ animation: fade-out 200ms forwards;
+}
+
+dialog {
+ display: none;
+ z-index: $zindex-modal;
+ border-radius: $modal-content-border-radius;
+ border: $modal-content-border-width solid $modal-content-border-color;
+ background: $modal-content-bg;
+ box-shadow: $modal-content-box-shadow-xs;
+ overflow-y: auto;
+ overflow-x: hidden;
+}
+dialog:open {
+ display: block;
+}
+
+.drawer {
+ position: fixed;
+ top: 0;
+ right: 0;
+ left: auto;
+ height: calc(100vh - 2rem);
+ width: calc(100vw - 2rem);
+ max-width: 600px;
+ min-width: 320px;
+ margin: 1rem;
+ flex-direction: column;
+ justify-content: space-between;
+ padding: 0;
+
+ &:open {
+ display: flex;
+ }
+
+ @media (max-width: 991.98px) {
+ max-width: 100vw;
+ min-width: 100vw;
+ }
+
+ > turbo-frame, turbo-frame > form {
+ display: flex;
+ width: 100%;
+ height: 100%;
+ flex-direction: column;
+ justify-content: space-between;
+ }
+
+ .drawer-header {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ padding: $modal-inner-padding;
+ }
+
+ .drawer-body {
+ flex: 1 1 auto;
+ overflow-y: auto;
+ padding: $modal-inner-padding;
+ }
+
+ .drawer-footer {
+ padding: $modal-inner-padding;
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ }
+}
+
+@media (min-width: 992px) {
+ .drawer {
+ }
+}
diff --git a/admin/app/helpers/spree/admin/drawer_helper.rb b/admin/app/helpers/spree/admin/drawer_helper.rb
new file mode 100644
index 0000000000..2b1636d5b9
--- /dev/null
+++ b/admin/app/helpers/spree/admin/drawer_helper.rb
@@ -0,0 +1,21 @@
+module Spree
+ module Admin
+ module DrawerHelper
+ def drawer_header(title)
+ content_tag(:div, class: 'drawer-header') do
+ content_tag(:h5, title, class: 'drawer-title') + drawer_close_button
+ end.html_safe
+ end
+
+ def drawer_close_button
+ button_tag('', type: 'button', class: 'btn-close', data: { action: 'drawer#close', dismiss: 'drawer', aria_label: Spree.t(:close) }).html_safe
+ end
+
+ def drawer_discard_button
+ button_tag(type: 'button', class: 'btn btn-light', data: { action: 'drawer#close', dismiss: 'drawer' }) do
+ Spree.t('actions.discard')
+ end.html_safe
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/turbo_helper.rb b/admin/app/helpers/spree/admin/turbo_helper.rb
index eac89fd5b9..5d1f401859 100644
--- a/admin/app/helpers/spree/admin/turbo_helper.rb
+++ b/admin/app/helpers/spree/admin/turbo_helper.rb
@@ -17,6 +17,12 @@ module Spree
end
end
+ def turbo_hide_drawer
+ turbo_stream.replace 'drawer-dialog' do
+ render 'spree/admin/shared/drawer'
+ end
+ end
+
def turbo_render_alerts
turbo_stream.replace :alerts do
render 'spree/admin/shared/alerts'
diff --git a/admin/app/javascript/spree/admin/application.js b/admin/app/javascript/spree/admin/application.js
index 3dd74c5663..306621513a 100644
--- a/admin/app/javascript/spree/admin/application.js
+++ b/admin/app/javascript/spree/admin/application.js
@@ -34,6 +34,7 @@ if (typeof Stimulus === 'undefined') {
}
import AutoSubmit from '@stimulus-components/auto-submit'
import CheckboxSelectAll from 'stimulus-checkbox-select-all'
+import Dialog from '@stimulus-components/dialog'
import Dropdown from '@stimulus-components/dropdown'
import TextareaAutogrow from 'stimulus-textarea-autogrow'
import Notification from 'stimulus-notification'
@@ -42,7 +43,6 @@ import RailsNestedForm from '@stimulus-components/rails-nested-form'
import Reveal from 'stimulus-reveal-controller'
import Sortable from 'stimulus-sortable'
import { Tabs } from 'tailwindcss-stimulus-components'
-
import ActiveStorageUpload from 'spree/admin/controllers/active_storage_upload_controller'
import AdminController from 'spree/admin/controllers/admin_controller'
import AssetUploaderController from 'spree/admin/controllers/asset_uploader_controller'
@@ -56,6 +56,7 @@ import CalendarRangeController from 'spree/admin/controllers/calendar_range_cont
import Clipboard from 'spree/admin/controllers/clipboard_controller'
import ColorPaletteController from 'spree/admin/controllers/color_palette_controller'
import ColorPickerController from 'spree/admin/controllers/color_picker_controller'
+import DrawerController from 'spree/admin/controllers/drawer_controller'
import FiltersController from 'spree/admin/controllers/filters_controller'
import FontPickerController from 'spree/admin/controllers/font_picker_controller'
import MediaFormController from 'spree/admin/controllers/media_form_controller'
@@ -103,6 +104,8 @@ application.register('checkbox-select-all', CheckboxSelectAll)
application.register('clipboard', Clipboard)
application.register('color-palette', ColorPaletteController)
application.register('color-picker', ColorPickerController)
+application.register('dialog', Dialog)
+application.register('drawer', DrawerController)
application.register('disable-submit-button', DisableSubmitButtonController)
application.register('dropdown', Dropdown)
application.register('enable-button', EnableButtonController)
diff --git a/admin/app/javascript/spree/admin/controllers/drawer_controller.js b/admin/app/javascript/spree/admin/controllers/drawer_controller.js
new file mode 100644
index 0000000000..5d068342df
--- /dev/null
+++ b/admin/app/javascript/spree/admin/controllers/drawer_controller.js
@@ -0,0 +1,4 @@
+import Dialog from "@stimulus-components/dialog"
+
+export default class extends Dialog {
+}
\ No newline at end of file
diff --git a/admin/app/views/layouts/spree/admin.html.erb b/admin/app/views/layouts/spree/admin.html.erb
index fd1b423144..6db3e1c6c0 100644
--- a/admin/app/views/layouts/spree/admin.html.erb
+++ b/admin/app/views/layouts/spree/admin.html.erb
@@ -13,12 +13,13 @@
<%= render "spree/admin/shared/header" %>
<%= render "spree/admin/shared/sidebar" %>
- <main id="content">
+ <main id="content" data-controller="drawer">
<%= render "spree/admin/shared/content_header" %>
<div class="container">
<%= yield %>
</div>
<%= render "spree/admin/shared/footer" %>
+ <%= render 'spree/admin/shared/drawer' %>
</main>
<%= render "spree/admin/shared/modal" %>
<%= render "spree/admin/shared/alerts" %>
diff --git a/admin/app/views/spree/admin/shared/_drawer.html.erb b/admin/app/views/spree/admin/shared/_drawer.html.erb
new file mode 100644
index 0000000000..fadd159824
--- /dev/null
+++ b/admin/app/views/spree/admin/shared/_drawer.html.erb
@@ -0,0 +1,3 @@
+<dialog class="drawer" data-drawer-target="dialog" id="drawer-dialog">
+ <%= turbo_frame_tag :drawer %>
+</dialog>
\ No newline at end of file
diff --git a/admin/config/importmap.rb b/admin/config/importmap.rb
index 86ef78ea0b..01aea1be7c 100644
--- a/admin/config/importmap.rb
+++ b/admin/config/importmap.rb
@@ -28,6 +28,7 @@ pin 'stimulus-use', preload: ['application-spree-admin'] # @0.51.3
pin 'stimulus-checkbox-select-all', preload: ['application-spree-admin'] # @5.3.0
pin 'stimulus-clipboard', preload: ['application-spree-admin'] # @4.0.1
pin "@stimulus-components/dropdown", to: "@stimulus-components--dropdown.js", preload: ['application-spree-admin'] # @3.0.0
+pin "@stimulus-components/dialog", to: "@stimulus-components--dialog.js", preload: ['application-spree-admin'] # @1.0.1
# We can't vendor some of the javascript libraries
# because they have relative imports in the code,
diff --git a/admin/vendor/javascript/@stimulus-components--dialog.js b/admin/vendor/javascript/@stimulus-components--dialog.js
new file mode 100644
index 0000000000..a7bc876f7b
--- /dev/null
+++ b/admin/vendor/javascript/@stimulus-components--dialog.js
@@ -0,0 +1,4 @@
+// @stimulus-components/[email protected] downloaded from https://ga.jspm.io/npm:@stimulus-components/[email protected]/dist/stimulus-dialog.mjs
+
+import{Controller as e}from"@hotwired/stimulus";const t=class _Dialog extends e{initialize(){this.forceClose=this.forceClose.bind(this)}connect(){this.openValue&&this.open(),document.addEventListener("turbo:before-render",this.forceClose)}disconnect(){document.removeEventListener("turbo:before-render",this.forceClose)}open(){this.dialogTarget.showModal()}close(){this.dialogTarget.setAttribute("closing",""),Promise.all(this.dialogTarget.getAnimations().map((e=>e.finished))).then((()=>{this.dialogTarget.removeAttribute("closing"),this.dialogTarget.close()}))}backdropClose(e){e.target===this.dialogTarget&&this.close()}forceClose(){this.dialogTarget.close()}};t.targets=["dialog"],t.values={open:{type:Boolean,default:!1}};let o=t;export{o as default};
+