Add note about TypeScript requiring types for namespaced attributes #954
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
atilafassina
requested changes
Nov 22, 2024
| @@ -19,3 +19,5 @@ This attribute is most useful for Web Components. | |||
| <my-element /> | |||
|
|
|||
| ``` | |||
|
|
|||
| Note: Type definitions are required when using TypeScript. See the [TypeScript](/configuration/typescript#forcing-properties-and-custom-attributes) page for examples. | |||
There was a problem hiding this comment.
You can use the Callout component
<Callout type="info" title="Strong-Typing Custom Properties">...</Callout>| @@ -8,3 +8,5 @@ Forces the prop to be treated as a property instead of an attribute. | |||
| ```tsx | |||
| <div prop:scrollTop={props.scrollPos + "px"} /> | |||
| ``` | |||
|
|
|||
| Note: Type definitions are required when using TypeScript. See the [TypeScript](/configuration/typescript#forcing-properties-and-custom-attributes) page for examples. | |||
There was a problem hiding this comment.
You can use the Callout component
<Callout type="info" title="Strong-Typing Custom Properties">...</Callout>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description(required)
Someone made a note on discord that for example
prop:scrollTopgives a type error, and asked if that was a bug. Related docs page https://docs.solidjs.com/reference/jsx-attributes/propI understood the expectation, given that there is no indication that the typings for such a prop must be provided by the user. I understand we do not want to include types on each page and have a special page for types instead. So I'm including a note on each special namespaced attributes page indicating that the types must be provided and linking to the examples given in the TypeScript page
I'm not that sure about the format of the note as in "Note: text", or could be a callout but maybe It's too much, maybe we can bold the "Note" part?
Related issues & labels