Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(custom-elements): add generateTypeDeclarations doc #845

Merged
merged 2 commits into from
Mar 28, 2022
Merged

docs(custom-elements): add generateTypeDeclarations doc #845

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfa1a8e
docs(custom-elements): add generateTypeDeclarations doc
rwaskiewicz Mar 8, 2022
3938f03
reword explanation of needing `dist` output files
rwaskiewicz Mar 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/docs/output-targets/custom-elements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,20 @@ This flag defaults to `false` when omitted from a Stencil configuration file.

> Note: At this time, components created not using JSX may not be automatically defined. This is a known limitation of the API and users should be aware of it

### generateTypeDeclarations

By default, type declaration files (`.d.ts` files) are only generated for the `dist-custom-elements` output target when
the [`dist` output target](/docs/distribution) is also declared in a Stencil project's configuration. This behavior
isn't always desirable, as not all users have need for files emitted by the `dist` output target. To generate type
declaration files for the `dist-custom-elements`, the experimental `generateTypeDeclarations` field can be set to
`true`.

Setting this flag to `true` will generate type declaration files for the `dist-custom-elements` output target. Type
declaration files will be placed in the `dist/types` directory in the root of a Stencil project. At this time, this
output destination is not able to be configured.

This flag defaults to `false` when omitted from a Stencil configuration file.

## Making Assets Available

For performance reasons, the generated bundle does not include [local assets](/docs/local-assets) built within the JavaScript output,
Expand Down