https://github.com/HelixDesignSystem/helix-ui

Web Component library for the Helix Design System
https://github.com/HelixDesignSystem/helix-ui

helix-design-system helix-ui-webcomponents webcomponents-framework

Last synced: 3 months ago
JSON representation

Web Component library for the Helix Design System

• Host: GitHub
• URL: https://github.com/HelixDesignSystem/helix-ui
• Owner: HelixDesignSystem
• License: other
• Created: 2017-05-18T15:26:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:56:51.000Z (almost 2 years ago)
• Last Synced: 2024-05-03T13:53:44.527Z (6 months ago)
• Topics: helix-design-system, helix-ui-webcomponents, webcomponents-framework
• Language: JavaScript
• Homepage: https://helixdesignsystem.github.io/helix-ui/
• Size: 45.8 MB
• Stars: 57
• Watchers: 18
• Forks: 25
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-web-components - Helix UI - Web Component library for the Helix Design System. (Real World / Design Systems)

README

        
[![Build Status](https://travis-ci.com/HelixDesignSystem/helix-ui.svg?branch=master)](https://travis-ci.com/HelixDesignSystem/helix-ui)

[![HelixUI CI Build Pipeline](https://github.com/HelixDesignSystem/helix-ui/actions/workflows/build.yml/badge.svg)](https://github.com/HelixDesignSystem/helix-ui/actions/workflows/build.yml)

[![HelixUI SauceLabs Tests](https://github.com/HelixDesignSystem/helix-ui/actions/workflows/browser-tests.yml/badge.svg)](https://github.com/HelixDesignSystem/helix-ui/actions/workflows/browser-tests.yml)

# HelixUI Web Components Library

The HelixUI Web Components library provides front-end developers a full suite

of web components for building UIs.

Adopting the library will enable developers to build products with consistent

markup, styles, and behavior across a variety of frameworks.

## Documentation

 * Homepage - https://helixdesignsystem.github.io/helix-ui/

 * Getting Started Guide - https://helixdesignsystem.github.io/helix-ui/guides/getting-started/

 * NPM Releases - https://www.npmjs.com/package/helix-ui

## Helix-React Wrappers + React Support

 * Our sister repo **Helix-React** - https://github.com/HelixDesignSystem/helix-react - provides

   React component wrappers to HelixUI.

 * NPM Releases - https://www.npmjs.com/package/@helix-design-system/helix-react

 * React Compatiblity with Web Components - https://helixdesignsystem.github.io/helix-ui/guides/react-compatibility/

## Developer Setup

1. Install Yarn - https://yarnpkg.com/en/docs/install

2. `$ git clone [email protected]:HelixDesignSystem/helix-ui.git` (recommended for 2FA setups)

3. `$ cd helix-ui`

4. `$ yarn install` to install project dependencies

5. `$ yarn start`

6. Navigate to `http://127.0.0.1:3000` in your favorite browser

## Run Component Test Suite

### Initial Run (or on code updates)

- `$ yarn test:build` to compile code and run the full component test suite

### Just making changes to tests

- `$ yarn test` to run the full component test suite