Skip to main content

Theme Options

primaryColor (string, hex/rgba value)​

Convenient way to provide the highlighted color used by Redoc.
This value will be used as colors.primary.main in the themes option. Must be an actual color value and not a css variable.

primaryColorDark (string, hex/rgba value)​

Optional way to change the highlighted color used by Redoc in dark mode. Defaults to primaryColor if not set. This value will be used as colors.primary.main in the themes option. Must be an actual color value and not a css variable.

theme (optional, object)​

warning

Deprecated: Use redocly.yaml to specify theme. See example.

Override the redoc theme object passed to Redoc. See the defaults here.

warning

Note: You should not override any color using this property, as it will be the same value for dark and light themes.

options (optional, object)​

warning

Deprecated: Use redocly.yaml to specify theme.options. See example.

Override redoc options passed to RedocStandalone component. See the defaults here.

Available properties here.

You cannot set theme property using this property, use theme option above instead.

Auto loaded from redocly.yaml if present.