API Components
Sidebar Code Examples
Display code blocks at the top-right of the page on desktop devices
The <RequestExample>
and <ResponseExample>
stick code blocks to the top-right of a page even as you scroll. The components work on all pages, even if you don’t use an API playground.
<RequestExample>
and <ResponseExample>
show up like regular code blocks on mobile.
Request Example
The <RequestExample>
component works similarly to CodeGroup, but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside <RequestExample>
.
Please set a name on every code block you put inside RequestExample.
Response Example
The <ResponseExample>
component is the same as <RequestExample>
but will show up underneath it.
Was this page helpful?