This repository has been archived by the owner on Aug 18, 2023. It is now read-only.
Example: overriding default components #223
Open
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
RomanHotsiy
force-pushed
the
custom-overrides
branch
from
f84a200
to
e322203
Compare
RomanHotsiy
force-pushed
the
custom-overrides
branch
from
e322203
to
d8dfd00
Compare
RomanHotsiy
force-pushed
the
custom-overrides
branch
from
d8dfd00
to
e484421
Compare
This was referenced Jul 7, 2022
RomanHotsiy
changed the title
This was referenced Jul 7, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Overriding Redocly Portal components
This PR has examples of components that can be overridden in Redocly Portal.
To override a component, create a
_overridefolder and put a corresponding override into it. Developer server restart is needed when adding a new component override.Some examples just mirror our default implementations and some adds some modifications. Check out comments inside each example for more details.
List of components
layouts/Markdown.tsx- defines layout for markdown content. Useful when you need to change layout based on current URL (e.g. different layout for/blogpages)layouts/Sidebar.tsx- defines layout for any content with sidebar menu.App.tsx- top-level app wrapper. Useful when you need to add some global providers or global elements.Footer.tsx- footer component.MenuItem.tsx- single sidebar menu item.NavBar.tsx- navbar component.SearchInput.tsx- search input.SearchResults.tsx- search results. Useful for additional filtering/grouping search results.Overriding API reference docs behaviour
See docs here: https://redocly.com/docs/developer-portal/guides/reference-docs-hooks/
Screenshot of the result