-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update contributing.md with clearer reasons for commands we're running
- Loading branch information
1 parent
e655740
commit a4d4a0d
Showing
3 changed files
with
22 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,37 @@ | ||
| [](https://stenciljs.com) | ||
|
|
||
| # Stencil Component Starter | ||
| # `@stencil-community/web-types-output-target` Example Project | ||
|
|
||
| This is a starter project for building a standalone Web Component using Stencil. | ||
| This project demonstrates the usage of the `@stencil-community/web-types-output-target` output target. | ||
|
|
||
| Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead. | ||
| ## Set Up | ||
|
|
||
| # Stencil | ||
| To set up this project, you may either first build the output target from source, or override this project's dependency on `@stencil-community/web-types-output-target` with a version published to the NPM registry. | ||
| Both allow you to take the output target for a 'test drive' - the only difference is the former allows you to tweak the output target's source code and see how it affects the example project. | ||
|
|
||
| Stencil is a compiler for building fast web apps using Web Components. | ||
| After setting up the dependencies, continue to the next section. | ||
|
|
||
| Stencil 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 v1 spec. | ||
| ### Building from Source | ||
|
|
||
| Stencil components are just Web Components, so they work in any major framework or with no framework at all. | ||
| See the [instructions in the CONTRIBUTING guide](https://github.com/stencil-community/stencil-web-types/blob/main/CONTRIBUTING.md#setup) to build from source. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To start building a new web component using Stencil, clone this repo to a new directory: | ||
| ### Overriding the Local Dependency | ||
|
|
||
| If you don't want to build the output target from source, run the following from this directory to install it from the NPM registry: | ||
| ```bash | ||
| git clone https://github.com/ionic-team/stencil-component-starter.git my-component | ||
| cd my-component | ||
| git remote rm origin | ||
| $ npm uninstall @stencil-community/web-types-output-target | ||
| $ npm install --save-dev @stencil-community/web-types-output-target | ||
| ``` | ||
|
|
||
| and run: | ||
| ## Inspecting Types | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm start | ||
| ``` | ||
|
|
||
| To build the component for production, run: | ||
| To inspect the types of the components in this project, one must first build the project. | ||
| This generates a `web-types.json` file, which JetBrains IDEs use to pick up metadata about the project's components. | ||
| To build the project, run the following from this directory: | ||
|
|
||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| To run the unit tests for the components, run: | ||
|
|
||
| ```bash | ||
| npm test | ||
| ``` | ||
|
|
||
| Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component). | ||
|
|
||
| ## Naming Components | ||
|
|
||
| When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component! | ||
|
|
||
| Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic-generated web components use the prefix `ion`. | ||
|
|
||
| ## Using this component | ||
|
|
||
| There are two strategies we recommend for using web components built with Stencil. | ||
|
|
||
| The first step for all two of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages). | ||
|
|
||
| You can read more about these different approaches in the [Stencil docs](https://stenciljs.com/docs/publishing). | ||
|
|
||
| ### Lazy Loading | ||
|
|
||
| If 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. | ||
|
|
||
| For example, given your Stencil project namespace is called `my-design-system`, to use `my-component` on any website, inject this into your HTML: | ||
|
|
||
| ```html | ||
| <script type="module" src="https://unpkg.com/my-design-system"></script> | ||
| <!-- | ||
| To avoid unpkg.com redirects to the actual file, you can also directly import: | ||
| https://unpkg.com/[email protected]/dist/foobar-design-system/foobar-design-system.esm.js | ||
| --> | ||
| <my-component first="Stencil" last="'Don't call me a framework' JS"></my-component> | ||
| ``` | ||
|
|
||
| This will only load the necessary scripts needed to render `<my-component />`. Once more components of this package are used, they will automatically be loaded lazily. | ||
|
|
||
| You can also import the script as part of your `node_modules` in your applications entry file: | ||
|
|
||
| ```tsx | ||
| import 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js'; | ||
| ``` | ||
|
|
||
| Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-y6v26a?file=src%2Fmain.tsx). | ||
|
|
||
| ### Standalone | ||
|
|
||
| If you are using a Stencil component library with `dist-custom-elements`, we recommend importing Stencil components individually in those files where they are needed. | ||
|
|
||
| To 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`. | ||
|
|
||
| For example, given you'd like to use `<my-component />` as part of a React component, you can import the component directly via: | ||
|
|
||
| ```tsx | ||
| import 'foobar-design-system/my-component'; | ||
|
|
||
| function App() { | ||
| return ( | ||
| <> | ||
| <div> | ||
| <my-component | ||
| first="Stencil" | ||
| last="'Don't call me a framework' JS" | ||
| ></my-component> | ||
| </div> | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| export default App; | ||
| $ npm run build | ||
| ``` | ||
|
|
||
| Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-b6zuds?file=src%2FApp.tsx). | ||
| Upon build, open the [example index.html file](./src/index.html) in your JetBrains IDE. | ||
| Hover over components to see how JSDoc descriptions, deprecation tags, default and required values, etc. are now populated in the editor. |