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.

Set up JavaScript adapter for use with HTML data attributes.

Matthew Kennedybd2d3c301496
diff --git a/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6 b/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
index 5a237f21c2..0f42ae0c6c 100644
--- a/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
+++ b/backend/app/assets/javascripts/spree/backend/global/select2_autocomplete.es6
@@ -1,4 +1,48 @@
-// Allows you to use one autocomplete for sevral use cases with sensible defaults.
+document.addEventListener('DOMContentLoaded', function() {
+ const select2Autocompletes = document.querySelectorAll('select.autocomplete')
+ select2Autocompletes.forEach(element => buildParamsFromDataAttrs(element))
+})
+
+// REQUIRED
+// data-ac_name="products" <- used for api search.
+// data-ac_url="products_api_v2" or data-ac_url="taxons_api_v2" <- gets appended to const to build url.
+
+// OPTIONAL
+// data-ac_clear="boolean" <- true or false allows select2 clear.
+// data-ac_multiple="boolean" <- true or false set multiple or single select
+// data-ac_return_attr="pretty_name" <- example shown returns taxon pretty_name
+// data-ac_min_input="4" <- set a minimum input for search, default is 3.
+// data-ac_search_query="name_or_master_sku_cont" <- custom search query.
+
+function buildParamsFromDataAttrs (element) {
+ // Required Attributes
+ const name = element.dataset.acName
+ const url = element.dataset.acUrl
+
+ // Optional Attributes
+ const placeholder = element.dataset.acPlaceholder
+ const clear = element.dataset.acClear
+ const multiple = element.dataset.acMultiple
+ const returnAttr = element.dataset.acReturnAttr
+ const minimumInput = element.dataset.acMinInput
+ const searchQuery = element.dataset.acSearchQuery
+
+ $(element).select2Autocomplete({
+ // Required Attributes
+ data_attrbute_name: name,
+ apiUrl: Spree.routes[url],
+
+ // Optional Attributes
+ placeholder: placeholder,
+ allow_clear: clear,
+ multiple: multiple,
+ return_attribute: returnAttr,
+ minimum_input: minimumInput,
+ search_query: searchQuery
+ })
+}
+
+// Allows you to use one autocomplete for several use cases with sensible defaults.
// Requires two params passing to work, the api URI, and the data attribute -> data_attrbute_name: 'products'
$.fn.select2Autocomplete = function(params) {
// Required params
diff --git a/backend/app/views/spree/admin/shared/linkables/_spree_product.html.erb b/backend/app/views/spree/admin/shared/linkables/_spree_product.html.erb
index d7e6ef9f65..8d9983ceca 100644
--- a/backend/app/views/spree/admin/shared/linkables/_spree_product.html.erb
+++ b/backend/app/views/spree/admin/shared/linkables/_spree_product.html.erb
@@ -5,19 +5,17 @@
<% active_id_holder = resource.linked_resource.id %>
<% end %>
<%= f.field_container :linked_resource_id, class: ['form-group'] do %>
- <%= f.label :linked_resource_id, Spree.t('product') %>
- <%= f.select :linked_resource_id, options_from_collection_for_select(resorce_holder || [] , id_holder, name_holder, active_id_holder || nil), { include_blank: true }, class: 'autocomplete' %>
+ <%= f.label :linked_resource_id, Spree.t('product') %>
+ <%= f.select :linked_resource_id,
+ options_from_collection_for_select(resorce_holder || [],
+ id_holder, name_holder, active_id_holder || nil),
+ { include_blank: true },
+ class: 'autocomplete',
+ data: { ac_name: 'products',
+ ac_placeholder: Spree.t('admin.navigation.seach_for_a_product'),
+ ac_clear: true,
+ ac_url: 'products_api_v2' } %>
+
<%= f.error_message_on :linked_resource_id %>
<small class="form-text text-muted"><%= resource.link %></small>
<% end %>
-
-<script>
- document.addEventListener('DOMContentLoaded', function() {
- $('.autocomplete').select2Autocomplete({
- data_attrbute_name: 'products',
- placeholder: "<%= Spree.t('admin.navigation.seach_for_a_product') %>",
- allow_clear: true,
- apiUrl: Spree.routes.products_api_v2
- })
- })
-</script>
diff --git a/backend/app/views/spree/admin/shared/linkables/_spree_taxon.html.erb b/backend/app/views/spree/admin/shared/linkables/_spree_taxon.html.erb
index 74506d45fc..dea612e051 100644
--- a/backend/app/views/spree/admin/shared/linkables/_spree_taxon.html.erb
+++ b/backend/app/views/spree/admin/shared/linkables/_spree_taxon.html.erb
@@ -6,19 +6,17 @@
<% end %>
<%= f.field_container :linked_resource_id, class: ['form-group'] do %>
<%= f.label :linked_resource_id, Spree.t('taxon') %>
- <%= f.select :linked_resource_id, options_from_collection_for_select(resorce_holder || [] , id_holder, name_holder, active_id_holder || nil), { include_blank: true }, class: 'autocomplete' %>
+ <%= f.select :linked_resource_id,
+ options_from_collection_for_select(resorce_holder || [],
+ id_holder, name_holder, active_id_holder || nil),
+ { include_blank: true },
+ class: 'autocomplete',
+ data: { ac_name: 'taxons',
+ ac_placeholder: Spree.t('admin.navigation.seach_for_a_taxon'),
+ ac_clear: true,
+ ac_url: 'taxons_api_v2',
+ ac_return_attr: 'pretty_name' } %>
+
<%= f.error_message_on :linked_resource_id %>
<small class="form-text text-muted"><%= resource.link %></small>
<% end %>
-
- <script>
- document.addEventListener('DOMContentLoaded', function() {
- $('.autocomplete').select2Autocomplete({
- data_attrbute_name: 'taxons',
- placeholder: "<%= Spree.t('admin.navigation.seach_for_a_taxon') %>",
- allow_clear: true,
- apiUrl: Spree.routes.taxons_api_v2,
- return_attribute: 'pretty_name'
- })
- })
- </script>