/wp-plugin-webcomponents

Web Components plugin for WordPress & ClassicPress

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

Usage

This should give you the dependencies you need to get going.

  1. Enable the Web components plugin and any dependencies it requires.
  2. The default is to serve JS assets up from a CDN. Should you need to change this

Front end Developers

You may build Web components from source if needed. We default to use CDNs which will effectively point to this directory or some mutation of it -- https://github.com/elmsln/HAXcms/tree/master/build

If you want to build everything from source, your welcome to use yarn / npm to do so though our build routine effectively will end in the same net result. If you want to do custom build routines such as rollup or webpack and not use our prebuilt copies / split build approaches, then your welcome to check the box related to not loading front end assets in the settings page in order to tailor the build to your specific needs.

Getting dependencies

You need polymer cli (not polymer but the CLI library) in order to interface with web components in your site. Get polymer cli installed prior to usage of this (and (yarn)[https://yarnpkg.com/lang/en/docs/install/#mac-stable] / an npm client of some kind)

$ yarn global add polymer-cli

Perform this on your computer locally, this doesn't have to be installed on your server.

Usage

  • Find the CopyThisStuff directory in /wp-content/plugins/webcomponents
  • create a /wp-content/webcomponents directory
  • copy the files from CopyThisStuff into /wp-content/webcomponents

Then run the following (from the directory you copied it over to) in order to get dependencies:

$ yarn install

Now run polymer build and you'll have files in build/ which contain everything you'll need to get wired up to web components in your site. Modifying build.js or package.json can be used in order to get new elements and have them be implemented.

Shouldn't I put web components in my theme?

We don't think so. While it may seem counter intuitive, the theme layer should be effectively implementing what the site is saying is available. If you think of standard HTML tags are being part of this (p, div, a, etc) then it makes a bit more sense. You don't want functional HTML components to ONLY be supplied if your theme is there, you want your theme to implement and leverage the components.

New to web components?

We built our own tooling to take the guess work out of creating, publishing and testing web components. We highly recommend you use this tooling though it's not required: