developer-portal-starter icon indicating copy to clipboard operation
developer-portal-starter copied to clipboard

Example: overriding default components

Open nalesnichok opened this issue 2 years ago • 0 comments

Overriding Redocly Portal components

This PR has examples of components that can be overridden in Redocly Portal.

To override a component, create a _override folder 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 /blog pages)
  • 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

image

nalesnichok avatar Jul 06 '22 16:07 nalesnichok