Settings

Settings ghlmanage

The GoHighLevel integration settings screen, switching between a connect pitch and a connected panel with a sync-events accordion and a disconnect danger zone.

Open in Storybook

Available

Ports as-is

Examples

Rendered live from the maintained Storybook story. Lantern stores only the story id and embeds Storybook rather than duplicating the component or its demo.

Settings ghlmanage

Rendered live from Storybook

Open

Storybook must be running for this to load — bun run start:storybook from the monorepo root, or set NEXT_PUBLIC_STORYBOOK_URL to a deployed instance.

Props

The component's public API, read from its TypeScript source. Descriptions come from TSDoc on the prop, so this table cannot drift from the component.

Prop	Type	Default	Description
`onBack`*	`() => void`	—	Leaves the screen.
`appName`	`string`	`"GoHighLevel"`	Integration name in the header.
`appIcon`	`string`	`"🔗"`	Header glyph. A string longer than two characters is treated as an image src (pass a data URI); anything shorter renders as an emoji/monogram.
`connected`	`boolean`	—	Whether the integration is connected. Drives the entire body.
`initialConnected`	`boolean`	`false`	Uncontrolled starting connection state.
`onConnect`	`(apiKey: string) => void`	—	Fired when the connect modal returns a key, and by "Edit key".
`onDisconnect`	`() => void`	—	Fired by "Disconnect" in the kebab menu and in the danger zone.
`maskedApiKey`	`string`	`""`	Already-masked key shown on the connected panel. Never a live secret.
`events`	`GhlSyncEvent[]`	`GHL_SYNC_EVENTS`	Sync events offered. Defaults to `GHL_SYNC_EVENTS`.
`initialEnabledIds`	`string[]`	—	Which event ids are on. Defaults to all of them.
`defaultExpanded`	`boolean`	`false`	Expands the sync-events accordion on mount.
`defaultConnectOpen`	`boolean`	`false`	Opens the connect modal on mount.
`className`	`string`	—	Undocumented — add TSDoc to the prop in the library.

Reference

Transcribed from the component audit. If this disagrees with the source, the source is right.

Source: src/components/settings/SettingsGHLManage.tsx
Portability: Copies across unchanged — only the utils import path moves.
Notes: Use for managing the GoHighLevel connection: the accordion header carries a master switch that both summarizes and toggles all sync events at once, independent of the chevron that expands or collapses the list. It never renders a live API key, only an already-masked string passed in as a prop.