Skip to content

Commit 523e600

Browse files
devin-ai-integration[bot]fern-supportdevalog
authored
docs: add collapsed prop to RunnableEndpoint documentation (#2973)
Co-authored-by: fern-support <[email protected]> Co-authored-by: Fern Support <[email protected]> Co-authored-by: Devin Logan <[email protected]>
1 parent fee5494 commit 523e600

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Collapsed state for Runnable endpoint component
2+
3+
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.
4+
5+
```jsx Markdown
6+
<RunnableEndpoint endpoint="GET /api/plants/{plantId}" collapsed={true} />
7+
```
8+
9+
This is useful for embedding multiple endpoints on a page or reducing visual clutter while maintaining interactive API testing.
10+
11+
Learn more about the [Runnable Endpoint](/learn/docs/writing-content/components/runnable-endpoint) component.

fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ The component supports:
4242
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).
4343
</ParamField>
4444

45+
<ParamField path="collapsed" type="boolean" required={false} default="false">
46+
When set to `true`, the component renders collapsed by default with the form section hidden. Users can expand it by clicking the component.
47+
</ParamField>
48+
4549
<ParamField path="className" type="string" required={false}>
4650
CSS class name for custom styling of the component container.
4751
</ParamField>

0 commit comments

Comments
 (0)