Skip to content

Commit

Permalink
fix(vue): components have correct name in Vue Dev Tools (#27180)
Browse files Browse the repository at this point in the history
<!-- 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://ionicframework.com/docs/building/contributing -->

<!-- Some docs updates need to be made in the `ionic-docs` repo, in a
separate PR. See
https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#modifying-documentation
for details. -->

<!-- Please do not submit updates to dependencies unless it fixes an
issue. -->

<!-- Please try to limit your pull request to one type (bugfix, feature,
etc). Submit multiple pull requests if needed. -->

## What is the current behavior?
<!-- Please describe the current behavior that you are modifying. -->


<!-- Issues are required for both bug fixes and features. -->
Issue URL: resolves #25199

Vue components show up as "Anonymous Component" in Vue Dev Tools. This
is caused by our use of `displayName` instead of `name`. This required a
fix in the Vue Output Target package. See
ionic-team/stencil-ds-output-targets#257 for
more info.

## What is the new behavior?
<!-- Please describe the behavior or changes that are being added by
this PR. -->

- Updates the Vue Output Target dependency
- Functional components created manually in Ionic Vue now set `name`
instead of `displayName`. Note: Non-functional components were never
impacted by this bug.

## Does this introduce a breaking change?

- [ ] Yes
- [x] No

<!-- If this introduces a breaking change, please describe the impact
and migration path for existing applications below. -->


## Other information

<!-- Any other information that is important to this PR such as
screenshots of how the component looks before and after the change. -->


Dev build: `7.0.2-dev.11681308435.141a05de`
  • Loading branch information
liamdebeasi committed Apr 12, 2023
1 parent 6fc0024 commit 07941a5
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 10 deletions.
14 changes: 7 additions & 7 deletions core/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"@stencil/angular-output-target": "^0.6.0",
"@stencil/react-output-target": "^0.5.0",
"@stencil/sass": "^3.0.0",
"@stencil/vue-output-target": "^0.8.1",
"@stencil/vue-output-target": "^0.8.2",
"@types/jest": "^27.5.2",
"@types/node": "^14.6.0",
"@typescript-eslint/eslint-plugin": "^5.17.0",
Expand Down
2 changes: 2 additions & 0 deletions packages/vue/src/components/IonApp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ export const IonApp = /*@__PURE__*/ defineComponent((_, { attrs, slots }) => {
};
});

IonApp.name = "IonApp";

/**
* When rendering user components inside of
* ion-modal, or ion-popover the component
Expand Down
2 changes: 2 additions & 0 deletions packages/vue/src/components/IonBackButton.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,5 @@ export const IonBackButton = /*@__PURE__*/ defineComponent(
};
}
);

IonBackButton.name = "IonBackButton";
2 changes: 2 additions & 0 deletions packages/vue/src/components/IonNav.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ export const IonNav = /*@__PURE__*/ defineComponent(() => {
return h("ion-nav", { delegate }, views.value);
};
});

IonNav.name = "IonNav";
2 changes: 1 addition & 1 deletion packages/vue/src/vue-component-lib/overlays.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export const defineOverlayContainer = <Props extends object>(name: string, defin

const Container = (controller !== undefined) ? createControllerComponent() : createInlineComponent();

Container.displayName = name;
Container.name = name;

Container.props = {
'isOpen': DEFAULT_EMPTY_PROP
Expand Down
2 changes: 1 addition & 1 deletion packages/vue/src/vue-component-lib/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ export const defineContainer = <Props, VModelType = string | number | boolean>(
};
});

Container.displayName = name;
Container.name = name;

Container.props = {
[ROUTER_LINK_VALUE]: DEFAULT_EMPTY_PROP,
Expand Down

0 comments on commit 07941a5

Please sign in to comment.