infra: create api.json files for components missing documentation #3627
Conversation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Co-Authored-By: [email protected] <[email protected]>
…ableOverlay Co-Authored-By: [email protected] <[email protected]>
|
This file has already been removed in commit d623f53 along with other internal components marked with displayName = 'IGNORE'. |
|
Removed the duplicate Picker API file as requested. |
|
The ScrollBar API file has already been removed in commit d623f53 as it was identified as an internal component with displayName = 'IGNORE'. |
|
The SharedTransition API file has already been removed in commit d623f53 as it was identified as an internal component with displayName = 'IGNORE'. The sub-components (Area, Source, Target) are also marked as internal components. |
|
The SvgImage API file has already been removed in commit d623f53 as it was identified as an internal component with displayName = 'IGNORE'. |
|
Removed the duplicate TabController API file as requested. It already exists in the apis directory. |
|
Updated the category to 'incubator' for both PanView and ExpandableOverlay components as requested. |
|
The TabController API file has already been removed in commit 340f445 as it was identified as a duplicate of the file in the apis directory. |
|
Restored the ScrollBar API JSON file with a fixed snippet that includes width styling for the View components. The ScrollBar component itself is not marked as internal, only its Item subcomponent is. |
…te display names Co-Authored-By: [email protected] <[email protected]>
|
Updated the display names and added API JSON files for SharedTransition subcomponents as requested:
|
|
Updated the ScrollBar API JSON file as requested:
|
|
Updated the ScrollBar API JSON snippet to use _.times function as requested instead of Array.fill.map for better readability. |
|
Updated the ScrollBar API JSON category to 'layouts' as requested, using only existing categories. |
There was a problem hiding this comment.
@Inbal-Tish
I wrote over each component the reason we don't want to expose except for two components that we can expose
It makes sense these components didn't have api, they weren't missed
There was a problem hiding this comment.
Everything under src/components/sharedTransition should not be exposed
It's a component I played with long time ago, not ready in any way for production. I would remove the component
| @@ -0,0 +1,63 @@ | |||
| { | |||
There was a problem hiding this comment.
This is also an infra component, we used internally and it serves other components
but IMO we shouldn't expose it because then we'll have to worry about breaking it
| @@ -0,0 +1,56 @@ | |||
| { | |||
There was a problem hiding this comment.
Same as ExpandableOverlay, I remember we didn't want to expose this one
|
Removed API JSON files for SharedTransition subcomponents and reverted display names to 'IGNORE' as requested. |
|
Removed TextArea API JSON file as requested. |
|
Removed ScrollBar API JSON file as requested. |
|
Removed PanView API JSON file as requested. |
|
Removed ExpandableOverlay API JSON file as requested. |
API JSON files for components missing documentation
This PR adds api.json files for components that were missing documentation.
Change Log
Additional Info
Link to Devin run: https://app.devin.ai/sessions/8268f0e2ac4c4ab0bafc144748b55d3a
Requested by: [email protected]