Skip to content

docs: demonstrate how to infer a component's props type #12038

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.

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 1 commit into from
Jun 24, 2024

Conversation

thenbe
Copy link
Contributor

@thenbe thenbe commented Jun 15, 2024

Svelte 5 rewrite

Please note that the Svelte codebase is currently being rewritten for Svelte 5. Changes should target Svelte 5, which lives on the default branch (main).

If your PR concerns Svelte 4 (including updates to svelte.dev.docs), please ensure the base branch is svelte-4 and not main.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Before this PR, there was a simple example to type a variable as the props of some known component.

This PR adds a second example: A generic function that accepts some component and infers the type of its props.

Every now and then I need to create something like this and I always need to look at the source code to recall out how to structure the generic arguments. I figured we should just add an example to the docstring so even users who are not familiar with generics can access it using intellisense.

I also cleaned up the original example a bit.

Copy link

changeset-bot bot commented Jun 15, 2024

⚠️ No Changeset found

Latest commit: 2919de1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@thenbe thenbe force-pushed the doc-prop-type branch 3 times, most recently from f51bd29 to 1c00a25 Compare June 15, 2024 17:12
@Rich-Harris Rich-Harris requested a review from dummdidumm June 21, 2024 21:41
@dummdidumm
Copy link
Member

The example works for me (it's probably not immediately obvious for people how to do this). Can you run pnpm generate:types in packages/svelte to update the final types? Then we're good to merge.

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@dummdidumm dummdidumm merged commit 60d90a9 into sveltejs:main Jun 24, 2024
7 of 9 checks passed
FoHoOV pushed a commit to FoHoOV/svelte that referenced this pull request Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants