Giter Site home page Giter Site logo

grandemayta / webcomponents-cli Goto Github PK

View Code? Open in Web Editor NEW
4.0 2.0 2.0 1.24 MB

WebComponents CLI allow you to develop WebComponents from scratch with LitElement and Typescript.

JavaScript 90.46% HTML 4.15% TypeScript 5.39%
webcomponents typescript customelements litelement

webcomponents-cli's Introduction

WebComponents CLI

NPM version Open Source Love made-with-javascript-doc

WebComponents CLI allow you to develop WebComponents from scratch with LitElement and Typescript.

Install

npm install -g @grandemayta/webcomponents-cli

Create a Project

wc-cli <name-of-your-project>

Getting Started

Launch the following commands to start the application:

npm start

Scripts:

Command Description
npm start Lift the application in local mode
npm run dev Generate a build in dev mode
npm run prod Generate a build in prod mode
npm run dev:legacy Generate a build in dev mode to support legacy browsers
npm run prod:legacy Generate a build in prod mode to support legacy browsers

Integration

Build tasks will create the following output:

Build for modern browsers:

├── dist/
    ├── vendor.min.js
    ├── bundle.min.js

Build with support for legacy browsers:

├── dist/
    ├── polyfills.min.js
    ├── webcomponents-loader.js
    ├── vendor.min.js
    ├── bundle.min.js
    ├── bundles/                               # These scripts will load at runtime
        ├── webcomponents-ce.js
        ├── webcomponents-sd-ce-pf.js
        ├── webcomponents-sd-ce.js
        ├── webcomponents-sd.js

Html example:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Web Components Example Integration</title>
</head>
<body>

    <app-greetings fullname="Charlotte"></app-greetings>

    <!-- If you want support legacy browser just remove this comment
    <script src="polyfills.min.js" nomodule></script>
    <script src="webcomponents-loader.js"></script>
    -->
    <script src="vendor.min.js"></script>
    <script src="bundle.min.js"></script>
</body>
</html>

Polyfills

We support the following features:

  • Generics

    • Symbol
    • fetch
    • Promise
    • Async / Await
  • Arrays

    • entries
    • from
    • find
    • findIndex
    • includes
    • keys
    • values
  • Objects

    • assign
    • entries
    • values
  • Strings

    • endsWith
    • includes
    • startsWith

Browsers support

✅ Chrome
✅ Firefox
✅ Safari
✅ Edge
✅ IE11

Documentation

Use the official guide to create WebComponents with LitElement

Todo

  • Improve the documentation
  • Setup Unit Testing
  • Setup E2E Testing

Keep calm and code!
Open Source Love

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.