Skip to content

adding displayOptions config #323

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

Open
jchesterman wants to merge 3 commits into
base: main
Choose a base branch
from
Open

adding displayOptions config #323

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08332a2
adding displayOptions config
jchesterman Apr 9, 2025
ca5e8db
trigger fresh build
jchesterman Apr 10, 2025
494ef9e
rebuild
jchesterman Apr 10, 2025
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
10 changes: 9 additions & 1 deletion packages/sandbox/src/EmbeddedSandbox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ import packageJSON from '../package.json';
import type { JSONObject } from './helpers/types';

type InitialState = {
/**
* optional. Set initial display options for sandbox
*/
displayOptions?: {
docsPanelState?: 'open' | 'closed'; // default to 'open',
Copy link

@KrenTrox KrenTrox May 5, 2025

Choose a reason for hiding this comment

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

Why not adding the rest?
I think that it would be a good idea https://github.com/apollographql/embeddable-explorer/blob/main/packages/explorer/src/EmbeddedExplorer.ts#L17

};
/**
* optional. Set headers for every operation a user triggers from this Sandbox.
* Users can check and uncheck these headers, but not edit them.
Expand Down Expand Up @@ -139,7 +145,8 @@ export class EmbeddedSandbox {
let element: HTMLElement | null;
const { target, runTelemetry } = this.options;

const { includeCookies, sharedHeaders } = this.options.initialState || {};
const { includeCookies, sharedHeaders, displayOptions } =
this.options.initialState || {};

const queryParams = {
runtime: this.options.runtime,
Expand Down Expand Up @@ -185,6 +192,7 @@ export class EmbeddedSandbox {
shouldDefaultAutoupdateSchema:
this.options.initialState?.pollForSchemaUpdates ?? true,
endpointIsEditable: this.options.endpointIsEditable,
docsPanelState: displayOptions?.docsPanelState ?? 'open',
};

const queryString = Object.entries(queryParams)
Expand Down