Skip to content

Using ComponentPublicInstance with template refs #2251

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

Merged
merged 3 commits into from
Mar 24, 2023
Merged

Using ComponentPublicInstance with template refs #2251

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fd88ae
Using ComponentPublicInstance with template refs
skirtles-code Feb 25, 2023
633b38a
Merge branch 'main' into component-public-instance
NataliaTepluhina Mar 11, 2023
9769264
Remove .html
skirtles-code Mar 11, 2023
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
9 changes: 9 additions & 0 deletions src/guide/typescript/composition-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,3 +400,12 @@ const openModal = () => {
```

Note if you want to use this technique in TypeScript files instead of Vue SFCs, you need to enable Volar's [Takeover Mode](./overview#volar-takeover-mode).

In cases where the exact type of the component isn't available or isn't important, `ComponentPublicInstance` can be used instead. This will only include properties that are shared by all components, such as `$el`:

```ts
import { ref } from 'vue'
import type { ComponentPublicInstance } from 'vue'

const child = ref<ComponentPublicInstance | null>(null)
```