-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
feat(docs): Allow sub-components to show reference info for slots and events #2132
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
Conversation
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
…events Allow component's package.json to support an array of objects for the `components` entry of `meta`: ```json { "meta" : { "component": "bComponent", "components" : [ "bSubComponentA", { "component": "bSubComponentB", "events": [ { "event": "foo", "description": "Foo event", "args": [ { "name": "x", "description": "X description" } ] } }, "slots": [ { "name": "bar", "description": "Bar slot" } ] } } } } ```
Codecov Report
@@ Coverage Diff @@
## dev #2132 +/- ##
=========================================
+ Coverage 64.97% 65% +0.02%
=========================================
Files 158 158
Lines 2958 2960 +2
Branches 811 812 +1
=========================================
+ Hits 1922 1924 +2
Misses 749 749
Partials 287 287
Continue to review full report at Codecov.
|
…rray `v-if`/`v-else` test no longer needed since we normalize to array of object form when importing the meta data
handle sub components in new array of objects form
Update meta.components to new format
Allow component package.json to list component aliases
Specify webpack chunk names to match with other README.md imports
89 tasks
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 of PR:
Allow component's
package.json
to support an array of objects for thecomponents
entry ofmeta
, as well as adding any aliases to the component reference:Backwards compatible with existing format.
Includes generation of TOC entries for Component Reference sections
PR checklist:
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
dev
branch, not themaster
branchfixes #xxxx[,#xxxx]
, where "xxxx" is the issue number)If new features/enhancement/fixes are added or changed:
If adding a new feature, or changing the functionality of an existing feature, the PR's description includes:
PR titles should following the Conventional Commits naming convention