Closed
Conversation
Contributor
Author
|
@claude, review |
This comment was marked as resolved.
This comment was marked as resolved.
kaljarv
force-pushed
the
feat-new-admin-ui
branch
from
a9c28f7 to
f4ae82d
Compare
Apply these principles to all components: 1. Each property is defined in a separate .type.ts file in a type called <ComponentName>Props. 2. That file is the prime source of truth for the properties' descriptions 3. The type is imported to the component as $$Props 4. All props are typed using that. 5. At the top of the file, there is a Svelte doc with `@component` 6. The `### Properties` section is generated from the type file such that `@default` is replaced with 'Default:' and the value is backticked. 7. The element or component onto which $$restProps is passed and which is the base of the props type, is mentioned last as like '- Any valid attributes of a `<figure>` element' 8. Any other prop related headings can be removed along with their contents, unless they contain relevant information missing from the type, in which case add the info to the type 9. If the component doesn't follow this paradigm, create the type file, export it from index.ts and import it to the component Co-Author: Claude
kaljarv
force-pushed
the
feat-docs-site
branch
from
7d65719 to
aa6b06e
Compare
Contributor
Author
|
Superseded by #847 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
WHY:
Contributes to #322
What has been changed
Check off each of the following tasks as they are completed