Skip to content

A tool for building BigCommerce Page Builder widget templates

Notifications You must be signed in to change notification settings

digitalsurgeons/big-widget

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BigWidget

A tool to help make Page Builder widget templates for BigCommerce stores.

Prerequisites

  • a BigCommerce store
  • a BigCommerce store API account with the following scopes:
UI Name Permission Parameter
Content modify store_v2_content

For more information on creating BigCommerce API accounts, see the BigCommerce documentation.

Installation

npm i -g big-widget

Usage

Create a project folder

mkdir my-widget

Navigate into the project folder

cd my-widget

Initialize your project

big-widget init

Complete the prompts using your BigCommerce store API account.

Push your widget to the store

big-widget push

Project Structure

config.big-widget.json

Configuration values for your widget including the widget template name, store API path, widget template uuid and current version uuid.

schema.json

A widget UI schema

storefront-api-query.graphql

A BigCommerce GraphQL Storefront API query used to create widgets with dynamic data.

template.html

HTML and Handlebars used to populate the template of the widget template.

MIT License

Copyright 2021 Patrick Puente

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A tool for building BigCommerce Page Builder widget templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 94.2%
  • HTML 5.8%