Shopify / buy-button-js

BuyButton.js is a highly customizable UI library for adding ecommerce functionality to any website.
http://shopify.github.io/buy-button-js/
MIT License
242 stars 114 forks source link

Official versioning + up to date documentation #556

Open LouAdrien opened 5 years ago

LouAdrien commented 5 years ago

Hello, it seems the current version of the documentation, along with several articles available on the shopify website, are out of date. -> with the latest version of the code on git (doc refers to v0.1.34) -> and also out of date with the code autogenerated thourgh the shopify backend (which uses another library called Shopify buy-button-storefront version, 1.12.6. -> NPM which is referencing 0.8.6

I would like to know, which is the official current version for the js-buy SDK? And where can we find up to date documentation on it? thanks

arobbins commented 5 years ago

This is the Github repo: https://github.com/Shopify/js-buy-sdk

And the docs page: https://shopify.github.io/js-buy-sdk/

LouAdrien commented 5 years ago

Hey thanks! Then should this repo be deleted? It's rather confusing...

Are you an official maintainer of the repo? I was curious, it seems in the new docs there are no mentions of many features that were available in the previous version of the sdk. I am especially in need of the template customisation with data access as mentionned here : https://shopify.github.io/buy-button-js/advanced/ Do you need if this is still possible with the new sdk?

LouAdrien commented 5 years ago

My bad, I just got the difference between the js-buy-sdk and the buy-button-js, the very similar namings got me confused. Thanks for the answer.

Just for clarification, the library that is included when generating code from the shopify interface (named "buy-button-storefront"), is it just a rename of the buy-button-js library? Or yet another one that is not accessible in github?

Thanks in advance

melissaluu commented 5 years ago

Hi @LouAdrien - buy-button-storefront.js used in the generated code from the channel is a wrapper for the buy-button-js library. It includes additional logic that ensures older buy buttons generated by the channel to continue to work in the future. You can still access and use the same features and API configs that's offered in buy-button-js.