tuil
ReferenceComponentsWorkflow UI

HelpOverlayProps

HelpOverlayProps component contract.

View rawEdit

Type

export interface HelpOverlayProps {
  readonly id?: string;
  readonly open?: boolean;
  readonly defaultOpen?: boolean;
  readonly onOpenChange?: (open: boolean) => void | Promise<void>;
  readonly hotkey?: string;
  readonly title?: string;
}

Members

MemberTypeRequiredDescriptionRelated types
idstring | undefinedNoThe id member uses the string | undefined contract.
openboolean | undefinedNoThe open member uses the boolean | undefined contract.
defaultOpenboolean | undefinedNoThe defaultOpen member uses the boolean | undefined contract.
onOpenChange((open: boolean) => void | Promise<void>) | undefinedNoThe onOpenChange member uses the ((open: boolean) => void | Promise<void>) | undefined contract.
hotkeystring | undefinedNoThe hotkey member uses the string | undefined contract.
titlestring | undefinedNoThe title member uses the string | undefined contract.

Source

View the secondary source reference

On this page