Skip to content

docs: add hideTryItButton prop to EndpointRequestSnippet #3453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 6 commits into from
Feb 4, 2026
Merged

docs: add hideTryItButton prop to EndpointRequestSnippet #3453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3e22c5b
docs: add hideTryItButton prop to EndpointRequestSnippet and changelo…
devin-ai-integration[bot] Feb 3, 2026
4749881
Update 2026-02-03.mdx
sbawabe Feb 3, 2026
3c361a2
Update 2026-02-03.mdx
sbawabe Feb 3, 2026
84cbe3b
Apply suggestion from @devalog
sbawabe Feb 3, 2026
0843646
docs: add rendered example and default attribute per PR feedback
devin-ai-integration[bot] Feb 3, 2026
716093c
Merge branch 'devin/1770153540-endpoint-request-snippet-try-it-button…
devin-ai-integration[bot] Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions fern/products/docs/pages/changelog/2026-02-03.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Try It button in EndpointRequestSnippet

The `<EndpointRequestSnippet>` component now includes a Try It button, allowing users to access the endpoint explorer and test API endpoints directly from code snippets.

Learn more about [EndpointRequestSnippet](/learn/docs/writing-content/components/request-snippet).

## Frontmatter availability

Set page availability directly in frontmatter using the `availability` field. This displays an availability badge on the page and overrides any availability defined in the navigation (`docs.yml`).
Expand Down
21 changes: 21 additions & 0 deletions ...ts/docs/pages/component-library/default-components/endpoint-request-snippet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,23 @@ The `payload` option displays the raw JSON request body for POST/PUT/PATCH reque
/>
```

### Hide the Try It button

The `EndpointRequestSnippet` component includes a Try It button by default. Use the `hideTryItButton` prop to hide it.

Copy link
Collaborator

@devalog devalog Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be great to have a rendered example right above the syntax, in the style of the other sections!

Copy link
Contributor

@devin-ai-integration devin-ai-integration bot Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Added the rendered example with highlight-frame wrapper and updated the ParamField with default={false} attribute.

<div className="highlight-frame">
<div className="highlight-frame-content">
<EndpointRequestSnippet endpoint="POST /chat/{domain}" hideTryItButton={true} />
</div>
</div>

```jsx Markdown
<EndpointRequestSnippet
endpoint="POST /chat/{domain}"
hideTryItButton={true}
/>
```

## Properties

<ParamField path="endpoint" type="string" required={true}>
Expand All @@ -128,3 +145,7 @@ The `payload` option displays the raw JSON request body for POST/PUT/PATCH reque
<ParamField path="languages" type="string[]" required={false}>
Specifies which languages to show in the dropdown and in what order. Supported values include `curl`, `python`, `typescript`, `javascript`, `go`, `ruby`, `java`, `kotlin`, `csharp`, `php`, `swift`, `rust`, and `payload`. When not specified, all available languages are shown.
</ParamField>

<ParamField path="hideTryItButton" type="boolean" required={false} default={false}>
When set to `true`, hides the Try It button from the snippet.
</ParamField>