Sub components of components can be ordered via options
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
Currently, the configuration of the redoc standalone component is very limited for developers regarding the position/order of the elements. For example, it would be nice to have an option to set the rendering of the Endpoint after the Description in the middle panel. For this reason, it would be nice to have a more flexible configuration for where to render these sub components.
Describe the solution you'd like
A possible solution would be to have the order set in the options of the redoc standalone component (ascending would be enough). For example:
{
position: {
rightPanel: {
order: ['description', 'endpoint']
},
}
}
Describe alternatives you've considered
An alternative would be to have a way to easily modify the component implementation. Making it public and not as a constant. This would make it easier for developers to customize the components (not sure if this is an option without forking the repo or re-implementing from scratch these components and setting them).
Additional context
As a developer, I want to choose where each sub-component is rendered in an easy way (e.g., through the options field of the redoc standalone component).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Redoc standalone component and its options field, then trace how the right-panel sub-components are rendered. Define how an order such as ['description', 'endpoint'] should affect rendering and verify that developers can configure sub-component positions without modifying or reimplementing the components.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100