Class SharingModal

Manages the sharing modal overlay for selecting queries to share. Displays query history, allows selection, and generates shareable URLs.

Constructors

constructor

new SharingModal(
    container: HTMLElement,
    events?: SharingModalEvents,
    config?: SharingModalConfig,
): SharingModal
Creates a new SharingModal instance.
Parameters
- container: HTMLElement
  The parent HTML element to attach the modal to
- events: SharingModalEvents = {}
  Event handlers for modal interactions
- config: SharingModalConfig = {}
  Configuration options
Returns SharingModal
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:59

Properties

`Private`allQueries

allQueries: string[] = []

`Private`clickHandler

clickHandler: ((e: MouseEvent) => void) | null = null

`Private`config

config: Required<SharingModalConfig>

`Private`container

container: HTMLElement

`Private`displayedCount

displayedCount: number = 0

`Private`displayedQueries

displayedQueries: ShareableQuery[] = []

`Private`events

events: SharingModalEvents

`Private`focusedIndex

focusedIndex: number = -1

`Private`footerContainer

footerContainer: HTMLDivElement | null = null

`Private`keyHandler

keyHandler: ((e: KeyboardEvent) => void) | null = null

`Private`modalContainer

modalContainer: HTMLDivElement | null = null

`Private`overlay

overlay: HTMLDivElement | null = null

`Private`queryListContainer

queryListContainer: HTMLDivElement | null = null

`Private`selectedIndices

selectedIndices: Set<number> = ...

`Private`state

state: SharingModalState = 'hidden'

`Private` `Readonly`TRANSITION_DURATION

TRANSITION_DURATION: 200

Transition duration in milliseconds

Methods

`Private`copyAndClose

copyAndClose(): Promise<void>
Copy shareable link and close modal.

Returns Promise<void>
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:760

`Private`createFooter

createFooter(): HTMLDivElement
Create the modal footer.

Returns HTMLDivElement
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:461

`Private`createHeader

createHeader(): HTMLDivElement
Create the modal header.

Returns HTMLDivElement
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:408

`Private`createOverlay

createOverlay(): void
Create the overlay DOM structure.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:286

`Private`createQueryItem

createQueryItem(queryItem: ShareableQuery, displayIndex: number): HTMLDivElement
Create a query list item element.
Parameters
- queryItem: ShareableQuery
- displayIndex: number
Returns HTMLDivElement
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:585

destroy

destroy(): void
Clean up all resources.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:153

`Private`destroyOverlay

destroyOverlay(): void
Remove overlay from DOM and clean up.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:776

`Private`getCurrentURLLength

getCurrentURLLength(): number
Calculate current URL length for selected queries.

Returns number
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:182

getSelectedQueries

getSelectedQueries(): string[]
Get the currently selected queries in execution order.

Returns string[]
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:161

getState

getState(): SharingModalState
Get current modal state.

Returns SharingModalState
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:72

`Private`hasMoreQueries

hasMoreQueries(): boolean
Check if there are more queries to load.

Returns boolean
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:240

hide

hide(): Promise<void>
Hide the modal with fade-out animation.

Returns Promise<void>
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:130

isVisible

isVisible(): boolean
Check if modal is currently visible or in the process of showing.

Returns boolean
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:79

`Private`loadInitialQueries

loadInitialQueries(): void
Load initial batch of queries.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:199

`Private`loadMoreQueries

loadMoreQueries(): void
Load more older queries.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:219

`Private`moveFocusDown

moveFocusDown(): void
Move focus down (to newer queries). In display order, newer queries are at the bottom (lower display indices).

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:842

`Private`moveFocusUp

moveFocusUp(): void
Move focus up (to older queries). In display order, older queries are at the top (higher display indices). Auto-loads more queries when reaching the top.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:859

`Private`removeClickHandler

removeClickHandler(): void
Remove click handler.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:906

`Private`removeKeyboardHandler

removeKeyboardHandler(): void
Remove keyboard event handler.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:880

`Private`renderQueryList

renderQueryList(): void
Render the query list.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:527

`Private`setupClickHandler

setupClickHandler(): void
Set up click handler to close when clicking outside the modal.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:890

`Private`setupKeyboardHandler

setupKeyboardHandler(): void
Set up keyboard event handler.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:795

show

show(queries: string[]): Promise<void>
Show the modal with the given queries.
Parameters
- queries: string[]
  Array of SQL queries from history (oldest first)
Returns Promise<void>
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:87

`Private`showLimitWarning

showLimitWarning(): void
Show warning when character limit is reached.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:273

`Private`toggleSelection

toggleSelection(displayIndex: number): void
Toggle selection of a query.
Parameters
- displayIndex: number
Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:247

`Private`updateFocusedItem

updateFocusedItem(): void
Update focused item styling.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:738

`Private`updateFooter

updateFooter(): void
Update the footer with current character count.

Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:705

`Private`updateQueryItemUI

updateQueryItemUI(displayIndex: number): void
Update a single query item's UI after selection change.
Parameters
- displayIndex: number
Returns void
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:675

`Private`wouldExceedLimit

wouldExceedLimit(query: string): boolean
Check if adding a query would exceed the limit.
Parameters
- query: string
Returns boolean
- Defined in packages/duckdb-terminal/src/sharing/sharing-modal.ts:190

Class SharingModal

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SharingModal

Properties

PrivateallQueries

PrivateclickHandler

Privateconfig

Privatecontainer

PrivatedisplayedCount

PrivatedisplayedQueries

Privateevents

PrivatefocusedIndex

PrivatefooterContainer

PrivatekeyHandler

PrivatemodalContainer

Privateoverlay

PrivatequeryListContainer

PrivateselectedIndices

Privatestate

Private ReadonlyTRANSITION_DURATION

Methods

PrivatecopyAndClose

Returns Promise<void>

PrivatecreateFooter

Returns HTMLDivElement

PrivatecreateHeader

Returns HTMLDivElement

PrivatecreateOverlay

Returns void

PrivatecreateQueryItem

Parameters

Returns HTMLDivElement

destroy

Returns void

PrivatedestroyOverlay

Returns void

PrivategetCurrentURLLength

Returns number

getSelectedQueries

Returns string[]

getState

Returns SharingModalState

PrivatehasMoreQueries

Returns boolean

hide

Returns Promise<void>

isVisible

Returns boolean

PrivateloadInitialQueries

Returns void

PrivateloadMoreQueries

Returns void

PrivatemoveFocusDown

Returns void

PrivatemoveFocusUp

Returns void

PrivateremoveClickHandler

Returns void

PrivateremoveKeyboardHandler

Returns void

PrivaterenderQueryList

Returns void

PrivatesetupClickHandler

Returns void

PrivatesetupKeyboardHandler

Returns void

show

Parameters

Returns Promise<void>

PrivateshowLimitWarning

Returns void

PrivatetoggleSelection

Parameters

Returns void

`Private`allQueries

`Private`clickHandler

`Private`config

`Private`container

`Private`displayedCount

`Private`displayedQueries

`Private`events

`Private`focusedIndex

`Private`footerContainer

`Private`keyHandler

`Private`modalContainer

`Private`overlay

`Private`queryListContainer

`Private`selectedIndices

`Private`state

`Private` `Readonly`TRANSITION_DURATION

`Private`copyAndClose

`Private`createFooter

`Private`createHeader

`Private`createOverlay

`Private`createQueryItem

`Private`destroyOverlay

`Private`getCurrentURLLength

`Private`hasMoreQueries

`Private`loadInitialQueries

`Private`loadMoreQueries

`Private`moveFocusDown

`Private`moveFocusUp

`Private`removeClickHandler

`Private`removeKeyboardHandler

`Private`renderQueryList

`Private`setupClickHandler

`Private`setupKeyboardHandler

`Private`showLimitWarning

`Private`toggleSelection

`Private`updateFocusedItem

`Private`updateFooter

`Private`updateQueryItemUI

`Private`wouldExceedLimit