Skip to content

add clarification about type exports in SFCs #1483

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 2 commits into from
Feb 4, 2022
Merged

add clarification about type exports in SFCs #1483

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccf3e31
add clarification about type exports in SFCs
theoephraim Feb 3, 2022
7daccd4
Update sfc-script-setup.md
theoephraim Feb 3, 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
19 changes: 18 additions & 1 deletion src/api/sfc-script-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ const attrs = useAttrs()
`<script setup>` can be used alongside normal `<script>`. A normal `<script>` may be needed in cases where you need to:

- Declare options that cannot be expressed in `<script setup>`, for example `inheritAttrs` or custom options enabled via plugins.
- Declaring named exports.
- Declaring named exports (including TypeScript types).
- Run side effects or create objects that should only execute once.

```vue
Expand Down Expand Up @@ -265,6 +265,23 @@ In addition, the awaited expression will be automatically compiled in a format t

## TypeScript-only Features

### Additional type exports

As noted above, in order to export additional types from an SFC, they must be moved to an additional `<script>` block alongside the `<script setup>` block.

For example
```vue
<script lang="ts">
export type SizeOptions = 'small' | 'medium' | 'large';
</script>

<script lang="ts" setup>
defineProps({
size: { type: String as PropType<SizeOptions> },
})
</script>
```

### Type-only props/emit declarations

Props and emits can also be declared using pure-type syntax by passing a literal type argument to `defineProps` or `defineEmits`:
Expand Down