Skip to main content

Starter kits

The Lit Starter Kits are project templates for reusable Lit components that can be published for others to use.

To get started working on a component locally, you can use one of these starter projects:

Both projects define a Lit component. They also add a set of optional tools for developing, linting, and testing the component:

None of these tools is required to work with Lit. They represent one possible set of tools for a good developer experience.

Alternative starting point. As an alternative to the official Lit starter projects, the Open WC project has a project generator for web components using Lit. The Open WC script asks a series of questions and scaffolds out a project for you.

The quickest way to try out a project locally is to download one of the starter projects as a zip file.

  1. Download the starter project from GitHub as a zip file:

  2. Uncompress the zip file.

  3. Install dependencies.

Want it on GitHub? If you're familiar with git you may want to create a GitHub repository for your starter project, instead of just downloading the zip file. You can use the GitHub template repository feature to create your own repository from the JavaScript starter project or the TypeScript starter project. Then clone your new repository and install dependencies, as above.

  1. If you're using the TypeScript version of the starter, build the JavaScript version of your project:

    To watch files and rebuild when the files are modified, run the following command in a separate shell:

    No build step is required if you're using the JavaScript version of the starter project.

  2. Run the dev server:

  3. Open the project demo page in a browser tab. For example:

    http://localhost:8000/dev/

    Your server may use a different port number. Check the URL in the terminal output for the correct port number.

Edit your component definition. The file you edit depends on which language you're using:

  • JavaScript. Edit the my-element.js file in the project root.
  • TypeScript. Edit the my-element.ts file in the src directory.

A couple of things to look for in the code:

  • The code defines a class for the component (MyElement) and registers it with the browser as a custom element named <my-element>.

  • The component's render method defines a template that will be rendered as a part of the component. In this case, it includes some text, some data bindings, and a button. For more information, see Templates.

  • The component defines some properties. The component responds to changes in these properties (for example, by re-rendering the template when necessary). For more information, see Properties.

You'll probably want to change the component name from "my-element" to something more appropriate. This is easiest to do using an IDE or other text editor that lets you do a global search and replace through an entire project.

  1. If you're using the TypeScript version, remove generated files:

  2. Search and replace "my-element" with your new component name in all files in your project (except in the node_modules folder).

  3. Search and replace "MyElement" with your new class name in all files in your project (except in the node_modules folder).

  4. Rename the source and test files to match the new component name:

    JavaScript:

    • src/my-element.js
    • src/test/my-element_test.js

    TypeScript:

    • src/my-element.ts
    • src/test/my-element_test.ts
  5. If you're using the TypeScript version, rebuild the project:

  6. Test and make sure your component is still working:

Ready to add features to your component? Head over to Components to learn about building your first Lit component, or Templates for details on writing templates.

For details on running tests and using other tools, see the starter project README:

For a guide on publishing your component to npm, see Publishing.