Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(WIP/RFC) MERC-3425 - Kill off legacy "snippet" locations and add more content regions #1193

Closed
wants to merge 1 commit into from
Closed

Conversation

bookernath
Copy link
Contributor

What?

This removes all of the legacy "snippet" helpers, and replaces them with one or more regions for content injection.

I've also taken some liberty spreading other regions around; I'm mostly putting this up so we can discuss it.

Based off of https://docs.google.com/spreadsheets/d/1P4ncQzCrCeJJp8sXgFuAxWKuDqhvFeHmkuJ3b5MytmI/edit#gid=0

ping @pedelman @junedkazi @becomevocal @bigcommerce/merc-team

@bigbot
Copy link

bigbot commented Mar 22, 2018

Autotagging @bigcommerce/storefront-team @davidchin

@flyingL123
Copy link
Contributor

This is cool. Are these 'regions' exposed anywhere in the control panel UI or the API? How is content meant to be supplied for injection?

@EricSeastrand
Copy link

@flyingL123 Guessing that this is to be used with the new Widgets API feature. You would create a Widget entity, and a Placement entity. The placement specifies which Region the widget will be injected into.

@bookernath
Copy link
Contributor Author

Yep @flyingL123 , @willcodeforfood is correct. We can enable the beta of this feature (API-only for now) for you if you like.

@flyingL123
Copy link
Contributor

@bookernath it would be great to give this feature a try. We have a few use-cases for this.

One example would be the way we display specific reviews on our website homepage. Currently I have to re-release the entire theme just to update the hardcoded featured reviews. If I could instead just add a 'region' to the theme and update the content of it through the API, that would be much better.

Is there any documentation explaining this feature at a higher level? I'm just trying to understand how widgets, placements, and regions all interact.

@mattolson
Copy link
Contributor

@pedelman Thoughts?

@michael811
Copy link

@bookernath
Is this region feature available now? I created widget template, widget and placement through API, but can't show anything by {{region name="test"}}, any ideas? Thanks!

@bookernath
Copy link
Contributor Author

Hi @michael811 , this feature needs to be enabled on a store-by-store basis while it's in beta. Feel free to drop us a note at community@bigcommerce.com to join the beta.

@junedkazi
Copy link
Contributor

@bookernath what is the status on this PR ? Are we moving forward with it or it was just a POC ?

@ghost
Copy link

ghost commented Oct 10, 2018

It's a POC at this point. We'll soon leverage the code in this PR to document and enable regions across themes. Most likely we'll open up a new PR when that happens.

@bookernath
Copy link
Contributor Author

For those on this thread, I'd like to make you aware of the launch of our Widgets API:

https://medium.com/bigcommerce-developer-blog/the-widgets-api-new-ways-to-insert-custom-content-in-bigcommerce-storefronts-db0f9fd4eab5

We'll communicate more in the future for how we envision these being integrated into themes.

@bookernath
Copy link
Contributor Author

Closing in favor of #1478

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.

7 participants