Skip to content

docs: add collapsed prop to RunnableEndpoint documentation #2973

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
fern-support merged 2 commits into from
Jan 6, 2026
+15 −0
Merged

docs: add collapsed prop to RunnableEndpoint documentation #2973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49f0c98
docs: add collapsed prop to RunnableEndpoint documentation
fern-support Jan 5, 2026
5740688
condense changelog entry, minor edits to prop
devalog Jan 6, 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
11 changes: 11 additions & 0 deletions fern/products/docs/pages/changelog/2026-01-05.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Collapsed state for Runnable endpoint component

The `<RunnableEndpoint>` component now supports a `collapsed` prop to control the initial display state. When set to `true`, the form section is hidden until users expand it.

```jsx Markdown
<RunnableEndpoint endpoint="GET /api/plants/{plantId}" collapsed={true} />
```

This is useful for embedding multiple endpoints on a page or reducing visual clutter while maintaining interactive API testing.

Learn more about the [Runnable Endpoint](/learn/docs/writing-content/components/runnable-endpoint) component.
4 changes: 4 additions & 0 deletions .../products/docs/pages/component-library/default-components/runnable-endpoint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ The component supports:
Fields to lock by hiding their dropdown selectors. Accepts `"environment"` to lock the server URL and prevent users from switching environments. When set to `readonly={["environment"]}`, the environment selector is hidden and the endpoint uses the environment specified by `defaultEnvironment` (or the first environment if not specified).
</ParamField>

<ParamField path="collapsed" type="boolean" required={false} default="false">
When set to `true`, the component renders collapsed by default with the form section hidden. Users can expand it by clicking the component.
</ParamField>

<ParamField path="className" type="string" required={false}>
CSS class name for custom styling of the component container.
</ParamField>