Clone this repo:

Branches

  1. 2dae5a7 ChopsUI: Starting point for rewriting chops-header in lit-element. by Tiff Zhang · 9 weeks ago cit master
  2. 8c4abd9 ChopsUI: Initial directory setup for writing ChopsUI elements in lit-element. by Tiff Zhang · 3 months ago

chopsui

This directory contains Web Components that are meant to be shared by Chrome Operations' application frontends.

ChopsUI packages are published publicly on NPM under the @chopsui organization. To be added to this org, please send your NPM username to zhangtiff@.

Publishing packages

TODO(zhangtiff): Streamline the process of publishing multiple packages, especially once we add more packages.

Packages are currently independently published from each other. Thus, in order to publish/update an individual package, move into the directory for the package you want to update and publish the package.

For example, in order to update chops-header, you would run:

cd elements/chops-header
npm publish --access public

You will have to login to an NPM account with access to the @chopsui org to have publish permissions.

Testing demos locally

To run demos locally, we use webpack-dev-server to serve static files.

You need to installthe following dependencies:

npm install -g webpack-cli webpack-dev-server

Then, to run a demo, run:

npm start

Then navigate to your demo URL. For example, for chops-header this URL is:

http://localhost:8001/demos/chops-header.html

Downloading packages

Install the name of the specific package you're looking and install it within the @chopsui package scope. For example, to install chops-header, run:

npm install @chopsui/chops-header