Redocly/redoc

Make redoc RTL support

Open

#1002 opened on Aug 5, 2019

View on GitHub
 (14 comments) (0 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

Description

Issue type: feature

Redoc is one of the best opensource API-docs that I have found. We(baninab.co) need an api-doc in one of our projects. What we need is an api-doc that supports RTL and has a console to test API's, so I decided to talk to @RomanHotsiy and find know how do you think about make this tool RTL support? We are ready to start to develop redoc to make it RTL support and publish it, but I wanted to ask you to know do you have any plan to RTL support of redoc?

Contributor guide

Tech stack
typescriptreactcss
Domain
frontendaccessibility
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
ReactCSSUnderstanding of RTL layout
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate how Redoc currently handles layout direction. Review CSS for hardcoded left/right values and consider using CSS logical properties like padding inline start. Examine the component structure to identify where text and UI elements need RTL mirroring. Check if there are any existing RTL issues or PRs for reference. Test with Arabic or Hebrew sample APIs.