Gathering detailed insights and metrics for src-uikit-components
Installations
npm install src-uikit-componentsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
16.16.0
NPM Version
lerna/6.1.0/node@v16.16.0+arm64 (darwin)
Score
11.2
Supply Chain
25
Quality
65.6
Maintenance
50
Vulnerability
91.1
License
Releases
Unable to fetch releases
Contributors
1
Love this project? Help keep it running — sponsor us today! 🚀
Download Statistics
Total Downloads
28,813
Last Day
1
Last Week
15
Last Month
539
Last Year
4,196
Bundle Size
144.00 B
Minified
128.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
3.2.79
Package Id
src-uikit-components@3.2.79
Unpacked Size
7.80 kB
Size
3.58 kB
File Count
6
NPM Version
lerna/6.1.0/node@v16.16.0+arm64 (darwin)
Node Version
16.16.0
Published on
Apr 04, 2023
Total Downloads
Cumulative downloads
Total Downloads
28,813
Last Day
-91.7%
1
Compared to previous day
Last Week
-83.9%
15
Compared to previous week
Last Month
60.9%
539
Compared to previous month
Last Year
-82.8%
4,196
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
LitElement TypeScript starter
This project includes a sample component using LitElement with TypeScript.
This template is generated from the lit-starter-ts package in the main Lit
repo. Issues and PRs for this template should be
filed in that repo.
Setup
Install dependencies:
1npm i
Build
This sample uses the TypeScript compiler to produce JavaScript that runs in modern browsers.
To build the JavaScript version of your component:
1npm run build
To watch files and rebuild when the files are modified, run the following command in a separate shell:
1npm run build:watch
Both the TypeScript compiler and lit-analyzer are configured to be very strict. You may want to change tsconfig.json to make them less strict.
Testing
This sample uses modern-web.dev's @web/test-runner for testing. See the modern-web.dev testing documentation for more information.
Tests can be run with the test script, which will run your tests against Lit's development mode (with more verbose errors) as well as against Lit's production mode:
1npm test
For local testing during development, the test:dev:watch command will run your tests in Lit's development mode (with verbose errors) on every change to your source files:
1npm test:watch
Alternatively the test:prod and test:prod:watch commands will run your tests in Lit's production mode.
Dev Server
This sample uses modern-web.dev's @web/dev-server for previewing the project without additional build steps. Web Dev Server handles resolving Node-style "bare" import specifiers, which aren't supported in browsers. It also automatically transpiles JavaScript and adds polyfills to support older browsers. See modern-web.dev's Web Dev Server documentation for more information.
To run the dev server and open the project in a new browser tab:
1npm run serve
There is a development HTML file located at /dev/index.html that you can view at http://localhost:8000/dev/index.html. Note that this command will serve your code using Lit's development mode (with more verbose errors). To serve your code against Lit's production mode, use npm run serve:prod.
Editing
If you use VS Code, we highly recommend the lit-plugin extension, which enables some extremely useful features for lit-html templates:
- Syntax highlighting
- Type-checking
- Code completion
- Hover-over docs
- Jump to definition
- Linting
- Quick Fixes
The project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.
Linting
Linting of TypeScript files is provided by ESLint and TypeScript ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.
The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing .eslintrc.json and tsconfig.json.
To lint the project run:
1npm run lint
Formatting
Prettier is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in .prettierrc.json.
Prettier has not been configured to run when committing files, but this can be added with Husky and and pretty-quick. See the prettier.io site for instructions.
Static Site
This project includes a simple website generated with the eleventy static site generator and the templates and pages in /docs-src. The site is generated to /docs and intended to be checked in so that GitHub pages can serve the site from /docs on the master branch.
To enable the site go to the GitHub settings and change the GitHub Pages "Source" setting to "master branch /docs folder".
To build the site, run:
1npm run docs
To serve the site locally, run:
1npm run docs:serve
To watch the site files, and re-build automatically, run:
1npm run docs:watch
The site will usually be served at http://localhost:8000.
Bundling and minification
This starter project doesn't include any build-time optimizations like bundling or minification. We recommend publishing components as unoptimized JavaScript modules, and performing build-time optimizations at the application level. This gives build tools the best chance to deduplicate code, remove dead code, and so on.
For information on building application projects that include LitElement components, see Build for production on the Lit site.
More information
See Get started on the Lit site for more information.
No vulnerabilities found.
No security vulnerabilities found.