052hide-stencil-wc 中文文档教程
Stencil Component Starter
This is a starter project for building a standalone Web Component using Stencil.
Stencil 也非常适合构建整个应用程序。 为此，请改用 stencil-app-starter。
Stencil
Stencil 是一个使用 Web Components 构建快速 Web 应用程序的编译器。
Stencil 将最流行的前端框架的最佳概念结合到编译时而非运行时工具中。 Stencil 采用 TypeScript、JSX、微型虚拟 DOM 层、高效的单向数据绑定、异步渲染管道（类似于 React Fiber）和开箱即用的延迟加载，并生成 100% 基于标准的 Web 组件，这些组件可以运行在任何支持自定义元素 v1 规范的浏览器中。
Stencil 组件只是 Web 组件，因此它们可以在任何主要框架或根本没有框架的情况下工作。
Getting Started
要开始使用 Stencil 构建新的 Web 组件，请将此 repo 克隆到新目录：
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
并运行：
npm install
npm start
要构建用于生产的组件，请运行：
npm run build
要为组件运行单元测试，请运行：
npm test
需要帮助吗？ 在此处查看我们的文档。
Naming Components
创建新的组件标签时，我们建议不要在组件名称中使用stencil（例如：
相反，使用适合您公司的前缀或一组相关组件的任何名称。 例如，所有 Ionic 生成的 Web 组件都使用前缀 ion。
Using this component
对于使用 Stencil 构建的 Web 组件，我们推荐三种策略。
所有这三种策略的第一步都是发布到 NPM。
Script tag
- Put a script tag similar to this
<script src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
Node Modules
- Run
npm install my-component --save - Put a script tag similar to this
<script src='node_modules/my-component/dist/my-component.esm.js'></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
In a stencil-starter app
- Run
npm install my-component --save - Add an import to the npm packages
import my-component; - Then you can use the element anywhere in your template, JSX, html etc
Stencil Component Starter
This is a starter project for building a standalone Web Component using Stencil.
Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.
Stencil
Stencil is a compiler for building fast web apps using Web Components.
Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time 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.
Stencil components are just Web Components, so they work in any major framework or with no framework at all.
Getting Started
To start building a new web component using Stencil, clone this repo to a new directory:
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
cd my-component
git remote rm origin
and run:
npm install
npm start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need help? Check out our docs here.
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 three strategies we recommend for using web components built with Stencil.
The first step for all three of these strategies is to publish to NPM.
Script tag
- Put a script tag similar to this
<script src='https://unpkg.com/my-component@0.0.1/dist/my-component.esm.js'></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
Node Modules
- Run
npm install my-component --save - Put a script tag similar to this
<script src='node_modules/my-component/dist/my-component.esm.js'></script>in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
In a stencil-starter app
- Run
npm install my-component --save - Add an import to the npm packages
import my-component; - Then you can use the element anywhere in your template, JSX, html etc
