feat(Overview): onlyOverview - External Compositions and API Reference #7504
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
luvkapur
changed the title
luvkapur
changed the title
GiladShoham
reviewed
Oct 31, 2023
…fix-comp-order # Conflicts: # scopes/compositions/compositions/ui/compositions-panel/compositions-panel.tsx
GiladShoham
approved these changes
Jan 1, 2024
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.
This PR introduces a new
onlyOverviewpreview option, enhancing the Overview section with a dedicated API Reference subsection anduseNameParampreview option.Key Features:
onlyOverviewPreview Option:Enabled via the preview data of a component's environment, this feature is automatically activated for all components tagged with this Bit version onwards.
It refines the Overview screen to render only the main documentation and examples within the iframe, while client-side mounting the Compositions Carousel along with the new API Reference subsection.
The new UI is under a feature flag at the moment.
To apply it you need to set this in your
workspace.jsoncAPI Reference Subsection:
This update replaces the previous properties table, which was limited to displaying props for React components only.
The new API Reference table leverages our internal Schema Extractor (also powering the API Reference tab) to highlight the relevant APIs for your component, utilizing the @exports jsdoc tag.
By default, it presents an API Table of Contents, collating all exported APIs from the component's main file and linking them to their detailed information in the API Reference Tab.
useNameParamPreview Option:Enabled via the preview data of a component's environment, this feature is automatically activated for all components tagged with this Bit version onwards.
It sets the selected composition via name url param to view selected compositions, previously this was set with a combination of two preview options (
includesEnvTemplateanddoesScaling)Compositions Order Bug Fix:
This PR also fixes the bug where the compositions were incorrectly ordered. Now all compositions are ordered according to the order they are defined.
Loading Overview Docs Iframe:
This PR also adds a skeleton loading spinner while the docs iframe loads
fixes #7332