Project Awesome project awesome
♥

LRNWebComponents

ELMS:LN produced web components for any project.

Package 271 stars GitHub

Project Status: Active – The project has reached a stable, usable state and is being actively developed. OpenSSF Scorecard Community Support License: Apache 2.0 Contributor Covenant Discord lerna Lit #HAXTheWeb Published on npm build X

Welcome to the HaxTheWeb project!

Web components that can work in just about anything, are very small (Vanila or Lit based) and have full on authoring solutions if you dig deeper; Enjoy!

Getting Started

Quick install: Dev Containers (as a core dev, forks preferrable)

HAXTheWeb is dedicated to making contribution an accessible and simple experience. Follow the step-by-step guide below to explore our curated development environment:

Prerequisites

  • On Windows: Update WSL 2

    • There are two methods available:
      • Open WSL 2 in the Microsoft Store, select Install/Update
      • Open PowerShell, run the command: wsl --update
    • Why: Certain Windows editions are bundled with an outdated WSL 2 version.

  • On macOS or Linux: None

Guide

  1. Install Docker Desktop
    • Windows
      • Select the WSL 2 Backend option
      • Restart after installing
    • macOS
    • Linux
    • Docker Desktop must remain open for VS Code to connect with it.
  2. Install GitHub Desktop (optional)
  3. Clone the repository with Git
    • Using GitHub Desktop: select Clone Repository, then select the URL option.
    • Enter the link to your repository: https://github.com/haxtheweb/webcomponents
  4. Open the repository in VS Code
    • Using GitHub Desktop: simply select Open in VS Code
  5. Some alerts with pop up in the bottom right corner of VS Code:
    • Select Install Recommended Extensions
    • Select Reopen in Container

Wait a few minutes for your Dev Container to be built, then you're ready to go! Try the following command to open a demo HAXsite:

yarn run haxsite

Alternative installs

If you're interested in other installation methods, visit our Contributing Docs! We provide native Bash and PowerShell scripts, in addition to manual instructions.

What is HAX

The authoring experience of HAX and the ability to make fast, static file backed websites rapidly. Get all the details you want on HAX docs! HAX seeks to be the smallest possible back-end CMS to make HAX work and be able to build websites with it. Leveraging JSON Outline Schema, HAX is able to author multiple pages, which it then writes onto the file system. This way a slim server layer is just for basic authentication, knowing how to save files, and placing them in version control.

Watch and Learn more about HAX here:

Issues / Support / Community

Related links and tech

To work on any element in our repo

cd elements/ELEMENTNAME
yarn start

Edit files in lib/, src/, locales/ and demo/ in order to modify the element to contribute back to us via PR.

Scripts

  • hax webcomponent my-element --y
    • Run HAX CLI to create a new web component
  • yarn test
    • Run tests on ALL webcomponents.
  • yarn run build
    • Run build on ALL webcomponents.
  • yarn run gallery
    • Run component gallery (replaces storybook)
  • yarn run build-gallery
    • Build component gallery for deployment

Web Component development

Because this is a monorepo, each web component will need to be independently built in order to actively work on and preview the changes. Every web component has its own Gulp file and Yarn/NPM script.

While still running yarn start in one terminal window (which runs the local server), you will need to open another terminal window, drill into the directory of the web component you'd like to work on, and execute the yarn run dev command. This command will use gulp tasks to watch the files within that web component directory and will automatically re-run the build command and refresh the browser when you make changes to the web component.

Working on elements (new-element)

Run hax webcomponent to make a new element. Go to the new element following the directions generated at the end of the element's creation. To work on the new-element run yarn start from it's directory. If you are pulling in another element to use, run yarn add projectname --save or edit the package.json file local to the element you are working on. ALWAYS INSTALL FROM THE REPO ROOT, NOT THE ELEMENT YOU ARE WORKING ON

Example development on a web component

cd /Sites/webcomponents
yarn start

# SHIFT + CTRL + T to open a new tab in Terminal

cd elements your-card  # or any other web component
yarn run dev

Make a change to the web component and save. The gulpfile will handle transpiling the element down to ES5 and will bring in the HTML and Sass into the template in the web component.

Test

To test all webcomponents, run yarn test from the root of the repo. If you only want to test the web component you're working on:

cd elements/your-card
yarn test

Also, if your tests are failing and you want access to a live browser to investigate why, the following flag will keep the browser open.

yarn test -- -p

Then open the URL that will be printed in the terminal. It looks something like this: http://localhost:8081/components/@@haxtheweb/haxtheweb/generated-index.html?cli_browser_id=0.

Component Gallery

We've replaced Storybook with our own Component Gallery to preview and document our web components. The Component Gallery provides a better integrated experience with HAX design system and build tools.

To run the component gallery locally

yarn run gallery

This will build the gallery and start a web server. Navigate to the URL shown in the terminal to see the Component Gallery in action. The gallery will automatically rebuild when components change.

To build the component gallery for deployment

yarn run build-gallery

This generates the component gallery as a single HTML file: component-gallery.html.

Component Gallery Features

  • HAX Integration: Built-in support for HAX-enabled components
  • DDD Design System: Uses our Design, Develop, Destroy design tokens
  • Live Demos: Interactive component demonstrations
  • CodePen Export: Direct export to CodePen for experimentation
  • Search & Filter: Easy component discovery
  • Mobile Responsive: Works on all device sizes

Tech Stack

Client: JavaScript, LitElement, Lit(https://lit.dev/)

Server: Node.js

Contributing

Contributions are always welcome!

Active contributors

Additional contributions

Past contributors, student and larger community, can be found here: https://github.com/haxtheweb/webcomponents/graphs/contributors

HAX Traveler: World Changer

Back to lit