Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 2.74 KB

README.md

File metadata and controls

91 lines (70 loc) · 2.74 KB
Raw

@somewherewarm/woocommerce

Collection of WooCommerce packages for building stuff with ReactJS + Gutenberg.

Usage

This repo can be used for the following purposes:

Webpack Configuration

You can setup a quick and easy WooCommerce Blocks dev environment with Webpack. To get started, include the dependency in your local package.json:

"@somewherewarm/woocommerce": "^1.1.0"

https://www.npmjs.com/package/@somewherewarm/woocommerce

Make sure that the following packages added as devDependencies in your package.json:

"@automattic/color-studio": "^2.5.0",
"@woocommerce/dependency-extraction-webpack-plugin": "^1.7.0",
"@wordpress/scripts": "^14.0.0",

Then, in your webpack.config.js you'll need to grap the latest dependecy manager as your main config array:

const defaultConfig = require( '@somewherewarm/woocommerce/packages/dependency-manager/config/webpack.config' );

From here, you only need to add your entrypoints and output path. Here's an example of how your webpack may look like:

const defaultConfig = require( '@somewherewarm/woocommerce/packages/dependency-manager/config/webpack.config' );
const path          = require( 'path' );

module.exports = {
    ...defaultConfig,
    entry: {
        'admin/analytics': '/resources/js/admin/analytics/index.js',
        'frontend/blocks': '/resources/js/frontend/blocks/index.js',
    },
    output: {
        path: path.resolve(__dirname, 'assets/dist'),
        filename: '[name].js',
    }
};

SASS

You can import any SASS file into your JS files.

Every file will also automatically resolve several WordPress & Gutenberg variables for you. Here's the list for reference:

Global files

Global SASS files can be created in any of the following special directories:

  • resources/js/frontend/sass
  • resources/js/admin/analytics/sass and;
  • node_modules

For example, if you have a local file named "_colors.scss" inside your resources/js/frontend/sass then you could import this file from any SASS file path using the following simple import:

// ./resources/js/frontend/blocks/components/text-input/style.scss
@import "colors";

The system will resolve this to resources/js/frontend/sass/_colors.scss.

React Packages

Currently only used for admin analytics.

Available packages:

  • components
  • lib

Use them in your project by using the following import schema:

import Module from '@somewherewarm/[package_name]'

e.g.

import ReportTable from '@somewherewarm/components'

Available components:

  • ReportChart
  • ReportError
  • ReportSummary
  • ReportTable