q2-tecton-elements 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +13 -0
- package/package.json +67 -0
- package/readme.md +72 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
Copyright 2019 Q2 Holdings Inc.
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
package/package.json
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "q2-tecton-elements",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Q2 Tecton Custom Elements",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Q2 Tecton Team",
|
|
7
|
+
"main": "dist/index.js",
|
|
8
|
+
"module": "dist/index.mjs",
|
|
9
|
+
"types": "dist/types/components.d.ts",
|
|
10
|
+
"collection": "dist/collection/collection-manifest.json",
|
|
11
|
+
"collection:main": "dist/collection/index.js",
|
|
12
|
+
"files": [
|
|
13
|
+
"dist/"
|
|
14
|
+
],
|
|
15
|
+
"publishConfig": {
|
|
16
|
+
"access": "public"
|
|
17
|
+
},
|
|
18
|
+
"scripts": {
|
|
19
|
+
"build": "stencil build --debug && node ../../build/create-theme-files.js",
|
|
20
|
+
"build:dev": "stencil build --debug && node ../../build/create-theme-files.js",
|
|
21
|
+
"build:docs-json": "stencil build --docs-json dist/docs.json",
|
|
22
|
+
"build:elements": "stencil build",
|
|
23
|
+
"build:local": "stencil build --dev --watch --serve",
|
|
24
|
+
"build:network": "stencil build --dev --watch --serve --host 0.0.0.0",
|
|
25
|
+
"build:prerelease": "stencil build --debug && node ../../build/create-theme-files.js",
|
|
26
|
+
"build:prod": "stencil build --debug && node ../../build/create-theme-files.js",
|
|
27
|
+
"clean": "rm -rf dist tmp",
|
|
28
|
+
"lint": "cross-env ESLINT_USE_FLAT_CONFIG=false eslint --config .cli-eslintrc.js --ext .ts,.tsx --ignore-path .gitignore .",
|
|
29
|
+
"lint:fix": "cross-env ESLINT_USE_FLAT_CONFIG=false eslint --fix --config .cli-eslintrc.js --ext .ts,.tsx --ignore-path .gitignore .",
|
|
30
|
+
"problems": "tsc --noEmit",
|
|
31
|
+
"style": "node scripts/runApplyStyleGuide.js",
|
|
32
|
+
"style:fix": "node scripts/runApplyStyleGuide.js --fix",
|
|
33
|
+
"test:new": "stencil test --spec --e2e --silent --maxWorkers=0 --runInBand -- --json --outputFile=./test-reports-band-1.json",
|
|
34
|
+
"test": "stencil test --spec --e2e --silent --maxWorkers=0 --runInBand",
|
|
35
|
+
"test:accessibility-report": "stencil test --e2e --silent --maxWorkers=0 --runInBand --testNamePattern=ridiculousonpurpose -- --json --outputFile=../docs/src/data/accessibility-report.json",
|
|
36
|
+
"test:ci": "stencil test --spec --e2e --silent --maxWorkers=0 --runInBand",
|
|
37
|
+
"test:dev": "stencil test --spec --e2e --maxWorkers=0 --runInBand --watchAll"
|
|
38
|
+
},
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"@stencil/core": "~4.32.0",
|
|
41
|
+
"q2-tecton-common": "0.0.0",
|
|
42
|
+
"swiper": "8.4.4"
|
|
43
|
+
},
|
|
44
|
+
"devDependencies": {
|
|
45
|
+
"@stencil-community/eslint-plugin": "^0.8.0",
|
|
46
|
+
"@stencil/react-output-target": "^0.5.3",
|
|
47
|
+
"@stencil/sass": "3.0.12",
|
|
48
|
+
"@stencil/vue-output-target": "^0.8.8",
|
|
49
|
+
"@types/eslint__js": "^8.42.3",
|
|
50
|
+
"@types/jest": "^29.5.12",
|
|
51
|
+
"@typescript-eslint/eslint-plugin": "^7.11.0",
|
|
52
|
+
"@typescript-eslint/parser": "^7.11.0",
|
|
53
|
+
"axe-core": "^4.10.3",
|
|
54
|
+
"cross-env": "^7.0.3",
|
|
55
|
+
"date-fns": "^3.6.0",
|
|
56
|
+
"dompurify": "^3.2.4",
|
|
57
|
+
"echarts": "^5.5.1",
|
|
58
|
+
"fast-glob": "^3.3.2",
|
|
59
|
+
"jest-cli": "^29.7.0",
|
|
60
|
+
"jscodeshift": "^17.0.0",
|
|
61
|
+
"minimist": "^1.2.8",
|
|
62
|
+
"puppeteer": "^24.11.1",
|
|
63
|
+
"typescript": "5.4.5",
|
|
64
|
+
"typescript-eslint": "^7.11.0"
|
|
65
|
+
},
|
|
66
|
+
"gitHead": "f6c64cdede85db56db2e88965b5e808ffecb8c05"
|
|
67
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# Stencil Component Starter
|
|
4
|
+
|
|
5
|
+
This is a starter project for building a standalone Web Component using Stencil.
|
|
6
|
+
|
|
7
|
+
Stencil is also great for building entire apps. For that, use the [stencil-app-starter](https://github.com/ionic-team/stencil-app-starter) instead.
|
|
8
|
+
|
|
9
|
+
# Stencil
|
|
10
|
+
|
|
11
|
+
Stencil is a compiler for building fast web apps using Web Components.
|
|
12
|
+
|
|
13
|
+
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.
|
|
14
|
+
|
|
15
|
+
Stencil components are just Web Components, so they work in any major framework or with no framework at all.
|
|
16
|
+
|
|
17
|
+
## Getting Started
|
|
18
|
+
|
|
19
|
+
To start building a new web component using Stencil, clone this repo to a new directory:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/ionic-team/stencil-component-starter.git my-component
|
|
23
|
+
cd my-component
|
|
24
|
+
git remote rm origin
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
and run:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npm install
|
|
31
|
+
npm start
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
To build the component for production, run:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npm run build
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
To run the unit tests for the components, run:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm test
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## Naming Components
|
|
50
|
+
|
|
51
|
+
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!
|
|
52
|
+
|
|
53
|
+
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`.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## Using this component
|
|
57
|
+
|
|
58
|
+
### Script tag
|
|
59
|
+
|
|
60
|
+
- [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages)
|
|
61
|
+
- Put a script tag similar to this `<script src='https://unpkg.com/my-component@0.0.1/dist/mycomponent.js'></script>` in the head of your index.html
|
|
62
|
+
- Then you can use the element anywhere in your template, JSX, html etc
|
|
63
|
+
|
|
64
|
+
### Node Modules
|
|
65
|
+
- Run `npm install my-component --save`
|
|
66
|
+
- Put a script tag similar to this `<script src='node_modules/my-component/dist/mycomponent.js'></script>` in the head of your index.html
|
|
67
|
+
- Then you can use the element anywhere in your template, JSX, html etc
|
|
68
|
+
|
|
69
|
+
### In a stencil-starter app
|
|
70
|
+
- Run `npm install my-component --save`
|
|
71
|
+
- Add an import to the npm packages `import my-component;`
|
|
72
|
+
- Then you can use the element anywhere in your template, JSX, html etc
|