{"id":25822919,"url":"https://github.com/stenciljs/component-starter","last_synced_at":"2025-05-14T20:10:50.398Z","repository":{"id":25313761,"uuid":"103667577","full_name":"stenciljs/component-starter","owner":"stenciljs","description":"Minimal starter project for building shareable web components with Stencil","archived":false,"fork":false,"pushed_at":"2025-02-27T18:35:53.000Z","size":677,"stargazers_count":281,"open_issues_count":7,"forks_count":128,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-23T19:05:29.775Z","etag":null,"topics":["angular","react","stenciljs","vue","webcomponents"],"latest_commit_sha":null,"homepage":"https://stenciljs.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stenciljs.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-15T14:39:47.000Z","updated_at":"2025-04-17T22:18:42.000Z","dependencies_parsed_at":"2023-02-16T07:25:16.681Z","dependency_job_id":"21c79dff-f41f-4c2e-b929-9c4113e49100","html_url":"https://github.com/stenciljs/component-starter","commit_stats":{"total_commits":129,"total_committers":34,"mean_commits":"3.7941176470588234","dds":0.7829457364341086,"last_synced_commit":"0530beb48aa4870d18b06f9ee3195e765e5918f1"},"previous_names":["stenciljs/component-starter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stenciljs%2Fcomponent-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stenciljs%2Fcomponent-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stenciljs%2Fcomponent-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stenciljs%2Fcomponent-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stenciljs","download_url":"https://codeload.github.com/stenciljs/component-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250521331,"owners_count":21444481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","react","stenciljs","vue","webcomponents"],"created_at":"2025-02-28T11:09:26.155Z","updated_at":"2025-05-14T20:10:50.379Z","avatar_url":"https://github.com/stenciljs.png","language":"TypeScript","readme":"[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D\u0026colorA=16161d\u0026style=flat-square)](https://stenciljs.com)\n\n# Stencil Component Starter\n\n\u003e This is a starter project for building a standalone Web Components using Stencil.\n\nStencil is a compiler for building fast web apps using Web Components.\n\nStencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than runtime tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements specification.\n\nStencil components are just Web Components, so they work in any major framework or with no framework at all.\n\n## Getting Started\n\nTo start building a new web component using Stencil, clone this repo to a new directory:\n\n```bash\ngit clone https://github.com/stenciljs/component-starter.git my-component\ncd my-component\ngit remote rm origin\n```\n\nand run:\n\n```bash\nnpm install\nnpm start\n```\n\nTo build the component for production, run:\n\n```bash\nnpm run build\n```\n\nTo run the unit tests for the components, run:\n\n```bash\nnpm test\n```\n\nNeed help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).\n\n## Naming Components\n\nWhen creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `\u003cstencil-datepicker\u003e`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!\n\nInstead, use a prefix that fits your company or any name for a group of related components. For example, all of the [Ionic-generated](https://ionicframework.com/) web components use the prefix `ion`.\n\n## Using this component\n\nThere are two strategies we recommend for using web components built with Stencil.\n\nThe first step for all two of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nYou can read more about these different approaches in the [Stencil docs](https://stenciljs.com/docs/publishing).\n\n### Lazy Loading\n\nIf your Stencil project is built with the [`dist`](https://stenciljs.com/docs/distribution) output target, you can import a small bootstrap script that registers all components and allows you to load individual component scripts lazily.\n\nFor example, given your Stencil project namespace is called `my-design-system`, to use `my-component` on any website, inject this into your HTML:\n\n```html\n\u003cscript type=\"module\" src=\"https://unpkg.com/my-design-system\"\u003e\u003c/script\u003e\n\u003c!--\nTo avoid unpkg.com redirects to the actual file, you can also directly import:\nhttps://unpkg.com/foobar-design-system@0.0.1/dist/foobar-design-system/foobar-design-system.esm.js\n--\u003e\n\u003cmy-component first=\"Stencil\" middle=\"'Don't call me a framework'\" last=\"JS\"\u003e\u003c/my-component\u003e\n```\n\nThis will only load the necessary scripts needed to render `\u003cmy-component /\u003e`. Once more components of this package are used, they will automatically be loaded lazily.\n\nYou can also import the script as part of your `node_modules` in your applications entry file:\n\n```tsx\nimport 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js';\n```\n\nCheck out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-y6v26a?file=src%2Fmain.tsx).\n\n### Standalone\n\nIf you are using a Stencil component library with `dist-custom-elements`, we recommend importing Stencil components individually in those files where they are needed.\n\nTo export Stencil components as standalone components make sure you have the [`dist-custom-elements`](https://stenciljs.com/docs/custom-elements) output target defined in your `stencil.config.ts`.\n\nFor example, given you'd like to use `\u003cmy-component /\u003e` as part of a React component, you can import the component directly via:\n\n```tsx\nimport 'foobar-design-system/my-component';\n\nfunction App() {\n  return (\n    \u003c\u003e\n      \u003cdiv\u003e\n        \u003cmy-component\n          first=\"Stencil\"\n          middle=\"'Don't call me a framework'\"\n          last=\"JS\"\n        \u003e\u003c/my-component\u003e\n      \u003c/div\u003e\n    \u003c/\u003e\n  );\n}\n\nexport default App;\n```\n\nCheck out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-b6zuds?file=src%2FApp.tsx).","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstenciljs%2Fcomponent-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstenciljs%2Fcomponent-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstenciljs%2Fcomponent-starter/lists"}