Skip to content

Commit

Permalink
docs(v3): update the v3 update guide for composition event changes (#930
Browse files Browse the repository at this point in the history
  • Loading branch information
alicewriteswrongs committed Nov 3, 2022
1 parent baba0f1 commit 993dfb6
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion src/docs/introduction/upgrading-to-stencil-three.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,21 @@ Projects that manually create type definitions from `components.d.ts` will eithe
- remove the manually created type (if the types generated in `components.d.ts` suffice)
- update their type creation logic to account for potential naming collisions with the newly generated types

### Composition Event Handlers Renamed

The names of Stencil's composition event handlers have been changed in order to
correct a casing issue which prevented handlers from being called when events
fired. The changes are as follows:

| previous name | new name |
| ---------------------------- | ---------------------------- |
| `onCompositionEnd` | `onCompositionend` |
| `onCompositionEndCapture` | `onCompositionendCapture` |
| `onCompositionStart` | `onCompositionstart` |
| `onCompositionStartCapture` | `onCompositionstartCapture` |
| `onCompositionUpdate` | `onCompositionupdate` |
| `onCompositionUpdateCapture` | `onCompositionupdateCapture` |

## Output Targets

### `dist-custom-elements` Output Target
Expand Down Expand Up @@ -255,4 +270,4 @@ $ npm uninstall @types/puppeteer

Be sure to look at the Stencil [v3.0.0 Breaking Changes Guide](https://github.com/ionic-team/stencil/blob/main/BREAKING_CHANGES.md#stencil-v300).

If you need help upgrading, please post a thread on the [Stencil Forum](https://forum.ionicframework.com/).
If you need help upgrading, please post a thread on the [Stencil Forum](https://forum.ionicframework.com/).

0 comments on commit 993dfb6

Please sign in to comment.