You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thanks for your interest in contributing to Stencil! :tada: We've moved the [Contributing Guidelines](https://github.com/ionic-team/stencil/blob/main/CONTRIBUTING.md) to the root of the project. :pray:
3
+
Thanks for your interest in contributing to Stencil! :tada: We've moved the [Contributing Guidelines](https://github.com/stenciljs/core/blob/main/CONTRIBUTING.md) to the root of the project. :pray:
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature_request.yml
+3-3
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ body:
7
7
label: Prerequisites
8
8
description: Please ensure you have completed all of the following.
9
9
options:
10
-
- label: I have read the [Contributing Guidelines](https://github.com/ionic-team/stencil/blob/main/CONTRIBUTING.md).
10
+
- label: I have read the [Contributing Guidelines](https://github.com/stenciljs/core/blob/main/CONTRIBUTING.md).
11
11
required: true
12
-
- label: I agree to follow the [Code of Conduct](https://github.com/ionic-team/stencil/blob/main/CODE_OF_CONDUCT.md).
12
+
- label: I agree to follow the [Code of Conduct](https://github.com/stenciljs/core/blob/main/CODE_OF_CONDUCT.md).
13
13
required: true
14
-
- label: I have searched for [existing issues](https://github.com/ionic-team/stencil/issues) that already include this feature request, without success.
14
+
- label: I have searched for [existing issues](https://github.com/stenciljs/core/issues) that already include this feature request, without success.
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
<!-- Please refer to our contributing documentation for any questions on submitting a pull request, or let us know here if you need any help: https://github.com/ionic-team/stencil/blob/main/CONTRIBUTING.md -->
1
+
<!-- Please refer to our contributing documentation for any questions on submitting a pull request, or let us know here if you need any help: https://github.com/stenciljs/core/blob/main/CONTRIBUTING.md -->
Copy file name to clipboardExpand all lines: BREAKING_CHANGES.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ In the example above, `"@utils"` would be mapped to the string `"src/utils/index
42
42
The TypeScript compiler does not however, transform these paths from their keys to their values as a part of its output.
43
43
Instead, it relies on a bundler/loader to do the transformation.
44
44
45
-
The ability to transform path aliases was introduced in [Stencil v3.1.0](https://github.com/ionic-team/stencil/releases/tag/v3.1.0) as an opt-in feature.
45
+
The ability to transform path aliases was introduced in [Stencil v3.1.0](https://github.com/stenciljs/core/releases/tag/v3.1.0) as an opt-in feature.
46
46
Previously, users had to explicitly enable this functionality in their `stencil.config.ts` file with `transformAliasedImportPaths`:
47
47
```ts title="stencil.config.ts - enabling 'transformAliasedImportPaths' in Stencil v3.1.0"
48
48
import { Config } from'@stencil/core';
@@ -56,7 +56,7 @@ export const config: Config = {
56
56
Starting with Stencil v4.0.0, this feature is enabled by default.
57
57
Projects that had previously enabled this functionality that are migrating from Stencil v3.1.0+ may safely remove the flag from their Stencil configuration file(s).
58
58
59
-
For users that run into issues with this new default, we encourage you to file a [new issue on the Stencil GitHub repo](https://github.com/ionic-team/stencil/issues/new?assignees=&labels=&projects=&template=bug_report.yml&title=bug%3A+).
59
+
For users that run into issues with this new default, we encourage you to file a [new issue on the Stencil GitHub repo](https://github.com/stenciljs/core/issues/new?assignees=&labels=&projects=&template=bug_report.yml&title=bug%3A+).
60
60
As a workaround, this flag can be set to `false` to disable the default functionality.
61
61
```ts title="stencil.config.ts - disabling 'transformAliasedImportPaths' in Stencil v4.0.0"
62
62
import { Config } from'@stencil/core';
@@ -71,14 +71,14 @@ For more information on this flag, please see the [configuration documentation](
71
71
72
72
#### `transformAliasedImportPathsInCollection`
73
73
74
-
Introduced in [Stencil v2.18.0](https://github.com/ionic-team/stencil/releases/tag/v2.18.0), `transformAliasedImportPathsInCollection` is a configuration flag on the [`dist` output target](https://stenciljs.com/docs/distribution#transformaliasedimportpathsincollection).
74
+
Introduced in [Stencil v2.18.0](https://github.com/stenciljs/core/releases/tag/v2.18.0), `transformAliasedImportPathsInCollection` is a configuration flag on the [`dist` output target](https://stenciljs.com/docs/distribution#transformaliasedimportpathsincollection).
75
75
`transformAliasedImportPathsInCollection` transforms import paths, similar to [`transformAliasedImportPaths`](#transformaliasedimportpaths).
76
76
This flag however, only enables the functionality of `transformAliasedImportPaths` for collection output targets.
77
77
78
78
Starting with Stencil v4.0.0, this flag is enabled by default.
79
79
Projects that had previously enabled this functionality that are migrating from Stencil v2.18.0+ may safely remove the flag from their Stencil configuration file(s).
80
80
81
-
For users that run into issues with this new default, we encourage you to file a [new issue on the Stencil GitHub repo](https://github.com/ionic-team/stencil/issues/new?assignees=&labels=&projects=&template=bug_report.yml&title=bug%3A+).
81
+
For users that run into issues with this new default, we encourage you to file a [new issue on the Stencil GitHub repo](https://github.com/stenciljs/core/issues/new?assignees=&labels=&projects=&template=bug_report.yml&title=bug%3A+).
82
82
As a workaround, this flag can be set to `false` to disable the default functionality.
83
83
```ts title="stencil.config.ts - disabling 'transformAliasedImportPathsInCollection' in Stencil v4.0.0"
84
84
import { Config } from'@stencil/core';
@@ -102,7 +102,7 @@ For more information on this flag, please see the [`dist` output target's docume
102
102
Prior to Stencil v4.0.0, components could be compiled from TSX to JS in the browser.
103
103
This feature was seldom used, and has been removed from Stencil.
104
104
At this time, there is no replacement functionality.
105
-
For additional details, please see the [request-for-comment](https://github.com/ionic-team/stencil/discussions/4134) on the Stencil GitHub Discussions page.
105
+
For additional details, please see the [request-for-comment](https://github.com/stenciljs/core/discussions/4134) on the Stencil GitHub Discussions page.
106
106
107
107
### Legacy Context and Connect APIs Removed
108
108
@@ -532,7 +532,7 @@ The `inlineDynamicImports` configuration option on `dist-custom-elements` has be
532
532
time during the Rollup bundling process if the build contained multiple "inputs" (components).
533
533
534
534
#### `dist-custom-elements-bundle` Output Target
535
-
The `dist-custom-elements-bundle` has been removed starting with Stencil v3.0.0, following the [RFC process](https://github.com/ionic-team/stencil/issues/3136).
535
+
The `dist-custom-elements-bundle` has been removed starting with Stencil v3.0.0, following the [RFC process](https://github.com/stenciljs/core/issues/3136).
536
536
Users of this output target should migrate to the `dist-custom-elements` output target.
537
537
538
538
By default, `dist-custom-elements` does not automatically define all a project's component's with the `CustomElementsRegistry`.
@@ -562,7 +562,7 @@ However, it does not necessarily improve treeshaking/bundle size.
562
562
For more information on configuring this output target, please see the [`dist-custom-elements` documentation](https://stenciljs.com/docs/custom-elements)
563
563
564
564
### Legacy Angular Output Target
565
-
Prior to the creation of the [`@stencil/angular-output-target`](https://github.com/ionic-team/stencil-ds-output-targets/blob/main/packages/angular-output-target/README.md), the `'angular'` output target was the original means of connecting a Stencil component to an Angular application.
565
+
Prior to the creation of the [`@stencil/angular-output-target`](https://github.com/stenciljs/core-ds-output-targets/blob/main/packages/angular-output-target/README.md), the `'angular'` output target was the original means of connecting a Stencil component to an Angular application.
566
566
This output target has been removed in favor of `@stencil/angular-output-target`.
567
567
Please migrate to `@stencil/angular-output-target` and remove the `'angular'` output target from your `stencil.config.ts` file.
568
568
Instructions for doing so can be found [on the Stencil site](https://stenciljs.com/docs/angular#setup)
@@ -614,27 +614,27 @@ While migrating from Stencil One, any changes will be flagged and described by t
614
614
615
615
#### Opt-in for IE11, Edge 16-18 and Safari 10 Builds
616
616
617
-
-**config:** update config extra defaults to not build IE11, Edge 16-18 and Safari 10 by default ([363bf59](https://github.com/ionic-team/stencil/commit/363bf59fc9212a771a766c21909263d6c4ccdf18))
617
+
-**config:** update config extra defaults to not build IE11, Edge 16-18 and Safari 10 by default ([363bf59](https://github.com/stenciljs/core/commit/363bf59fc9212a771a766c21909263d6c4ccdf18))
618
618
619
619
A change in Stencil 2 is that the IE11, Edge 16-18 and Safari 10 builds will not be enabled by default. However, the ability to opt-in is still available, and can be enabled by setting each `extras` config flag to `true`. An advantage of this is less runtime within your builds. See the [config.extras docs](https://stenciljs.com/docs/config-extras) for more info.
620
620
621
621
#### Opt-in for ES5 and SystemJS Builds
622
622
623
-
-**config:** do not build es5 by default ([fa67d97](https://github.com/ionic-team/stencil/commit/fa67d97d043d12e0a3af0d868fa1746eb9e3badf))
623
+
-**config:** do not build es5 by default ([fa67d97](https://github.com/stenciljs/core/commit/fa67d97d043d12e0a3af0d868fa1746eb9e3badf))
624
624
625
625
Just like having to opt-in for IE11, the same goes for opting-in for ES5 and SystemJS builds. For a production build in Stencil 1, it would build both ES2017/ESM files, and ES5/SystemJS files. As of Stencil 2, both dev and prod builds do not create ES5/SystemJS builds. An advantage of this is having faster production builds by not having to also downlevel to es5. See the [buildEs5](https://stenciljs.com/docs/config#buildes5) for more info.
626
626
627
627
#### Use `disconnectedCallback()` instead of `componentDidUnload()`
628
628
629
-
-**componentDidUnload:** use disconnectedCallback instead of componentDidUnload ([4e45862](https://github.com/ionic-team/stencil/commit/4e45862f73609599a7195fcf5c93d9fb39492154))
629
+
-**componentDidUnload:** use disconnectedCallback instead of componentDidUnload ([4e45862](https://github.com/stenciljs/core/commit/4e45862f73609599a7195fcf5c93d9fb39492154))
630
630
631
631
When Stencil is used within other frameworks, DOM elements may be reused, making it impossible for `componentDidUnload()` to be accurate 100% of the time if it is disconnected, then re-connected, and disconnected again. Instead, `disconnectedCallback()` is the preferred way to always know if a component was disconnected from the DOM.
632
632
633
633
_Note that the runtime still works for any collections that have been built with componentDidUnload(). However, updates to Stencil 2 will require it's changed to disconnectedCallback()._
634
634
635
635
#### Default to `async` task queue
636
636
637
-
-**taskQueue:** set "async" taskQueue as default ([f3bb121](https://github.com/ionic-team/stencil/commit/f3bb121b8130e0c4e0c344eca7078ce572ad34a5))
637
+
-**taskQueue:** set "async" taskQueue as default ([f3bb121](https://github.com/stenciljs/core/commit/f3bb121b8130e0c4e0c344eca7078ce572ad34a5))
638
638
639
639
Update taskQueue default to "async". Stencil 1 default was "congestionAsync". See [config.taskQueue](https://stenciljs.com/docs/config#taskqueue) for more info.
640
640
@@ -679,11 +679,11 @@ If you're using the `dist` output target, update the `package.json` in the root
679
679
680
680
Additionally the `dist/loader` output directory has renamed its extensions too, but since its `dist/loader/package.json` file is auto-generated, the entries were renamed too. So unless you were referencing the loader files directly you will not have to do external updates.
681
681
682
-
See the [Output Folder Structure Defaults](https://github.com/ionic-team/stencil/blob/main/src/compiler/output-targets/readme.md) for more info.
682
+
See the [Output Folder Structure Defaults](https://github.com/stenciljs/core/blob/main/src/compiler/output-targets/readme.md) for more info.
683
683
684
684
#### NodeJS Update
685
685
686
-
-**node:** minimum of Node 12.10.0, recommend 14.5.0 or greater ([55331be](https://github.com/ionic-team/stencil/commit/55331be42f311a6e2a4e4f8ac13c01d28dc31613))
686
+
-**node:** minimum of Node 12.10.0, recommend 14.5.0 or greater ([55331be](https://github.com/stenciljs/core/commit/55331be42f311a6e2a4e4f8ac13c01d28dc31613))
687
687
688
688
With the major release, now's a good time to update the minimum and recommended version of NodeJS.
0 commit comments