-
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.
run: npm init stencil component my-lib
- Loading branch information
0 parents
commit 6d1e236
Showing
18 changed files
with
454 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# http://editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
insert_final_newline = false | ||
trim_trailing_whitespace = false |
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
dist/ | ||
www/ | ||
loader/ | ||
|
||
*~ | ||
*.sw[mnpcod] | ||
*.log | ||
*.lock | ||
*.tmp | ||
*.tmp.* | ||
log.txt | ||
*.sublime-project | ||
*.sublime-workspace | ||
|
||
.stencil/ | ||
.idea/ | ||
.vscode/ | ||
.sass-cache/ | ||
.versions/ | ||
node_modules/ | ||
$RECYCLE.BIN/ | ||
|
||
.DS_Store | ||
Thumbs.db | ||
UserInterfaceState.xcuserstate | ||
.env |
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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"arrowParens": "avoid", | ||
"bracketSpacing": true, | ||
"jsxBracketSameLine": false, | ||
"jsxSingleQuote": false, | ||
"quoteProps": "consistent", | ||
"printWidth": 180, | ||
"semi": true, | ||
"singleQuote": true, | ||
"tabWidth": 2, | ||
"trailingComma": "all", | ||
"useTabs": false | ||
} |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2018 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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 |
---|---|---|
@@ -0,0 +1,38 @@ | ||
{ | ||
"name": "my-lib", | ||
"version": "0.0.1", | ||
"description": "Stencil Component Starter", | ||
"main": "dist/index.cjs.js", | ||
"module": "dist/index.js", | ||
"es2015": "dist/esm/index.mjs", | ||
"es2017": "dist/esm/index.mjs", | ||
"types": "dist/types/index.d.ts", | ||
"collection": "dist/collection/collection-manifest.json", | ||
"collection:main": "dist/collection/index.js", | ||
"unpkg": "dist/my-lib/my-lib.esm.js", | ||
"repository": { | ||
"type": "git", | ||
"url": "/~https://github.com/ionic-team/stencil-component-starter.git" | ||
}, | ||
"files": [ | ||
"dist/", | ||
"loader/" | ||
], | ||
"scripts": { | ||
"build": "stencil build --docs", | ||
"start": "stencil build --dev --watch --serve", | ||
"test": "stencil test --spec --e2e", | ||
"test.watch": "stencil test --spec --e2e --watchAll", | ||
"generate": "stencil generate" | ||
}, | ||
"dependencies": { | ||
"@stencil/core": "^2.13.0" | ||
}, | ||
"devDependencies": { | ||
"@types/jest": "^27.0.3", | ||
"jest": "^27.4.5", | ||
"jest-cli": "^27.4.5", | ||
"puppeteer": "^10.0.0" | ||
}, | ||
"license": "MIT" | ||
} |
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 |
---|---|---|
@@ -0,0 +1,75 @@ | ||
 | ||
|
||
# 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](/~https://github.com/ionic-team/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: | ||
|
||
```bash | ||
git clone /~https://github.com/ionic-team/stencil-component-starter.git my-component | ||
cd my-component | ||
git remote rm origin | ||
``` | ||
|
||
and run: | ||
|
||
```bash | ||
npm install | ||
npm start | ||
``` | ||
|
||
To build the component for production, run: | ||
|
||
```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 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](https://docs.npmjs.com/getting-started/publishing-npm-packages). | ||
|
||
### Script tag | ||
|
||
- Put a script tag similar to this `<script type='module' 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 type='module' 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 |
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 |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* eslint-disable */ | ||
/* tslint:disable */ | ||
/** | ||
* This is an autogenerated file created by the Stencil compiler. | ||
* It contains typing information for all components that exist in this project. | ||
*/ | ||
import { HTMLStencilElement, JSXBase } from "@stencil/core/internal"; | ||
export namespace Components { | ||
interface MyComponent { | ||
/** | ||
* The first name | ||
*/ | ||
"first": string; | ||
/** | ||
* The last name | ||
*/ | ||
"last": string; | ||
/** | ||
* The middle name | ||
*/ | ||
"middle": string; | ||
} | ||
} | ||
declare global { | ||
interface HTMLMyComponentElement extends Components.MyComponent, HTMLStencilElement { | ||
} | ||
var HTMLMyComponentElement: { | ||
prototype: HTMLMyComponentElement; | ||
new (): HTMLMyComponentElement; | ||
}; | ||
interface HTMLElementTagNameMap { | ||
"my-component": HTMLMyComponentElement; | ||
} | ||
} | ||
declare namespace LocalJSX { | ||
interface MyComponent { | ||
/** | ||
* The first name | ||
*/ | ||
"first"?: string; | ||
/** | ||
* The last name | ||
*/ | ||
"last"?: string; | ||
/** | ||
* The middle name | ||
*/ | ||
"middle"?: string; | ||
} | ||
interface IntrinsicElements { | ||
"my-component": MyComponent; | ||
} | ||
} | ||
export { LocalJSX as JSX }; | ||
declare module "@stencil/core" { | ||
export namespace JSX { | ||
interface IntrinsicElements { | ||
"my-component": LocalJSX.MyComponent & JSXBase.HTMLAttributes<HTMLMyComponentElement>; | ||
} | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
:host { | ||
display: block; | ||
} |
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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
import { newE2EPage } from '@stencil/core/testing'; | ||
|
||
describe('my-component', () => { | ||
it('renders', async () => { | ||
const page = await newE2EPage(); | ||
|
||
await page.setContent('<my-component></my-component>'); | ||
const element = await page.find('my-component'); | ||
expect(element).toHaveClass('hydrated'); | ||
}); | ||
|
||
it('renders changes to the name data', async () => { | ||
const page = await newE2EPage(); | ||
|
||
await page.setContent('<my-component></my-component>'); | ||
const component = await page.find('my-component'); | ||
const element = await page.find('my-component >>> div'); | ||
expect(element.textContent).toEqual(`Hello, World! I'm `); | ||
|
||
component.setProperty('first', 'James'); | ||
await page.waitForChanges(); | ||
expect(element.textContent).toEqual(`Hello, World! I'm James`); | ||
|
||
component.setProperty('last', 'Quincy'); | ||
await page.waitForChanges(); | ||
expect(element.textContent).toEqual(`Hello, World! I'm James Quincy`); | ||
|
||
component.setProperty('middle', 'Earl'); | ||
await page.waitForChanges(); | ||
expect(element.textContent).toEqual(`Hello, World! I'm James Earl Quincy`); | ||
}); | ||
}); |
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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
import { newSpecPage } from '@stencil/core/testing'; | ||
import { MyComponent } from './my-component'; | ||
|
||
describe('my-component', () => { | ||
it('renders', async () => { | ||
const { root } = await newSpecPage({ | ||
components: [MyComponent], | ||
html: '<my-component></my-component>', | ||
}); | ||
expect(root).toEqualHtml(` | ||
<my-component> | ||
<mock:shadow-root> | ||
<div> | ||
Hello, World! I'm | ||
</div> | ||
</mock:shadow-root> | ||
</my-component> | ||
`); | ||
}); | ||
|
||
it('renders with values', async () => { | ||
const { root } = await newSpecPage({ | ||
components: [MyComponent], | ||
html: `<my-component first="Stencil" last="'Don't call me a framework' JS"></my-component>`, | ||
}); | ||
expect(root).toEqualHtml(` | ||
<my-component first="Stencil" last="'Don't call me a framework' JS"> | ||
<mock:shadow-root> | ||
<div> | ||
Hello, World! I'm Stencil 'Don't call me a framework' JS | ||
</div> | ||
</mock:shadow-root> | ||
</my-component> | ||
`); | ||
}); | ||
}); |
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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
import { Component, Prop, h } from '@stencil/core'; | ||
import { format } from '../../utils/utils'; | ||
|
||
@Component({ | ||
tag: 'my-component', | ||
styleUrl: 'my-component.css', | ||
shadow: true, | ||
}) | ||
export class MyComponent { | ||
/** | ||
* The first name | ||
*/ | ||
@Prop() first: string; | ||
|
||
/** | ||
* The middle name | ||
*/ | ||
@Prop() middle: string; | ||
|
||
/** | ||
* The last name | ||
*/ | ||
@Prop() last: string; | ||
|
||
private getText(): string { | ||
return format(this.first, this.middle, this.last); | ||
} | ||
|
||
render() { | ||
return <div>Hello, World! I'm {this.getText()}</div>; | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# my-component | ||
|
||
|
||
|
||
<!-- Auto Generated Below --> | ||
|
||
|
||
## Properties | ||
|
||
| Property | Attribute | Description | Type | Default | | ||
| -------- | --------- | --------------- | -------- | ----------- | | ||
| `first` | `first` | The first name | `string` | `undefined` | | ||
| `last` | `last` | The last name | `string` | `undefined` | | ||
| `middle` | `middle` | The middle name | `string` | `undefined` | | ||
|
||
|
||
---------------------------------------------- | ||
|
||
*Built with [StencilJS](https://stenciljs.com/)* |
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 |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<!DOCTYPE html> | ||
<html dir="ltr" lang="en"> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=5.0" /> | ||
<title>Stencil Component Starter</title> | ||
|
||
<script type="module" src="/build/my-lib.esm.js"></script> | ||
<script nomodule src="/build/my-lib.js"></script> | ||
</head> | ||
<body> | ||
<my-component first="Stencil" last="'Don't call me a framework' JS"></my-component> | ||
</body> | ||
</html> |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
export * from './components'; |
Oops, something went wrong.